redstrate/kawari
1
Fork 0
mirror of https://github.com/redstrate/Kawari.git synced 2025-05-12 14:47:46 +00:00
Code Activity

Make instructions on where/place Oodle more clear in USAGE

Browse source
This commit is contained in:
Joshua Goins 2025-05-06 15:55:02 -04:00
parent 014fc0beea
commit 6ff67a55e3
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
USAGE.md
View file

@ -11,18 +11,22 @@ Kawari is designed to be easy to run, and should be accessible to anyone who wan
## Prerequisites ## Prerequisites
* Windows or Linux * Windows or Linux
* Copy of the game updated to the supported game version (see README) * Copy of the game updated to the supported game version (see [README](README.md))
* Oodle Network Compression (can be obtained from [here](https://github.com/WorkingRobot/OodleUE)) * Oodle Network Compression (see below)
### Getting Oodle
Get the [latest release from this repository](https://github.com/WorkingRobot/OodleUE/releases/latest). You want the "gcc.zip" for Linux, and "msvc.zip" for Windows.
## Download Artifact ## Download Artifact
Windows and Linux artifacts are built on every commit, under [Github Actions](https://github.com/redstrate/Kawari/actions). You will have to download the Oodle Network `.dll` (Windows) or `.so` (Linux) yourself however. Windows and Linux artifacts are built on every commit, under [Github Actions](https://github.com/redstrate/Kawari/actions). Place the `oodle-network-shared.dll` (Windows) or `oodle-network-shared.so` (Linux) in the same directory as the executables.
## Building ## Building
Build Kawari with `cargo build`. Build Kawari with `cargo build`.
For the World server to function, Kawari needs to be built with `--features oodle`. Place the `.so` (Linux) or `.lib` (Windows) into the `oodle` directory when building. The library must be named "oodle-network-shared". For the World server to function, Kawari needs to be built with `--features oodle`. Place the `oodle-network-shared.dll` (Windows) or `oodle-network-shared.so` (Linux) into the `oodle` directory when building.
## Setup ## Setup