Using the Minecraft Command Console

From CyberWurx Customer Wiki

(Difference between revisions)

Current revision

Minecraft Command Console is a simple way to run basic commands on the console of the game and perform other basic tasks not available to a user with standard FTP access. It is a simple script that runs every minute. This guide is designed to teach you how to utilize this tool to your benefit.

Check out our 1$/slot Minecraft servers

1 Latest Version 0.25.21
2 Configuration
3 Properly Using the Command Console
- 3.1 Command Syntax
4 Available Commands
5 Changelog

[edit] Latest Version 0.25.21

Changelog:

-Minor change to email formatting. Properly wraps command output.
-Minor bugfixes

[edit] Configuration

Minecraft command console is disabled by default. If you would like to use this exciting new feature, you will need to configure it.

Simply open the file: console.cfg

Add your email after email= :

Example

email=myemail@host.com

[edit] Properly Using the Command Console

The script will take each of your commands one by one (line by line) and run them. It is very important to use the proper syntax for commands, or they will not run properly. Once the commands run, the command list will automatically clear itself out.

Refer back to this document for information regarding the command console.

[edit] Command Syntax

We are going to use a string of commands for an example here. I want to use several commands before I turn off my server to make sure it was properly saved. I could also do an emergency backup in case I want to download a quick world file.

To do this, you would simply open the commands.txt file in the root directory ( / ) of ftp. If you do not see a commands.txt, simply create one and upload it (it should be there already). When you have commands.txt open, simply add each command you want to run line by line. Here is an example of an emergency backup and server shutdown (this is useful for updating minecraft).

Here is how you do it:

save-all
emergency-backup
stop

These three commands will be taken and interpreted by the command console script one by one. A report of the commands will be emailed to you.

[edit] Available Commands

For a full list of commands, please visit this http://www.custwiki.cyberwurx.com/index.php/Category:Minecraft_Console_Command_List

This section contains a list of the available Minecraft Console Commands.

Commands are sorted by version-added.
Please note that development commands may be shown here, but not available to your version. (Development commands will be featured here so you can prepare to use them)
If you would like to see your current version, run the "about" command.

[edit] Version 0.25.1

updatebukkit

[edit] Version 0.24

bukkit

[edit] Version 0.2

resetworld restartserver startserver togglemod -- Removed in 0.23.1

[edit] Version 0.19

restoreworld

[edit] Version 0.17

backupconfig -- Revised in 0.23 updatehmod -- Replaced with Update

[edit] Version 0.16

updatescripts -- Removed in 0.18

[edit] Version 0.15

update -- Revised in 0.23

[edit] Version 0.1

[edit] Changelog

View the Minecraft Command Console Changelog for information about new features added.

Retrieved from "http://www.custwiki.cyberwurx.com/index.php/Using_the_Minecraft_Command_Console"

Category: Minecraft

