Clean up some docs

pull/1/head
Dom Eori 2021-12-25 23:34:37 +09:00
parent 3d1ec2f9b6
commit 0d98fe8818
2 changed files with 233 additions and 275 deletions

216
CHANGELOG.md 100644
View File

@ -0,0 +1,216 @@
# Changelog
All notable changes to this project will be documented in this file.
## 0.0.25 - 2021-11-30
- **This will do database update**
- [general] Fix MySQL table initialization error
- [maimai2] Add Splash Plus support
## 0.0.24 - 2021-10-19
- **This will do database update**
- [general] Set maintenance reboot date to far future
- [ongeki] Limit maximum activityList entries
- [maimai2] Add userGeneralData table
- [ongeki] Fix wrong references in user tables
- [maimai2] Implement proper player rate saving
- [maimai2] Fix GetGameEvent Handler to return events to game
- [maimai2] Add game events
- [chuni] Remove unnecessary length info in GetGameRankingApi
- [chuni] Add new music and music level data
- [chuni] Use dynamic reboot time instead of fixed one
## 0.0.23 - 2021-10-06
- [aimedb] Add FeliCaLookup2 mode
- [chuni] Add game data: chara, skill, event, music, music level
## 0.0.22c - 2021-09-28
- [maimai2] Fix play saving on first entry session
- [chuni] Add game data: chara, skill, event, music, music level
- [ongeki] Add game data: event, music
## 0.0.22b - 2021-09-15
- [chuni] Add game data: event, music, music level
- [ongeki] Add game data: event, music
## 0.0.22a - 2021-08-30
- [ongeki] Add game data: event, music
## 0.0.22 - 2021-08-30
- **This will do database update**
- [chuni] Implement GetGameRankingApi
- [maimai2] Enable isNetUser and implement UploadUserPhotoApi
- [maimai2] Implement GetGameEventApi and UploadUserPlaylogApi
- [chuni] Add game data: chara, skill, event, music, music level
## 0.0.21 - 2021-08-19
- **This will do database update**
- [general] Update to Spring Boot 2.5
- [maimai2] Experimental Splash Plus Support
## 0.0.20a - 2021-08-17
- [chuni] Add game data: chara, skill, event, music, music level
## 0.0.20 - 2021-08-17
- **This will do database update**
- [chuni] Fix: make event popup to not show
- [ongeki] Add table properties for Red Plus
- [maimai2] Fix play record saving when guest is involved
## 0.0.19e - 2021-08-04
- [chuni] Add game data: chara, skill, event, music, music level
- [ongeki] Add game data: event, music
## 0.0.19d - 2021-07-20
- [chuni] Add game data: chara, skill, event, music, music level
## 0.0.19c - 2021-07-10
- [maimai2] Fix incorrect scope during save UserRating
## 0.0.19b - 2021-07-07
- [chuni] Add game data: event, music, music level
## 0.0.19a - 2021-07-01
- **This will do database update**
- [ongeki] Add game data: card, music, event
- [ongeki] Fix judgement offset saving
## 0.0.19 - 2021-06-28
- **This will do database update**
- [chuni] Add missing data: skill, character, music, music level
- [ongeki] Add missing data: card, character, music, event
- [ongeki] Add proper endpoint for new APIs
- [chuni] Add team name customization feature
- [api] Fix broken chunithm API
## 0.0.18 - 2021-06-25
- [ONGEKI] Add support for ONGEKI Red Plus
## 0.0.17 - 2021-06-19
This was the first forked version release.
- **This will do database update**
- [maimai2] Add support for Maimai DX Splash
- [chuni] Enable standard course and team function
- [chuni] Add support for CHUNITHM Paradise Lost
- [maimai] Add Maimai Finale support
## 0.0.16
- **This will do database update**
- [chuni] Add support for CHUNITHM Amazon Plus
- [chuni] Support auto profile downgrade now.
- [ONGEKI] Fix jewel not being saved (bbs)
- [ONGEKI] Better choKaika method (bbs)
## 0.0.15
- [ONGEKI] Add support for ONGEKI Summer
## 0.0.14
- [general] Reduce connection pool size to 1 to prevent dead lock with sqlite
- [ONGEKI & chuni] Fix score missing again
- [chuni] Read reboot time from database
- [api] Set level to max when chouKaika a card
## 0.0.13
- **This will do database update**
- [ONGEKI & chuni] Fix rating drop
- [aimedb] Allow bind to specific interface
- [API] Allow export and import ongeki and chuni profile. More feature to chuni's api
## 0.0.12
- [ONGEKI] Save UserMissionPoint, UserTrainingRoom, UserGeneralData, GamePoint, GamePresent, GameReward to database
- [ONGEKI] Add custom maintenance time to database
- [ONGEKI] Save the battle point and rating info send by the game to database
- [API] Read database from general table
## 0.0.11a
- [API] Add more ongeki feature
## 0.0.11
- **This will do database update**
- [ONGEKI] Add support to ongeki plus
## 0.0.10
- **This will do database update**
- [DIVA] Add mega39's pv list
- [DIVA] Configurable contest pv limit and reward
- [chuni] Add all old version event
- [chuni] Disable all type 1 event by default
- [chuni] Allow game version overwrite to play the same profile across all version
## 0.0.9
- **This will do database update**
- [API] Fix rating fail to calculate due to lack of music level info
- [API] Move diva music list to database
- [DIVA] Fix continue not work
- [DIVA] Clear status now will count lower clear rank
## 0.0.8
- **This will do database update**
- [chuni] Fix a course table column
- [API] Force unlock diva session
- [API] Get screenshot
## 0.0.7
- **This will do database update**
- [chuni] Add basic support to old release
- [DIVA] Fix wrong name is being sent to the ranking
- [DIVA] Fix exex ranking not being return.
- [DIVA] Fix wrong contest progress is being sent
- [DIVA] Add stage result index to prevent multiple result being sent by client, fix #3
- [aimedb] Prevent same access code being register multiple times
- [allnet] Fix host header
## 0.0.6
- **This will do database update**
- [DIVA] Replace with correct pv list databank
- [DIVA] fix stage_result placeholder to the correct length, level up animation is now working
- [DIVA] Rival support and configurable border.
- [DIVA] Fix ranking being reversed
- [API] Allow edit diva rival and new border type
## 0.0.5
- **This will do database update**
- [aimedb] fix some card number causing overflow
- [chuni] fix unique key constraint , fix #1
- [API] allow input space in aime request
## 0.0.4
- [chuni] Fix user item being overwritten
- [API] Fix record id not being return.
## 0.0.3
- Add database migration tool. If you are running on a old version, I encourage you to delete the old database and generate a new one.

