pelican-eggs/minecraft
1
0
Fork 0
mirror of https://github.com/pelican-eggs/minecraft.git synced 2024-11-22 19:02:40 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Bas van den Boom 2023-02-19 12:45:37 +01:00 committed by GitHub
parent 55eac93fed
commit 7d7a15dc2d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
game_eggs/yuzu-emu/README.md
View File

@ -1,34 +1,27 @@
# Yuzu Emulator Dedicated Multiplayer Room
<!--Please remove these comments and irelevent parts for the server egg your adding before summiting a PR request-->
## 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.
<!--Example: Parkers Pterodactyl Eggs Repo. Server eggs for the Pterodactyl management panel-->
This egg can be used to host dedicated multiplayer rooms for the Yuzu emulator.
## Install notes
<!--Make a note if the user needs to get any keys or other items to run/use the server-->
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.
<!--Example: 2GB is recommended. 4GB+ is preferred-->
8 MiB is enough, but 16 MiB is recommended
## Minumim Sorage warning
Minimum required storage to run the server.
<!--Example: 10GB is recommended. 25GB+ is preferred-->
1MiB is required, but 50 MiB is recommended to have some spare space for core dumps/logs
<!--Make a note if the install script would require more then the above amounts-->
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
<!--Notes about the server ports.-->
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.