add images/links to readme

This commit is contained in:
ppc
2024-08-31 21:59:23 +01:00
parent 1f3a451ad6
commit d22eb13584
3 changed files with 17 additions and 8 deletions
+17 -8
View File
@@ -1,13 +1,19 @@
<div align="center">
# AMNet
[TestFlight](https://testflight.apple.com/join/kHbeJTsQ) • [Website](http://card.ppc.moe) • [Server DLLs](https://gitea.tendokyu.moe/ppc/amnet/releases)
An Aime Card Switcher for segatools-based games.
</div>
## Overview
AMNet is designed to simulate the DEVICE/aime.txt file in a way that allows more than one card to be used across different devices over a LAN.
This was initially designed for use with maimai/Chunithm, where multiple people were going to be using a single machine, but should be compatible with any segatools-based game.
### Setup
1. Download the latest amnet.dll from the releases page
2. Move amnet.dll to the game directory
1. Download the latest `amnet.dll` from the releases page
2. Move `amnet.dll` to the game directory
3. Edit `segatools.ini` to use the new DLL:
```ini
[aimeio]
@@ -24,10 +30,7 @@ gameId=SDEZ
;serverAddress=http://+:6070
```
4. Launch the game, and check the amdaemon console for server startup messages
5. Access the UI via a mobile device on the same network (see below), add a card and start playing!
## Interfaces
There are two interfaces available for AMNet: the web interface and the mobile application.
5. Access the using one of the interfaces (see below), connect to the running server, add a card and start playing!
### Web Interface
The web interface can be accessed by navigating to http://card.ppc.moe/ on a device on the same network as the server.
@@ -35,11 +38,17 @@ This website is also installable as a PWA, which will allow it to be registered
> Because the server can only listen on HTTP, the website needs to be visited over HTTP as well. This may cause issues with some devices, as they may block HTTP requests on HTTPS websites.
[![](./res/web.jpeg)](http://card.ppc.moe)
### Native Application
The AMNet application is available (and fully supported) for iOS devices, and can be downloaded by joining the [TestFlight](https://testflight.apple.com/join/kHbeJTsQ) or built manually.
Android is technically supported, but hasn't been tested and as such APKs aren't provided at this moment.
## Building from Source
<div align="center">
<img src="./res/native.png" height="600"/>
</div>
## 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**.
@@ -81,4 +90,4 @@ npm expo prebuild --platform ios # prebuild the app for iOS, run command then us
If building for iOS, you may need to open the workspace (`./amnet-native/ios/AMNet.xcworkspace`) in Xcode and configure the signing/provisioning settings before builds work as expected.
## License
AMNet is licensed under AGPLv3 or later. See [LICENSE](license.md) for more information.
AMNet is licensed under AGPLv3 or later. See [license.md](license.md) for more information.
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB