diff --git a/game_eggs/yuzu-emu/README.md b/game_eggs/yuzu-emu/README.md index e20faa8f..516501f4 100644 --- a/game_eggs/yuzu-emu/README.md +++ b/game_eggs/yuzu-emu/README.md @@ -1,34 +1,27 @@ # Yuzu Emulator Dedicated Multiplayer Room - -## From their [Github](https://github.com/parkervcp/eggs) +## From their [Github](https://github.com/yuzu-emu/yuzu-mainline) -A link to the site that you download the server files from. +## Description -## [Documentation](https://github.com/parkervcp/eggs/blob/master/README.md) - -A link to relevent documentation for the server. - -The description of the server usually provided by the game/server maker. - +This egg can be used to host dedicated multiplayer rooms for the Yuzu emulator. ## Install notes - -Due to rate limiting the console on the panel, it cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. +Running this server requires almost no resources, but the installation involves compiling the binary. This is needed because yuzu unfortunately does not release their server binaries for Linux. Depending on your configuration, the installation part may take 5 minutes or more. + +To update, simply run the installer again. ## Minimum RAM warning -Minimum required memory to run the server. - +8 MiB is enough, but 16 MiB is recommended ## Minumim Sorage warning -Minimum required storage to run the server. - +1MiB is required, but 50 MiB is recommended to have some spare space for core dumps/logs - +Note: the install part requires ~ 5GiB of free space ## Server Ports @@ -36,11 +29,9 @@ Ports required to run the server in a table format. | Port | default | |---------|---------| -| Game | 25565 | +| Game | 24872 | ### Notes - -25565 is the default port, but any port can be used. - -### Mods/Plugins may require ports to be added to the server +- 24872 is the default port, but any port can be used. +- Banlist is currently not supported. Upon startup, an error will be shown about the missing banlist, but the server will work regardless.