-Minecraft Command Console is a simple way to run basic commands on the console of the game and preform other basic tasks not available to a user with standard FTP access. It is a simple script that runs every minute. This guide is designed to teach you how to utilize this tool to your benefit.
+Minecraft Command Console is a simple way to run basic commands on the console of the game and perform other basic tasks not available to a user with standard FTP access. It is a simple script that runs every minute. This guide is designed to teach you how to utilize this tool to your benefit.
-=Urgent news=
-'''Version 0.2 is almost complete!'''
+[https://secure.cyberwurx.com/signup/v3/?z=html_addons&service_plan_id=9&package_id=46 Check out our 1$/slot Minecraft servers]
+=Latest Version 0.25.21=
+Changelog:
+ -Minor change to email formatting. Properly wraps command output.
+ -Minor bugfixes
 =Configuration=
 These three commands will be taken and interpreted by the command console script one by one. A report of the commands will be emailed to you.
-==Available Commands==
+=Available Commands=
-For a full list of available commands, see [[:Category:Minecraft Console Command List | Minecraft Console Command List]]
+For a full list of commands, please visit this http://www.custwiki.cyberwurx.com/index.php/Category:Minecraft_Console_Command_List
-Development commands may be shown here, but not available to your version. (Development commands will be featured here so you can prepare to use them)
+This section contains a list of the available Minecraft Console Commands.
-If you would like to see your current version, run the "about" command.
+*Commands are sorted by version-added.
-===Script version 0.1===
+*Please note that development commands may be shown here, but not available to your version. (Development commands will be featured here so you can prepare to use them)
- about
+*If you would like to see your current version, run the "about" command.
-*Displays information about the script
- reload
-*This will reload Hey0's mod.
-This is useful for installing new plugins or reloading a whitelist.
- emergency-backup
-*This will run the backup script on demand.
- stop
-*This command will stop the server.
-If you are concerned about hard stopping your server via the game panel, run this first
- save-all
-*This will save the current world file completely.
- save-off
-*This will turn off world saving.
-Make sure you turn it back on if you want to continue saving your world progress!
- save-on
-*This will turn on world saving.
-===Script version 0.15===
+== Version 0.25.1 ==
-Changelog:
+[[Updatebukkit | updatebukkit ]]
- Added new function
- Fixed a few typos
- update
+== Version 0.24 ==
-*Saves, stops, and downloads a new minecraft_server.jar file
+[[Bukkit | bukkit ]]
-This does not automatically restart your server yet. You will have to do this by hand.
-===Script version 0.16===
+== Version 0.2 ==
-Changelog:
+[[Resetworld | resetworld]]
- Added new function '''updatescripts'''
+[[Restartserver | restartserver]]
- Fixed a bug that caused the console.cfg file to reset every minute
+[[Startserver | startserver]]
+[[Togglemod | togglemod ]] -- Removed in 0.23.1
- updatescripts
-*This will update the backend scripts that are used to run the server.
-You can find any major bugfixes on the [[Script Changelog]]
-'''Recent changes to script structure made this command obsolete and it is phased out'''
-===Script version 0.17===
-Changelog:
- Added hey0's mod update command '''updatehmod'''
- Added function to backup hey0 config files '''backupconfig'''
- updatehmod
-*This will download and replace the current Minecraft_Mod.jar file.
-*This will also remove the current minecraft_server.jar file and replace it with a new version (if available)
- backupconfig
-*This will backup your config files for hmod and throw them in a tar file. Your output email will specify which one is available.
-===Script version 0.18===
-Changelog:
- Merged update and updatehmod - These commands did the same thing.
- Removed command updatescripts (see Script version 0.16)
-No new commands available
-===Script version 0.19===
-Changelog:
- Added new function to restore backups
- Added new file: backup-restore.txt
- restoreworld
-*This will restore a world based on a backup location specified in backup-restore.txt
-===Script version 0.2===
-In development 11/17/2010
-Changelog:
- Cleaning up subroutines. If there are any strange anomalies with command console or adverts, please let CW know.
- Adding feature to automatically restart the server in the event of the command console running the stop command.
- Adding feature to reset your world file
+== Version 0.19 ==
+[[Restoreworld | restoreworld ]]
+== Version 0.17 ==
+[[Backupconfig | backupconfig]] -- Revised in 0.23
+[[Updatehmod | updatehmod]] -- Replaced with Update
-==Unstable Version==
+== Version 0.16 ==
-The development functions are available to the script but are considered unstable until a full line of tests are completed.
+[[Updatescripts | updatescripts ]] -- Removed in 0.18
-Please note, unstable functions are to be used at your own risk! Data loss may occur while using these functions!
-===Unstable version 0.2===
+== Version 0.15 ==
-====Available Commands====
+[[Update | update ]] -- Revised in 0.23
-'''restartserver''' - tested under light circumstances. Possibly ready for deployment. Marked as harmless to server operation. There may still be bugs here.
-'''startserver''' - used as a subroutine right now to circumvent '''restartserver'''.
+== Version 0.1 ==
+[[About | about]]
-'''resetworld''' - this will give you a brand new fresh world file.
+[[Emergency-backup | emergency-backup ]]
-'''Available unstable commands tested and working. Implementation of new code will be in place shortly.'''
+[[Reload | reload ]]
-====In development and Not Available====
+[[Save-all | save-all]]
-'''importworld''' - Allows user to import a world file. Replaces current running world. Users have to use world as the world name.
+[[Save-off | save-off]]
+[[Save-on | save-on]]
-====Dev notes====
+[[Stop | stop ]]
-*Fix the startserver command to report back if screen is completely killed off. This will require a restart in the game panel.
-===Future Version Plans===
+= Changelog =
- install-plugin
+View the [[Minecraft Command Console Changelog]] for information about new features added.
-*This will install a plugin for Hey0's mod.
-This will install a plugin from a list. In major development.
 [[Category:Minecraft]]