292
README.md
View File

@ -7,30 +7,33 @@ An multipurpose game server power by Spring Boot.
* Project DIVA Arcade Future Tone
* O.N.G.E.K.I. RED PLUS (and below)
### 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 support for few game which I can't test properly. If you couldn't find your wanted game in the above list, do not expect worthwhile support.
### Usage:
Requirements:
* Java 11 or above
* MySQL (Optional)
* Optional: MariaDB or MySQL (<8.0)
Edit `application.properties` , change the `allnet.server.host` to your IP address or hostname.
DIVA won't work with localhost and 127.0.0.1
1. Edit `application.properties` , change the `allnet.server.host` to your IP address or hostname.
Many games won't work with localhost and 127.0.0.1
Then run `java -jar aqua.jar`
2. Run `java -jar aqua.jar` or use the `start.bat` if you are using windows.
or use the `start.bat` if you are using windows.
By default, aqua will use sqlite and save user data in data/db.sqlite.
User data will be save in data/db.sqlite.
If you switch to MySQL, it will auto create the table and import some initial data.
If you want to MySQL (or MariaDB), edit configuration then it will auto create the table and import some initial data.
Please go to the database migration tool's website to check if the Database version is being supported https://flywaydb.org/documentation/database/mariadb
Please go to the database migration tool's website to check if your database version is being supported https://flywaydb.org/documentation/database/mariadb
### Configuration:
Configuration is save in `application.properties`
If you are going to deploy on other machine, you must change the `allnet.server.host` and `allnet.server.port` to the IP or Hostname of the hosting machine.
- If you are going to deploy on other machine, you must change the `allnet.server.host` and `allnet.server.port` to the IP or Hostname of the hosting machine.
This will be send to the game at booting and being used by following request.
And you can switch to MySQL(MariaDB) database by commenting the Sqlite part.
- You can switch to MySQL (or MariaDB) database by commenting the Sqlite part.
#### Game specific setting:
@ -39,273 +42,12 @@ And you can switch to MySQL(MariaDB) database by commenting the Sqlite part.
- You can enable team function and customize team name by changing `game.chunithm.team-name` value. Leave this blank to disable team function.
### Other Information:
This server provide a simple API for changing some DIVA's setting.
And DIVA screenshot will be save in data folder.
### Changelog:
v0.0.25: **[This will do database update]**
[generic] Fix MySQL table initialization error
[maimai2] Add Splash Plus support
v0.0.24: **[This will do database update]**
[general] Set maintenance reboot date to far future
[ongeki] Limit maximum activityList entries
[maimai2] Add userGeneralData table
[ongeki] Fix wrong references in user tables
[maimai2] Implement proper player rate saving
[maimai2] Fix GetGameEvent Handler to return events to game
[maimai2] Add game events
[chuni] Remove unnecessary length info in GetGameRankingApi
[chuni] Add new music and music level data
[chuni] Use dynamic reboot time instead of fixed one
v0.0.23:
[aimedb] Add FeliCaLookup2 mode
[chuni] Add game data: chara, skill, event, music, music level
v0.0.22c:
[maimai2] Fix play saving on first entry session
[chuni] Add game data: chara, skill, event, music, music level
[ongeki] Add game data: event, music
v0.0.22b:
[chuni] Add game data: event, music, music level
[ongeki] Add game data: event, music
v0.0.22a:
[ongeki] Add game data: event, music
v0.0.22: **[This will do database update]**
[chuni] Implement GetGameRankingApi
[maimai2] Enable isNetUser and implement UploadUserPhotoApi
[maimai2] Implement GetGameEventApi and UploadUserPlaylogApi
[chuni] Add game data: chara, skill, event, music, music level
v0.0.21: **[This will do database update]**
Update to Spring Boot 2.5
[maimai2] Experimental Splash Plus Support
v0.0.20a:
[chuni] Add game data: chara, skill, event, music, music level
v0.0.20: **[This will do database update]**
[chuni] Fix: make event popup to not show
[ongeki] Add table properties for Red Plus
[maimai2] Fix play record saving when guest is involved
v0.0.19e:
[chuni] Add game data: chara, skill, event, music, music level
[ongeki] Add game data: event, music
v0.0.19d:
[chuni] Add game data: chara, skill, event, music, music level
v0.0.19c:
[maimai2] Fix incorrect scope during save UserRating
v0.0.19b:
[chuni] Add game data: event, music, music level
v0.0.19a: **[This will do database update]**
[ongeki] Add game data: card, music, event
[ongeki] Fix judgement offset saving
v0.0.19: **[This will do database update]**
[chuni] Add missing data: skill, character, music, music level
[ongeki] Add missing data: card, character, music, event
[ongeki] Add proper endpoint for new APIs
[chuni] Add team name customization feature
[api] Fix broken chunithm API
v0.0.18:
[ONGEKI] Add support for ONGEKI Red Plus
v0.0.17: **[This will do database update]**
[maimai2] Add support for Maimai DX Splash
[chuni] Enable standard course and team function
[chuni] Add support for CHUNITHM Paradise Lost
[maimai] Add Maimai Finale support
v0.0.16: **[This will do database update]**
[chuni] Add support for CHUNITHM Amazon Plus
[chuni] Support auto profile downgrade now.
[ONGEKI] Fix jewel not being saved (bbs)
[ONGEKI] Better choKaika method (bbs)
v0.0.15:
[ONGEKI] Add support for ONGEKI Summer
v0.0.14:
[general] Reduce connection pool size to 1 to prevent dead lock with sqlite
[ONGEKI & chuni] Fix score missing again
[chuni] Read reboot time from database
[api] Set level to max when chouKaika a card
v0.0.13: **[This will do database update]**
[ONGEKI & chuni] Fix rating drop
[aimedb] Allow bind to specific interface
[API] Allow export and import ongeki and chuni profile. More feature to chuni's api
v0.0.12:
[ONGEKI] Save UserMissionPoint, UserTrainingRoom, UserGeneralData, GamePoint, GamePresent, GameReward to database
[ONGEKI] Add custom maintenance time to database
[ONGEKI] Save the battle point and rating info send by the game to database
[API] Read database from general table
v0.0.11a:
[API] Add more ongeki feature
v0.0.11: **[This will do database update]**
[ONGEKI] Add support to ongeki plus
v0.0.10: **[This will do database update]**
[DIVA] Add mega39's pv list
[DIVA] Configurable contest pv limit and reward
[chuni] Add all old version event
[chuni] Disable all type 1 event by default
[chuni] Allow game version overwrite to play the same profile across all version
v0.0.9: **[This will do database update]**
[API] Fix rating fail to calculate due to lack of music level info
[API] Move diva music list to database
[DIVA] Fix continue not work
[DIVA] Clear status now will count lower clear rank
v0.0.8: **[This will do database update]**
[chuni] Fix a course table column
[API] Force unlock diva session
[API] Get screenshot
v0.0.7: **[This will do database update]**
[chuni] Add basic support to old release
[DIVA] Fix wrong name is being sent to the ranking
[DIVA] Fix exex ranking not being return.
[DIVA] Fix wrong contest progress is being sent
[DIVA] Add stage result index to prevent multiple result being sent by client, fix #3
[aimedb] Prevent same access code being register multiple times
[allnet] Fix host header
v0.0.6: **[This will do database update]**
[DIVA] Replace with correct pv list databank
[DIVA] fix stage_result placeholder to the correct length, level up animation is now working
[DIVA] Rival support and configurable border.
[DIVA] Fix ranking being reversed
[API] Allow edit diva rival and new border type
v0.0.5: **[This will do database update]**
[aimedb] fix some card number causing overflow
[chuni] fix unique key constraint , fix #1
[API] allow input space in aime request
v0.0.4:
[chuni] Fix user item being overwritten
[API] Fix record id not being return.
v0.0.3:
Add database migration tool. If you are running on a old version, I encourage you to delete the old database and generate a new one.
- This server provide a simple API for view play information and edit settings for some games.
- DIVA and Maimai DX screenshot will be save in data folder.
### Credit:
* **samnyan**
* **Akasaka Ryuunosuke** : providing all the DIVA protocol information
* Dom Eori : from v0.0.17 and up
* All devs who contribute to the MiniMe server
* All contributors by merge request, issues and other channels..