-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
34 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Super Mario Odyssey: Online Server | ||
|
||
The official server for the [Super Mario Odyssey: Online](https://github.com/CraftyBoss/SuperMarioOdysseyOnline) mod. | ||
|
||
|
||
## Windows Setup | ||
1. Download latest build from [Releases](https://github.com/Sanae6/SmoOnlineServer/releases) | ||
2. Run `SMO.Server.exe` | ||
3. `settings.json` is autogenerated in step 2, modify it however you'd like. | ||
|
||
## Building (Mac/Linux Setup) | ||
|
||
Must have the [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download) and Git installed. | ||
Run these commands in your shell: | ||
```shell | ||
git clone https://github.com/Sanae6/SmoOnlineServer | ||
cd SmoOnlineServer | ||
# replace run with build to only build the server | ||
dotnet run --project Server/Server.csproj -c Release | ||
``` | ||
If you ran `dotnet build` instead of `dotnet run`, you can find the binary at `Server/bin/net6.0/Release/Server.exe` | ||
|
||
|
||
## Commands | ||
|
||
Run `help` to get what commands are available in the server console. | ||
Run the `loadsettings` command in the console to update the settings without restarting. | ||
Server address and port will require a server restart, but everything else should update when you run `loadsettings`. | ||
|
||
[//]: # (TODO: Document all commands, possibly rename them too.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters