Server Command GUI v2.0 SDK

This document describes how to extend Server Command GUI for use with your own servers or mods.


1. File list

  mods/ - The mod files
  config/ - The mod config files, these also serve as examples
  commandlist.xsd - XML Schema for the main command list file
  mod_commandlist.xsd - XML Schema for mod command list files
  README.txt - This file


2. Installation

  a. Download and extract the SDK zip file. (You probably already did this)
  b. Install the mod into your minecraft. Either by copying the mods and config folders or by using the normal installer.
     You dont need MCP, Forge etc. just a working Minecraft installation.


3. Editing main command list

  If you wish to add a command to the normal list simply edit the file 'scg_vanilla.xml' in your favourite text editor.
  The XML Schema is provided and in some editors will give you code completion and verify that the file is valid.

  To add a new command create a new command tag and insert it into the list under the relevant category.
  Each command must have a name and a command, its also recommended to have a help attribute.
    <command name="Kill" help="Kills you and returns you to spawn" command="kill" />
  
  More advanced commands may contain additional tags specifying parameters that can be given to the command.
  The full list of supported tags is: param, text, player, number, item, itemmeta, ip and select.
    <command name="Add" help="" command="time">
      <param>add</param>
      <number min="0" max="24000" label="Time" />
    </command>

  Many tags have attributes to restrict the choice of values the user can enter or change how it is displayed.
  You can find examples of these in the config files or by looking at the xsd.


4. Adding custom command lists

  Instead of editing the existing command list you can add a completely new one. Perhaps you want to remove some
  commands you never use or you want a custom list for the mods you have on a certain server.

  Just create a new file using the same layout as the existing ones and give it a name like 'scg_NEWLIST.xml'.
  In order for SCG to find and load your file it must have a detect command set. See the first line of the file.
  This is a command that exists and can be executed by you on your server. The vanilla file uses 'help' because that
  always exists, you could use something specific to your server version or a mod you have installed.


5. Adding Mod command lists

  Mod command lists are almost identical to the main command list. They use the same format of categories and commands
  but they do not need a detect command.
  Instead they are enabled based on which client mods you have installed by comparing the mod id to the file.
  Mod command lists are normally much smaller than a full list and only contain commands specific to a single mod.
  They are loaded into the main command list under a special Mod category.

  If you make a command list for your mod, modpack, server etc. and you think it would be useful to others. Feel free
  to send it to me so it can be included with SCG.


6. Help

  If you need help just post on the forum or on my site, or even tweet me.
  It may take a while to get back to you but I will.

