Show Menu
Cheatography

MineOS Cheat Sheet Cheat Sheet (DRAFT) by

A reference guide to using MineOS command line script mineos_console.py

This is a draft cheat sheet. It is a work in progress and is not finished yet.

mineos­_co­nso­le.py parameters

cmd
the command to execute
-s
the server to act upon
-d
the base of the mc file structure
--this
auto populates -d and -s
argv
additional arguments to pass
./mine­os_­con­sole.py -d /var/g­ame­s/m­ine­craft -s [myserver] [start]
./mine­os_­con­sole.py --this [start]

mineos­_co­nso­le.py commands

console
send text to the game console
screen
alias to 'console'
[command]
command to execute on server
[property]
return value of property
"-s " means command will execute on specified server.
./mine­os_­con­sole.py -s [serve­rname] [comma­nd/­pro­perty]

no "­-s" means command will iterate on all servers
./mine­os_­con­sole.py [comma­nd/­pro­perty]

Available Commands

start
starts a server
kill
force kills a server
commit
send 'save-all' to console
stop
send 'stop' command to console
archive
creates timest­amped, gzipped tarball
backup
creates an rdiff-­backup increm­ental snapshot
restore [step]
restores a downed server to a previous increm­ental backup
prune [step]
removes old rdiff-­backup data and metadata
delete­_server
deletes archive, backup, and live server data
 

Available Properties

up
true if the server is running
profile
profile the server is assigned
server­_ve­rsion
minecraft version, e.g., 1.7.9
java_pid
process id of java instance
screen_pid
process id of screen instance
port
port server is assigned
ip_address
ip_address server is assigned
memory
MB used by java (VmRSS)
ping
returns server info (motd, online players, capacity)
sp
server.pr­ope­rties
sc
server.config
server­_type
type of server suite, e.g., bukkit­/forge
ping_debug
show debugging info for web-ui problems

Debugging Properties

comman­d_start
returns cmd used to start up minecraft
comman­d_debug
returns comman­d_start without using screen
comman­d_a­rchive
returns cmd to archive a server
comman­d_b­ackup
returns cmd to create rdiff-­backup increment
comman­d_kill
returns cmd to kill a java instance
comman­d_r­estore [step] [--force]
returns cmd to restore from an rdiff-­backup increment
comman­d_prune
returns cmd to remove oldest increm­ental backups
comman­d_l­ist­_in­cre­ments
returns cmd to list available increments
comman­d_d­ele­te_­server
returns cmd to remove specific server files