Bukkit

Things to Remember!

1. There are a number of configs in the SpoutEssentials folder.
   
2. No tabs allowed. Use 4 spaces for different nodes.
   
3. Not all of the config files may be used in your server.
   
4. ] Your music files must be direct link, without https. (http://dl.dropbox.com/u/136953717/SandwichEat09.ogg)
   
   

The Configuration Files!

There are four different configuration files that are currently associated with the SpoutEssentials plugin, all of which contribute their written settings to defining your servers aesthetic taste. Below there is a quick run through explaining what each of the elements in the two most important files.

modules.yml

Purpose: modules.yml let's you turn off/on certain parts of SpoutEssentials. Don't want WorldGuard support? Disable it.
We'll break each line down

EnablePlayerLeaveNotifications: true

Purpose: This controls if you want those notifications at the top-right when someone leaves the game. There are individual permission nodes for that, but this will toggle it globally.

enableWorldGuard: true

Purpose: Self explanatory. If you have WG, and you want to add Spout features to it, enable this. NOTE: If you don't have WG installed, there will be negative side effects!
Defined in: configs.yml

disableOnScreenHelpCompletely: true

Purpose: This determines whether or not the on screen help should even appear at all.

enableAutoUpdate: true

Purpose: This determines whether or not the plugin should update itself.

EnablePlayerJoinNotifications: false

Purpose: Self explanatory. Same as PlayerLeaveNotification, except this one controls player joining event.

forceTexturePack: false

Purpose: If on, it forces a texture pack defined in configs.yml to people who SpoutCraft.

enableBoseEconomySupport: false

Purpose: If you have BOSeconomy, enable this to have some commands that work with it.

enableOnJoinMusic: true

Purpose: Toggles whether or not to have music played when a player joins.

allowSkawkeSupport: true

Purpose: Allows me (skawke) to see debugging information on my plugin when joining your server.

enableModDisguiseSupport: false

Purpose: Enables some stuff to work with Mob Disguise plugin. Turn it off if you don't have it.

enableGroupSkin: false

Purpose: If you want group skins to work, you'll have to define this to true. More information can be found on the Group Skin tutorial page.

enableMusicPlayList: false

Purpose: If you want your players to be able to play predefined music, set to true. More information can be found in the Music Playlist tutorial page.

enableScreenCommands: true

Purpose: If you want to be able to view on screen commands. Press TAB.

enableTownySupport: true

Purpose: If you want to be able to enable Towny support.

enableiConomySupport: false

Purpose: Allow iConomy support to be displayed on the TAB menu.

enableVanishNoPacketSupport: false

Purpose: Blocks notifications shown for vanished players using the VanishNoPacket plugin.

enableSplashScreen: false

Purpose: Enable Splash Screen's for players entering the server.

config.yml

Purpose: Define the majority of SpoutEssentialsOptions here.
Breaking each line down.

NotificationServerMessage: Welcome to my server
NotificationSubMessage: Dodrzujte pravidla

Purpose: Sets the message for a notification to show when a user logs in. The SubMessage sets the bottom part of the notification (grey text).
NOTE: Must NOT be more than 26 characters, including spaces.

pokedNotificationIcon: DIAMOND_ORE

Purpose: Sets the icon for the poke notification, A list of proper items can be found here: http://jd.bukkit.org/apidocs/org/bukkit/Material.html
NOTE: Must be a valid Bukkit Material name, else it'll throw an error.

defaultCloudHeight: 128
defaultMoonSize: 100
defaultSunSize: 100

Purpose: Sets the default sun, and moon size, along with the default cloud height. Must have SpoutCraft for this to work.

loginNotificationIcon: GOLDEN_APPLE
LeaveNotificationIcon: ARROW

Purpose: Sets the icons for leave/join notifications. List of materials may be found here: http://jd.bukkit.org/apidocs/org/bukkit/Material.html

OnScreenHelp:
    line4: 
    line1:
    line3:
    line2: 

Purpose: Sets the text for the on screen help. ONLY 4 lines is available.

texturepack:
    default: LOOK AT THE THREAD FOR MORE INFO. DO NOT CHANGE THIS
    world: THIS IS A TEXTUREPACK URL
    world_nether: TEXTUREPACK URL

Purpose: Sets the texturepack for each world. Worlds with nothing defined won't be counted. Notice the indentation of 4 spaces.

WorldGuardRegions:
    myregionID:
        message: Testing
        icon: APPLE
        subMessage: This is the gray text
        texturepack: texturepackurl
        music: www.music.com/music.ogg
        resetTextureOnPlayerLeave: false

Purpose: Sets the options for a WG region. Notifications must be less than 26 characters.
NOTE: If you don't want an option, say you don't want music playing. Simply remove the 'music' line completely.

WorldGuardRegions:
    myregionID:
        message: Testing
        icon: APPLE
        subMessage: This is the gray text
        texturepack: texturepackurl
        music: www.music.com/music.ogg

Purpose: Sets the options for a WG region. Notifications must be less than 26 characters.

onPlayerJoinMusic: www.music.com/welcome.ogg

Purpose: Sets the music for when a player joins the server. MUST be ogg, wav, or mid.

splashScreenURL: www.google.com/logo.png

Purpose: Sets the splash screen for when a player joins your server. MUST be png.