Cool_Tools/GC-local-server-rewrite
1
0
Fork 0
mirror of synced 2024-11-23 22:10:59 +01:00
Code Releases Activity

Update README.md, update default values for release

Browse Source
This commit is contained in:
asesidaa 2023-02-23 02:22:04 +08:00
parent 7c5c2fafb7
commit a6dbf26bdf
4 changed files with 28 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Application/Game/Server/GetDataQuery.cs
View File

@ -17,7 +17,7 @@ public class GetDataQueryHandler : IRequestHandler<GetDataQuery, string>
public Task<string> Handle(GetDataQuery request, CancellationToken cancellationToken)
{
var response = "count=0\n" +
"nexttime=180\n";
"nexttime=180";
if (!eventManagerService.UseEvents())
{
return Task.FromResult(response);

2
MainServer/Configurations/database.json
View File

@ -1,4 +1,4 @@
{
"CardDbName": "card.full.db3",
"CardDbName": "card.db3",
"MusicDbName": "music471omni.db3"
}

2
MainServer/Configurations/events.json
View File

@ -1,6 +1,6 @@
{
"Events": {
"UseEvents": true,
"UseEvents": false,
"EventFiles": [
{
"FileName": "event_103_20201125.evt",

175
README.md
View File

@ -1,8 +1,10 @@
# GC local server
This is a rewritten version of GC local server, original version is [here](https://github.com/asesidaa/gc-local-server).
This is a rewritten version of GC local server, original version is [here](https://github.com/asesidaa/gc-local-server).
Server functionality is basically the same, but the code should be now easier to work with, and can be extended esaily.
**Now migrated to asp .net core**
Server functionality is basically the same, but the code should be now easier to work with, and can be extended easily.
## Usage
@ -19,147 +21,51 @@ If you don't have the modified NesysService.exe, modify the host file, add the f
127.0.0.1 fjm170920zero.nesica.net
```
Open mmc.exe, delete any certificate in `LocalMachine/My` or `LocalMachine/Trusted root` named `Taito Arcade Machine CA` (if present, most likely not)
Open exe with **admin privileges** for certificate generating functionalities to work.
Open game using openparrot loader (you can find that in discord). The loader should be also opened with **admin privileges**, otherwise it will not work.
Open game using openparrot loader (you can find that in guide). The loader should be also opened with **admin privileges**, otherwise it will not work.
## Config
The config file is ~~GC-local-server-rewrite.exe.config~~ config.json
New config is distributed in files located in the `Configurations` folder.
If you are using 4MAX 4.71 data, it should work out of box.
- `database.json`: This file controls which db file to use. `CardDbName` for main card database, `MusicDbName` for music database. Remember to switch music databases for different versions.
If you are using 4MAX 4.65 data, MusicDbName=music4MAX465.db3
- `events.json`: This file controls which event files to use. All the possible event file types are listed.
If you are using 4MAX 4.61 data, first change MusicDbName to bundled music4MAX.db3
`.evt` file is the main event file, `play_mode` controls solo or multiplayer
If you are using 4EX 4.52 data, change MusicDbName to bundled music.db3
`_reg.jpg` is the big event news picture
To unlock new avatars/navgators/skins/sound effects/titles from other version, change the corresponding count in config.
`_sgreg.jpg` is the small event news picture shown in mode selection
You can get the corresponding count in data/boot/*.dat file. It is the first 2 bytes (uint16) encoded in big endian.
`news_big_*.jpg` is the big news picture shown before demo. The first one must have index 0, other ones can have index 2~9
## Event files
`news_small_*.jpg` is the small news picture shown after game over
You can now add solo events. In the config file, change the following section
`telop_*.txt` is the text for the scrolling banner
```
"ResponseData": [
{
"FileName": "/event_103_20201125.evt", // This is the file name of the file to be read
"NotBeforeUnixTime": 1335677127,
"NotAfterUnixTime": 1966397127, // Be sure that NotBeforeUnixTime<= current time <= NotAfterUnixTime
"Md5": "9ef6c4d5ca381583a2d99b626ce06b5e", // File MD5, must match
"Index": 0 // Special value, must be 0 for .evt file, this is the file controlling event
},
{
"FileName": "/event_20201125_reg.jpg",
"NotBeforeUnixTime": 1335677127,
"NotAfterUnixTime": 1966397127,
"Md5": "8e3fe25bf50dcbed13dbb54cc18b1efa",
"Index": 1 // Special value, must be 1 for event_reg.jpg
},
{
"FileName": "/event_20201125_sgreg.png",
"NotBeforeUnixTime": 1335677127,
"NotAfterUnixTime": 1966397127,
"Md5": "e0abb0503fe0c530d8a68e36994264c6",
"Index": 2 // Special value, must be 2 for event_sreg.jpg, this is the event picture in mode selection
},
{
"FileName": "/news_big_20201125_0.jpg",
"NotBeforeUnixTime": 1335677127,
"NotAfterUnixTime": 1966397127,
"Md5": "4a0f66431f6449279dc046149d1dd882",
"Index": 0 // Special value, must be 0 for first news_big.jpg, this is the picture shown before demo
},
{
"FileName": "/news_big_20201125_2.jpg",
"NotBeforeUnixTime": 1335677127,
"NotAfterUnixTime": 1966397127,
"Md5": "8e3fe25bf50dcbed13dbb54cc18b1efa",
"Index": 2 // Special value, can be 2~9 for 2nd to 9th news_big.jpg, so there can be up to 9 of these
},
{
"FileName": "/news_small_20201125_1.jpg",
"NotBeforeUnixTime": 1335677127,
"NotAfterUnixTime": 1966397127,
"Md5": "e20135bcd41c98875aec2b52eb9fcd06",
"Index": 1 // Special value, must be 1 for news_small.jpg, this is shown after game over
},
{
"FileName": "/telop_20201125.txt",
"NotBeforeUnixTime": 1335677127,
"NotAfterUnixTime": 1966397127,
"Md5": "ee228de44d6656a9ec0bb7f1a0ca64e1",
"Index": 0 // Special value, must be 0 for telop, this is the text in scrolling banner
},
{
"FileName": "/event_unlock_20201125.cmp",
"NotBeforeUnixTime": 1335677127,
"NotAfterUnixTime": 1966397127,
"Md5": "623b0f10125cbe19c5394d992930ae8c",
"Index": 8 // Special value, must be 8 for .cmp file
}
]
```
`*.cmp` is the file controlling additional configs, refer to comments
There are several types of data. File name starts with `event` is event config file. Sample
When you want to use event files, put them in `wwwroot/events` folder, then change `UseEvents` to true
```
event_id = 1
title = "Test event"
comment = ""
open_date = (2021, 10, 12)
close_date = (2022, 12, 24)
open_time = (8, 0, 0)
close_time = (23, 59, 0)
ver = "4.65.00"
play_open_time = (0, 0, 0)
play_close_time = (0, 0, 0)
type = 0
challenge_num = 0
play_mode = 1 // 1 is solo, 0 is online so currently not availabe
- `game.json`: This files controls settings for game. You can get the corresponding count for a specified version in `data/boot/*.dat` file. It is the first 2 bytes (uint16) encoded in big endian. Since everything is unlock by default, the `UnlockRewards` is just a demo for future unlock functionality.
select_music_data = (185, 191, 257, 261, 263, 267, 357, 358, 363, 364, 412, 416, 419, 494, 517, 518, 558, 572, 578, 579, 580, 699, 712, 766, 775, 789, 811, 812, 813, 814) // Enabled music
// Reward is not implemented, also everything has already been unlocked
reward0.type = 2
reward0.start = 1
reward0.end = 50
reward0.title = 5159
reward0.avatar = 0
reward0.item = 21
reward0.item_num = 3
reward0.trophy_num = 2
reward0.music = 0
reward0.navigator = 0
```
File name starts with `telop` is the scrolling banner, it's just a plain text file with banner content.
Other files like `option` and `cap` should also be possible, but I have not tested these.
The configured file should be put into the `event` folder, which you can change the position by using jconfig (regedit->event path)
The event files can also be downloaded from the server. Put the event files into `static/wwwroot/event` folder and the game will download the specified event files from the server.
- Other config files do not need to be modified currently
## Missing functions
- [ ] Item/coin consuming
- [ ] Unlocking system (I don't like these two so I just hardcode them, if you are interested you can implement that and add a switch to enable, PRs are welcome)
- [ ] Ranking system (Is this really needed for a local server?)
- [ ] Unlocking system
- [x] ~~Ranking system~~ Initial support for actual ranking
- [ ] Proper update check response (Now it will just throw 404)
- [x] ~~PlayInfo.php (Now it will just throw 404, I don't know what data it expext)~~
- [x] ~~Online matching (and online matching events)~~ Initial support
- [ ] Online matching (and online matching events), would be added in next version
## Difficulty unlocking
This is processed on client side, so if you like to unlock all difficulties, just use Bemani patcher with 4.52 exe (they are compatible).
## Deteled songs
## Deleted songs
If you see a lot of duplicate "Play Merrily" in the original tab, this is because in the songs db deleted songs are added back.
@ -167,11 +73,7 @@ To enable these, try use the omnimixed version of stage_param.dat. That can fix
## Local network
If your game and server is not on the same computer, try modify in config, change `ServerIp` to your server IP.
From server, open mmc.exe, export certificate named "Taito Arcade Machine CA" and "GC local server" with private key and import to game computer.
The cert "Taito Arcade Machine CA" goes into LocalMachine/My and Trusted root, the other only LocalMachine/My.
If your game and server is not on the same computer, import the certificates in `Certificates` folder. `root.pfx` goes into LocalMachine/My and Trusted root, the other only LocalMachine/My.
## Windows XP
@ -183,33 +85,6 @@ The root certificate should have CN=Taito Arcade Machine CA, while the server ce
The most important bit, **choose MD5 or SHA1 as signature algorithm**.
# Web interface
# Web UI
A basic web interface for check scores and set options.
If you want to use the interface besides localhost(127.0.0.1), change in appsettings.json:
```
"BaseUrl": "http://192.168.1.1" // Change to your server ip
```
Notice that due to certificate issues, you need to use http for `BaseUrl` and when accessing the web page, otherwise it will show insecure or fail.
If you really want https all along, make sure you have changed the `ServerIp` and have regenerated the certificate.
# Relay server
Relay server is simple, just run the executable. Default port is 3333, you can change it by provide a command line argument, e.g.
```
./GCRelayServer 12345
```
In main server's config.json, change the following fields to specify the relay server:
```
"RelayServer": "127.0.0.1", // Server IP
"RelayPort": 3333, // Server port
```
Currently the server implementation only allow one matching at a time. Notice that if one matching ends abnormally, you will need to restart the main server.
There's a basic web interface for check scores and set options.