endernon/FireflySR-goober-edition
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
endernon 2024-05-27 13:08:46 +00:00
parent 8af53cc298
commit 2eae31ac74
1 changed files with 3 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -38,19 +38,9 @@ When you wish to compile, run the `BUILD.bat` I provided in the root folder of F
To begin using the server, you need to run three servers: `sdkserver`, `dispatch` and `gameserver`
If you installed from pre-built binaries, navigate to the directory where you downloaded
the binaries and either a) double-click on the following executable names or b)
run the following in a terminal:
```sh
./gameserver
./dispatch
./sdkserver
```
##### Note: the `assets` folder should be in the same directory with the `gameserver`, otherwise it will not boot up.
## Configuration
## Configuration (ignore this unless you really need to change the mongodb port)
By default, servers will try to use local mongodb (at 127.0.0.1:27017),
this should work out of box if you installed MongoDB on your machine.
<br>
@ -61,7 +51,7 @@ edit sdkserver.json and gameserver.json files.
<a name="connecting"></a>
## Connecting
### For the latest 2.3 Beta patch
### For the latest 2.2.53 Beta patch
If you want to play the latest Beta patch, the `mhypbase.dll` patch for 2.2.51 OS is not usable. You should use a separate proxy like [FireflySR.Tool.Proxy](https://git.xeondev.com/YYHEggEgg/FireflySR.Tool.Proxy) (Prebuilt binary can be downloaded [here](https://git.xeondev.com/YYHEggEgg/FireflySR.Tool.Proxy/releases)).
@ -74,22 +64,8 @@ Clients (2.3 Beta v3):
Notice: **CN Package may not have languages other than Chinese, and vice versa**. Be careful when choosing which to download; luckily they are all compatiable with this server.
### For v1 Players
### For v2.2.51 Players
[Get 2.3 beta client v1(.51)](https://autopatchos.starrails.com/client/Beta/20240501125700_dUBAjS7YiX9nF7mJ/StarRail_2.2.51.zip),
replace [mhypbase.dll](https://git.xeondev.com/reversedrooms/FireflySR/raw/branch/master/mhypbase.dll)
file in your game folder, it will redirect game traffic (and disable in-game censorship)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss
what you would like to change, and why.
## Bug Reports
If you find a bug, please open an issue with as much detail as possible. If you
can, please include steps to reproduce the bug.
Bad issues such as "This doesn't work" will be closed immediately, be _sure_ to
provide exact detailed steps to reproduce your bug. If it's hard to reproduce, try
to explain it and write a reproducer as best as you can.