From bac8dc6a3e592cadc413c618dd11c774592301d4 Mon Sep 17 00:00:00 2001 From: neobenedict <16228871+neobenedict@users.noreply.github.com> Date: Sat, 25 Mar 2023 23:59:15 +0000 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d5a13a8..d4e4eda 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,20 @@ Custom server for serving localized assets for Magia Record to be used in conjunction with https://github.com/rayshift/magiatranslate. -## Build Instructions +### Build Instructions Windows: `dotnet publish -c Release KamihamaWeb` Linux: `dotnet publish -r linux-x64 -c Release KamihamaWeb` -## Config options +### Config options - `Proxy`: Leave empty or specify a HTTP proxy - `MaxThreads`: Specify to client how many concurrent downloads can take place (higher number = more server load) - `Version`: Minimum client version in client's `Config.h` to connect to this server (or an error will be shown to the user) - `Type`: `master` or `replica` server (see load balancing) -### Load balancing +#### Load balancing If you use Cloudflare and have the CF-IPCountry header set with a GeoIP country code you can load balance by specifying alternate endpoints, where the correct endpoint will be sent to the user on login: ``` "MagiRecoNodes": { @@ -25,7 +25,7 @@ If you use Cloudflare and have the CF-IPCountry header set with a GeoIP country ``` If the country code isn't found in the config file, the default (`*`) will be used. -## Usage +### Usage - Edit the configuration file appsettings(.Development).json using the example given in appsettings.Example.json - Create a directory `MagiaRecoStatic/` in the binaries' working directory. - Clone https://git.rayshift.io/kamihama/magia-assets.git or your own assets into this directory `git clone URL`. @@ -60,5 +60,5 @@ cd /home/rayshift/KamihamaWeb cd MagiRecoStatic/ && git pull --rebase origin master && cd .. && rm en_cache.json && sudo systemctl restart kestrel-kamihama-prod.service ``` -## Contributing +### Contributing Contributions are strongly encouraged as this server implementation will not receive further updates by its creator. Please create a pull request with your changes.