reversedrooms/FireflySR
3
0
Fork 1
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity

readme update

Browse source
This commit is contained in:
xeon 2024-05-14 13:09:59 +00:00
parent 66ad49dcb2
commit 7b4479b191
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -3,6 +3,10 @@
A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/en-us/) A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/en-us/)
![screenshot](https://git.xeondev.com/reversedrooms/FireflySR/raw/branch/master/screenshot.png) ![screenshot](https://git.xeondev.com/reversedrooms/FireflySR/raw/branch/master/screenshot.png)
## Prerequisites
- [MongoDB](https://www.mongodb.com/try/download/community)
## Installation ## Installation
### From Source ### From Source
@ -10,7 +14,6 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e
#### Requirements #### Requirements
- [Rust](https://www.rust-lang.org/tools/install) - [Rust](https://www.rust-lang.org/tools/install)
- [MongoDB](https://www.mongodb.com/try/download/community)
#### Building #### Building
@ -54,7 +57,7 @@ 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. this should work out of box if you installed MongoDB on your machine.
<br> <br>
You can change this in configuration file of specific server. You can change this in configuration file of specific server.
Currently only 2 servers communicate with database, so if you **need** to configure it, Currently only sdkserver and gameserver communicate with database, so if you **need** to configure it,
edit sdkserver.json and gameserver.json files. edit sdkserver.json and gameserver.json files.
## Connecting ## Connecting