Config Setup
Overview
Default Config
After you have added GGGamemodePerms to your server's plugin folder, and have started or reloaded your server, you will see a config.yml file has been generated inside the GGGamemodePerms's Directory.
Inside, you will see the default config like this
##################### # GG Gamemode Perms # # By GusGold # ##################### # Config # ##################### # NOTE: # - Delete this file to regenerate it with default values # - If values are not viable, default will be used # - Delete config when updating GGGamemodePerms.jar Version: X.X checkForUpdates: true # Commands to execute to change the player's group # Use player where the player's name would normally be toSurvivalCmd: myPermissions setGroup:Survival setPlayer:player toCreativeCmd: myPermissions setGroup:Creative setPlayer:player toAdventureCmd: myPermissions setGroup:Adventure setPlayer:player # Set broadcast message when player enters Survival, Creative or Adventure toSurvivalBroadcastEnable: true toSurvivalBroadcast: player has entered Survival mode toCreativeBroadcastEnable: true toCreativeBroadcast: player has entered Creative mode toAdventureBroadcastEnable: true toAdventureBroadcast: player has entered Adventure mode
Setup Permission Commands
To setup the commands for your permissions handler, you need to edit these values
# Commands to execute to change the player's group # Use player where the player's name would normally be toSurvivalCmd: toCreativeCmd: toAdventureCmd:
These are suggested commands that are for some of the more common permissions handlers:
Setting | bPermissions | PermissionsX | Group Manager |
---|---|---|---|
toSurvivalCmd: | exec a:setgroup v:staffSurvival u:player | pex user player group set staffSurvival | manuadd player staffSurvival |
toCreativeCmd: | exec a:setgroup v:staffCreative u:player | pex user player group set staffCreative | manuadd player staffCreative |
toAdventureCmd: | exec a:setgroup v:staffAdventure u:player | pex user player group set staffAdventure | manuadd player staffAdventure |
Note:
- The groups I have set are just place holders for your own groups you intend to use.
- Where you see the keyword "player", the player who has changed gamemodes' name will be substitued in.
- Also note the lack of the preceding forward slash before the command. This is not needed, and if present, will return an "unknown command" response in console
- The player has to have the permission "GGGP.use.switch" in order for their permissions group to change. Otherwise, it will just change their gamemode.
Setup Server Broadcasts
To setup the broadcasts, and to activate/deactive them, edit the following values:
# Set broadcast message when player enters Survival, Creative or Adventure toSurvivalBroadcastEnable: toSurvivalBroadcast: toCreativeBroadcastEnable: toCreativeBroadcast: toAdventureBroadcastEnable: toAdventureBroadcast:
To enable or disable a certain announcement, simply supply either a true or false variable to the "toGamemodeBroadcastEnable:" setting like so:
Setting | Enabled | Disabled |
---|---|---|
toSurvivalBroadcastEnable: | true | false |
toCreativeBroadcastEnable: | true | false |
toAdventureBroadcastEnable: | true | false |
To setup custom broadcasts, supply a message to the "toGamemodeBroadcast" setting, including the keyword "player" and it will broadcast that message replacing "player" with the player switching gamemodes:
Setting | Message | Output (if player "GusGold" switched modes) |
---|---|---|
toSurvivalBroadcast: | player has entered Survival mode | [GGGamemodePerms] GusGold has entered Survival mode |
toCreativeBroadcast: | Creative mode has been selected by player | [GGGamemodePerms] Creative mode has been selected by GusGold |
toAdventureBroadcast: | player is now playing in Adventure mode | [GGGamemodePerms] GusGold is now playing in Adventure mode |
Comments