From 750905ea9e850d1210c16b5bd8078e9b2b3c8539 Mon Sep 17 00:00:00 2001 From: endernon Date: Mon, 27 May 2024 13:03:45 +0000 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 96ec796..9979532 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e - Run "start_all.bat" - Allow admin permission for all three tabs that should open - Now, scroll down to [Connecting](https://git.endernon.com/endernon/FireflySR-goober-edition#connecting) - +On later occasions, if you want to run the server again, run "start_all.bat" again. @@ -21,23 +21,21 @@ A Server emulator for the game [`Honkai: Star Rail`](https://hsr.hoyoverse.com/e First, get these prerequesites: - [Rust](https://www.rust-lang.org/tools/install) - [MongoDB](https://www.mongodb.com/try/download/community-edition) +- [Git](https://git-scm.com/download/win) - [Protobuf Compiler (protoc)](https://github.com/protocolbuffers/protobuf/releases/download/v26.1/protoc-26.1-win64.zip) (ONLY IF YOU ARE USING MICROSOFT WINDOWS). You should manually extract it to somewhere and add `bin` subfolder to the system environment variable `PATH`. Look online for how to add a folder to "path" +Then, open file explorer and create a new folder somewhere. Make sure it's empty. Then, at the file path thing at the top of file explorer, click it, delete the text, replace with "cmd" and click enter. +Now, you should have Command Prompt running. Inside this window, run +``` +git clone https://git.endernon.com/endernon/FireflySR-goober-edition ./FireflySR +``` +Now, Git will start cloning the repo locally. Once it's done, open the newly created "FireflySR" folder. You now have a local copy of the code. #### Building +Now, make your changes to the code. +When you wish to compile, run the `BUILD.bat` I provided in the root folder of FireflySR. You will need to run the script again every time you make a change to the code and want to run your changes. -##### To run it with automatic recompilation when any Rust files are changed - -```sh -cargo xtask watch -``` - -### From Pre-built Binaries - -Navigate to the [Releases](https://git.xeondev.com/reversedrooms/FireflySR/releases) -page and download the latest release for your platform. - ## Usage To begin using the server, you need to run three servers: `sdkserver`, `dispatch` and `gameserver`