Bukkit

Customizing Simply Modular

Options

Simply Modular allows for a vast array of options on how to run the plugin. Currently, here are all of the Global Options (located conveniently in the config.yml file):

On Enable

disableOnFatalError: Disables the plugin if it fails to start cleanly. Not yet implemented

verboseBootup: If set to false, will make the bootup sequence silent. Otherwise, it will display feedback information about the bootup sequence.

highlyVerbose: if set to true, shows far more debug information about the bootup sequence.

On Disable

verboseShutdown: if set to false, will make the shutdown sequence silent. otherwise, it will display feedback information about the shutdown sequence.

highlyVerbose: if set to true, shows far more debug information about the shutdown sequence.

Debug

globalDebug: Acts as a true/false killswitch for module debug. Should be set to false on production servers

exceptionLogging: Logs exceptions into the debug folder. Should be set to true. Not currently implemented

cleanupOnBoot: Clears the debug folder of logged exceptions when the server boots up. Not currently implemented.

shutdownOnFatalException: This will shut down the entire server if the plugin experiences a fatal exception that it was not expecting. This really should only be set to true if the server is equipped to handle complete shutdowns, I.E. is set to automatically reboot upon shutdown. Not yet implemented

Choosing Modules

Currently, there are only two modules that are created (and even those are not 100% complete at this point). However, in order to enable a module, you must add an entry into the enabledModules node. Currently, you can add the following:

SimplePermissions - Permissions module
SimpleChestProtect - Chest protection module

Further Customization

Customizing A Command

Customizing a command in Simply Modular is a snap! All you need to do is add a new a new entry into the config.yml's commandOptions array. By default, it looks like this:

commandOptions: {}

But lets say you wanted to edit the /protect command, for the chest protection system. You want to change the name of the command to /lock. Lets say you also want to change the details so it also reflects the command name change. It would look like this!

commandOptions:
  protect:
    name: lock
    desc: Allows a user to lock a chest, so that others cannot get into it!
    use: /lock

Here is a list of different things that you can do you change the settings for each command:

commandOptions:
  <command>: ##command to edit settings for
    name: <name override>
    aliases:
    - <additional alias 1>
    - <additional alias 2>
    - -<alias to remove>
    permission: <permission override>
    permissionMessage: <permission message override>
    desc: <description override>
    use: <usage override>
    logUsage: true/false ##force logging of command on or off

Customizing Plugin Feedback

Nearly every single message that Simply Modular sends as feedback to the player can be customized. Firstly, the default color can be set; the default for Simply Modular is currently set to AQUA. Lets say you changed the /protect command to /lock, but now you want to change the default feedback for typing /lock now. The default is "Registering block protection. Please punch a block to protect it." Maybe you think its a bit boring, and could use some spicing up, and maybe a bit of dark purple! Firstly, you'd open up the strings.yml file found next to the config.yml, and you'd edit the protectActivate entry. To edit colors, you'll need to add &X, where X is the color code for the target color you'd like to use. For instance, you might do this:

protectActivate: '&5Block Lock activated! PUNCH a block, to LOCK it! \m/ >_< \m/'

If you're looking to just highlight a specific word and want to always default to the default color, you can do something like this:

denyNoPermission: '&cYou <&>cannot perform &cthis <&>command!'

What the <&> does is default to the default color. This allows you to revert back to the default color, no matter what it is set to, without having to go and edit all of the strings, you can just change the default color, if you want!

Lastly, there are parameters. Sometimes we absolutely have to have specific information in feedback, and this allows you to keep it! For instance, lets take the protection success string:

protectSuccess: 'Success! Protecting %2 at %1.'

%2 is always replaced with the block type, while %1 is the coordinates of the block being protected. In order to use this, you'd do something like this:

protectSuccess: 'You have now protected the %2 which is located at the coordinates %1.'

If you protected a chest at coordinates 0,0,0, this would come out to be

You have now protected the CHEST which is located at the coordinates 0,0,0.

Or, the default would be

Success! Protecting CHEST at 0,0,0.

Lastly, if any of the strings are missing, or if you want to go back to the default feedback, you can always delete the specific entry; the plugin will repair and default the strings when it boots up!