Skip to content

Commit d135966

Browse files
committed
README updates
1 parent 4cf5b3c commit d135966

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,22 @@ A basic startup script for minecraft-server
33

44
## Assumptions
55

6-
* You already have minecraft-server installed in `/usr/local/minecraft-server`
6+
* You already have minecraft-server installed in `WORKDIR` (default: `/usr/local/minecraft-server`)
77

88
## Installation
99

1010
1. Simply drop the [`minecraft-server`](minecraft-server) file into `/etc/init.d`
11-
2. Adjust the `-Xms` and `-Xmx` in the `start()` function to match your system's capabilities
11+
2. Adjust the following variables at the top of the file to match your system's capabilities:
12+
1. `WORKDIR` - path where minecraft-server is installed
13+
2. `MIN_MEMORY_ALLOCATION` - Initial memory allocation pool for JVM
14+
3. `MAX_MEMORY_ALLOCATION` - Maximum memory allocation pool for JVM
15+
16+
## Usage
17+
18+
* Start Minecraft Server: `service minecraft-server start`
19+
* Stop Minecraft Server: `service minecraft-server stop`
20+
* Restart Minecraft Server: `service minecraft-server restart`
21+
* Get Minecraft Server Status: `service minecraft-server status`
1222

1323
## Notes
1424

0 commit comments

Comments
 (0)