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

added comments to help users who are summiting new eggs

Browse Source 
added documentation example
added minimum storage warning section
added server port notes section
fixed heading levels
added blank lines as needed
This commit is contained in:
LRMtheBoss 2021-12-09 09:37:59 -05:00
parent 8444e5d189
commit 6aec87187b
1 changed files with 34 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
example/README.md
View File

@ -1,20 +1,46 @@
# Example Server Name # Example Server Name
### From their [Github](https://github.com/parkervcp/eggs)
A link to the site that you download game files from.
The description of the server usually provided by the game/server maker.
### Install notes <!--Please remove these comments and irelevent parts for the server egg your adding before summiting a PR request-->
Due to rate limiting the console on the panel 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.
## From their [Github](https://github.com/parkervcp/eggs)
A link to the site that you download the server files from.
## [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-->
## 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.
## Minimum RAM warning
### Minimum RAM warning
Minimum required memory to run the server. Minimum required memory to run the server.
<!--Example: 2GB is recommended. 4GB+ is preferred-->
## Minumim Sorage warning
Minimum required storage to run the server.
<!--Example: 10GB is recommended. 25GB+ is preferred-->
<!--Make a note if the install script would require more then the above amounts-->
## Server Ports
### Server Ports
Ports required to run the server in a table format. Ports required to run the server in a table format.
| Port | default | | Port | default |
|---------|---------| |---------|---------|
| Game | 25565 | | Game | 25565 |
#### Mods/Plugins may require ports to be added to the server. ### 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