lzc256
/
AquaDX
mirror of https://github.com/hykilpikonna/AquaDX
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

[F] Fix typos in readme

pull/11/head
Azalea 2024-02-16 20:49:44 -08:00 committed by GitHub
parent 6d4a38404c
commit a47ed71799
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,6 +1,6 @@
# AquaDX
Multipurpose game server powered by Spring Boot, for ALL.Net based games
Multipurpose game server powered by Spring Boot, for ALL.Net-based games
This is an attempt to rebuild the [original Aqua server](https://dev.s-ul.net/NeumPhis/aqua)
@ -26,9 +26,9 @@ Check out these docs for more information.
* [Frequently asked questions](docs/frequently_asked_questions.md)
### Notes
* Some game may require additional patches and these will not provided in this project and repository. You already found this, so you know where to find related resources too.
* This repository may contain untested, experimental implementation for few games which I can't test properly. If you couldn't find your wanted game in the above list, do not expect support.
* This server also provides a simple API for viewing play records and edit settings for some games.
* Some games may require additional patches and these will not provided in this project and repository. You already found this, so you know where to find related resources too.
* This repository may contain untested, experimental implementations for a few games which I can't test properly. If you couldn't find your wanted game in the above list, do not expect support.
* This server also provides a simple API for viewing play records and editing settings for some games.
### Usage
@ -37,28 +37,28 @@ Check out these docs for more information.
3. Extract the zip file to a folder.
4. Run `java -jar aqua.jar` in the folder.
By default, Aqua will use sqlite and save user data in data/db.sqlite.
By default, Aqua will use SQLite and save user data in `data/db.sqlite`.
If you want to use optional databases, edit configuration file then it will auto create the table and import some initial data.
If you want to use optional databases, please edit the configuration file then it will auto-create the table and import some initial data.
### Configuration
Configuration is saved in `config/application.properties`, spring loads this file automatically.
* The host and port of game title servers can be overritten in `allnet.server.host` and `allnet.server.port`. By default it will send the same host and port the client used the request this information.
This will be sent to the game at booting and being used by following request.
* You can switch to MariaDB (or MySQL) database by commenting the Sqlite part.
* For some game, you might need to change some game specific config entries.
* The host and port of game title servers can be overwritten in `allnet.server.host` and `allnet.server.port`. By default it will send the same host and port the client used the request this information.
This will be sent to the game at booting and being used by the following request.
* You can switch to the MariaDB (or MySQL) database by commenting the Sqlite part.
* For some games, you might need to change some game-specific config entries.
### Building
You need to install JDK on your system. However, you don't need to care about Gradle, as wrapper script is included.
You need to install JDK on your system. However, you don't need to install Gradle separately, as the `gradlew` wrapper script is included.
```
gradlew clean build
```
The `build/libs` folder will contain an jar file.
The `build/libs` folder will contain a jar file.
### 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
* **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 request, issues and other channels
* All contributors by merge requests, issues and other channels