From 041050dba83778a4dbbc6d79f9dd4f677ae0c9fd Mon Sep 17 00:00:00 2001 From: ppc Date: Fri, 9 Jan 2026 21:10:58 +0000 Subject: [PATCH] update readme --- readme.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/readme.md b/readme.md index f68f7cd..1a2b6c5 100644 --- a/readme.md +++ b/readme.md @@ -24,12 +24,12 @@ This was originally intended for use with maimai and CHUNITHM, but should be com ; AMNet-specific options (all optional) ; gameId - the 4 character game ID (will show the game icon in the UI) ; serverName - the name of the server to show to users (defaults to the computer name if not set) - ; serverAddress - the address to listen on, including the protocol (defaults to http://+:6070, where + is a wildcard) + ; serverAddress - the address to listen on, including the protocol (don't set/change unless you know what you're doing) ; enableKeyboardMode - whether to enable hold-enter-to-login mode. Reads the file set at aimePath for card number (or DEVICE/aime.txt if not set). ; useAimeDBForPhysicalCards - Whether physical cards should use AiMeDB to retrieve access codes. If the game is using a hosted network, set this to 1 to load the same account data/profile as you would get on a physical cab. gameId=SDEZ ;serverName=CHUNI-PENGUIN - ;serverAddress=http://+:6070 + ;serverAddress=http://0.0.0.0:6070 ;enableKeyboardMode=1 ;useAimeDBForPhysicalCards=1 ``` @@ -37,7 +37,7 @@ This was originally intended for use with maimai and CHUNITHM, but should be com 5. Access the using one of the interfaces (see below), add a new server `http://:6070`, import your existing card (or create a new one) and start playing! ### Physical Cards -AMNet 1.3 adds support for scanning physical cards on iOS devices. If you own a physical AiMe/Banapass/e-Amusement/Suica card, you can scan it using the app and use it in-game. +AMNet 1.3 adds support for scanning physical cards on iOS devices. If you own a physical Aime/Banapass/NESiCA/e-Amusement card, you can scan it using the app and use it in-game. By changing the `useAimeDBForPhysicalCards` in segatools.ini, you can choose how the card is read on a per-game basis: - `0` will send the 20-digit access code on the back of the card to the game and load the save data directly (default option). @@ -61,7 +61,7 @@ AMNet can be used on most platforms, see below for options available for each pl iOS TestFlight - Aime/Banapass/e-Amusement/Suica IC cards supported + Aime/Banapass/NESiCA/e-Amusement IC cards supported Android @@ -85,18 +85,17 @@ AMNet can be used on most platforms, see below for options available for each pl ## Building -### Server (AMNet.Server) -Building the server from source requires the following dependencies: -Visual Studio 2022 (or Build Tools) with **Desktop Development with C++** and **.NET Desktop Development** workloads, including **MSVC x64/x86** compiler and a recent **Windows 10/11 SDK**. +### Server (amnet-server and amnet-server-test) +Building the server from source requires a recent version of **Rust** in +addition to an **MSVC compiler** and (probably) a recent **Windows 10/11 SDK**. -After cloning the repository, the server can be built by publishing the project. -Building the server without publish mode will result in a DLL that cannot be run by the game. +After cloning the repository, the server can be built using cargo, specifying a target if an x86 version is desired. ```shell -dotnet publish -c Release -r win-x64 -p:Version=1.0.0 AMNet.Server/AMNet.Server.csproj -``` +cargo build --release -The dll will be available at `.\AMNet.Server\bin\Release\net9.0-windows\win-x64\publish\amnet.dll`. +# find the .dll at target/release/amnet.dll +``` ### Website (amnet-web) The web interface is built using Vite and React. Building the web interface requires Node.js (or alternative runtime).