AquaDX/README.md

<!--
NOTE: We discovered that there have been a trend of people abusing AI to sell open-sourced
software on various Chinese platforms such as CSDN or JueJin.

This is a free and open-source server. If you paid for it, you have been scammed.
The official source code is available at https://github.com/MewoLab/AquaDX.

Additionally, we would like to remind you that all commercial use of this software including
selling it on any platform is strictly prohibited as per the CC By-NC-SA license.


注意：我们发现有一些人滥用 AI 生成文案在中国的一些平台上（如 CSDN 或 掘金）销售开源软件。

这是一个免费且开源的服务器。如果您付费购买了这个软件，说明您被骗了。
官方源代码可以在以下地址获取：https://github.com/MewoLab/AquaDX。

另外，我们想提醒您，根据 CC By-NC-SA 许可证，此软件禁止一切商业用途，
包括在任何平台上出卖此软件。
--->

# AquaDX

Multipurpose game server for ALL.Net games.

### Related Projects

* [AquaMai](https://github.com/MewoLab/AquaMai): A maimai DX mod that adds many features to the game.
* [AquaNet](./AquaNet): A new web frontend for the modern age.

### Supported Games

Below is a list of games supported by this server. 

| Game                   | Ver  | Codename            | Thanks to                                  |
|------------------------|------|---------------------|--------------------------------------------|
| SDHD: CHUNITHM         | 2.30 | VERSE¹              | [@rinsama](https://github.com/mxihan)      |
| SDEZ: MaiMai DX        | 1.50 | PRiSM               | [@肥宅虾哥](https://github.com/FeiZhaixiage)   |
| SDGA: MaiMai DX (Intl) | 1.50 | PRiSM               | [@Clansty](https://github.com/clansty)     |
| SDED: Card Maker       | 1.39 |                     | [@Becods](https://github.com/Becods)       |
| SDDT: O.N.G.E.K.I.     | 1.45 | bright MEMORY Act.3 | [@Gamer2097](https://github.com/Gamer2097) |
| SBZV: Project DIVA     | 7.10 | Future Tone         |                                            |
| SDFE: Wacca (*ALPHA)   | 3.07 | Reverse             |                                            |

* ¹: For VERSE, normal gameplay works, but events and new features might be missing. Luminous+ and older are fully supported.

Check out these docs for more information.
* [Game specific notes](docs/game_specific_notes.md)
* [Frequently asked questions](docs/frequently_asked_questions.md)

> [!TIP]  
> Some games may require additional patches and these will not be provided in this project and repository. You already found this, so you know where to find related resources too.

## Usage
If you own a cab or controller and just want to play the game, follow the instructions below:

1. Make sure you have obtained game files on your own (we will not provide them).
2. Go to [aquadx.net](https://aquadx.net) and make an account.
3. Click on "Setup Connection" in the home page, and follow the instructions.
4. Play a coin with your card.  
   (Either a physical card or the `aime.txt` / `felica.txt` in your segatools)
5. Pet your cat 🐱
6. Link your card on the website. 

If you encounter any issue, please report in the [issue tracker](https://MewoLab/AquaDX/issues).

> [!TIP]  
> If you don't know your card ID, there's always a button on the login screen of the game that can read a card's access code.

## Self Hosting (Advanced)

Please read the [self-hosting guide](docs/self-hosting.md) if you want to host your own server. This is only for advanced users and developers. Do not ask for support if you are not familiar with programming or networking.

## License: [CC By-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en)

* **Attribution** — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
* **NonCommercial** — You may not use the material for commercial purposes.
* **ShareAlike** — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

### Credit
* **samnyan**: The creator and developer of the original Aqua server
* **Akasaka Ryuunosuke**: providing all the DIVA protocol information
* **Dom Eori**: Developer of forked Aqua server, from v0.0.17 and up
* All devs who contribute to the [MiniMe server](https://dev.s-ul.net/djhackers/minime)
* All contributors by merge requests, issues and other channels