mirror of
https://github.com/parkervcp/eggs.git
synced 2024-11-11 11:37:29 +08:00
added comments to help users who are summiting new eggs
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:
parent
8444e5d189
commit
6aec87187b
@ -1,20 +1,46 @@
|
||||
# Example Server Name
|
||||
### From their [Github](https://github.com/parkervcp/eggs)
|
||||
A link to the site that you download game files from.
|
||||
|
||||
<!--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)
|
||||
|
||||
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
|
||||
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.
|
||||
## 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.
|
||||
<!--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.
|
||||
|
||||
| Port | default |
|
||||
|---------|---------|
|
||||
| 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
|
||||
|
Loading…
Reference in New Issue
Block a user