mirror of
https://github.com/taoneill/war.git
synced 2024-11-13 05:54:31 +01:00
Updated plugin.yml documentation.
Prettified the /warcfg, /zonecfg, /teamcfg and other usage outputs. Removed duplication by using command aliases. Grouped War, warzone and team settings together for more clarity. /setteam and /setteamflag now have pretty colors.
This commit is contained in:
taoneill
parent
1b1c74ed26
commit
afa82ce13f
@ -867,10 +867,24 @@ public class War extends JavaPlugin {
|
||||
* @return String Message with colored teams
|
||||
*/
|
||||
private String colorKnownTokens(String str, ChatColor msgColor) {
|
||||
str = str.replaceAll("Ex -", ChatColor.BLUE + "Ex -" + ChatColor.GRAY);
|
||||
str = str.replaceAll("\\\\", ChatColor.BLUE + "\\\\" + ChatColor.GRAY);
|
||||
str = str.replaceAll("->", ChatColor.LIGHT_PURPLE + "->" + ChatColor.GRAY);
|
||||
str = str.replaceAll("/teamcfg", ChatColor.AQUA + "/teamcfg" + ChatColor.GRAY);
|
||||
str = str.replaceAll("Team defaults", ChatColor.AQUA + "Team defaults" + ChatColor.GRAY);
|
||||
str = str.replaceAll("Team config", ChatColor.AQUA + "Team config" + ChatColor.GRAY);
|
||||
str = str.replaceAll("/zonecfg", ChatColor.DARK_AQUA + "/zonecfg" + ChatColor.GRAY);
|
||||
str = str.replaceAll("Warzone defaults", ChatColor.DARK_AQUA + "Warzone defaults" + ChatColor.GRAY);
|
||||
str = str.replaceAll("Warzone config", ChatColor.DARK_AQUA + "Warzone config" + ChatColor.GRAY);
|
||||
str = str.replaceAll("/warcfg", ChatColor.DARK_GREEN + "/warcfg" + ChatColor.GRAY);
|
||||
str = str.replaceAll("War config", ChatColor.DARK_GREEN + "War config" + ChatColor.GRAY);
|
||||
str = str.replaceAll("Print config", ChatColor.WHITE + "Print config" + ChatColor.GREEN);
|
||||
|
||||
for (TeamKind kind : TeamKind.values()) {
|
||||
str = str.replaceAll(" " + kind.toString(), " " + kind.getColor() + kind.toString() + msgColor);
|
||||
str = str.replaceAll(kind.toString() + "/", kind.getColor() + kind.toString() + ChatColor.GRAY + "/");
|
||||
}
|
||||
str = str.replaceAll("Ex -", ChatColor.GRAY + "Ex -");
|
||||
|
||||
return str;
|
||||
}
|
||||
|
||||
|
||||
@ -92,45 +92,35 @@ commands:
|
||||
Ex - /nextbattle [zone-name]
|
||||
# Warzone creation commands
|
||||
setzone:
|
||||
description: War> Use to create a warzone. Lobby is created and blocks are saved when the second corner is set. You can only edit zones you create or those listing you as author (add authors with /zonecfg author:yourname).
|
||||
usage: Use to create a warzone. Lobby is created and blocks are saved when the second corner is set. You can only edit zones you create or those listing you as author (add authors with /zonecfg author:yourname). Warzones must be at least 10 blocks wide in all directions.
|
||||
Ex -
|
||||
==Wand Cuboid mode==>
|
||||
description: War> Use to create a warzone. Lobby is created and blocks are saved when the second corner is set. You can only edit zones you create or those listing you as author (add authors with /setzoneconfig author:yourname).
|
||||
usage: Use to create a warzone. Lobby is created and blocks are saved when the second corner is set. You can only edit zones you create or those listing you as author (add authors with /setzoneconfig author:yourname). Warzones must be at least 10 blocks wide in all directions.
|
||||
\\\\ Wand Cuboid mode \\
|
||||
1) /setzone <zone-name> to get wooden sword,
|
||||
2) Left-click to select or move corner1,
|
||||
3) Right-click to select or move corner2.
|
||||
Turn off wand by dropping the wooden sword.
|
||||
==Wandless Cuboid mode==>
|
||||
\\\\ Wandless Cuboid mode \\
|
||||
/setzone <zone-name> <corner1/corner2/c1/c2/pos1/pos2>
|
||||
savezone:
|
||||
description: War> Persists changes made to the warzone since the last save. Config can be set with named parameters.
|
||||
usage: Persists changes made to the warzone since the last save. Config can be set with named parameters. Provide a zone name if not standing in warzone or lobby.
|
||||
Ex -
|
||||
/savezone [zone-name] => Basic save - name optional if standing inside,
|
||||
/savezone [zone-name] lifepool:8 teamsize:5 maxscore:7 autoassign:on ff:on blockheads:on spawnstyle:<big/flat/small/invisible> unbreakable:on nocreatures:on disabled:on monumentheal:<0-20>
|
||||
flagreturn:<both/spawn/flag> flagpointsonly:false glasswalls:on pvpinzone:true instabreak:false nodrops:false nohunger:false saturation:<0-20> minplayers:1 minteams:1
|
||||
/savezone [zone-name] loadout:default => sets the respawn inventory to your current items,
|
||||
/savezone [zone-name] loadout:<extra-loadout-name> => adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn
|
||||
/savezone [zone-name] deleteloadout:<extra-loadout-name> => removed the specified loadout from the choices. You cannot remove the default loadout.
|
||||
/savezone [zone-name] reward:default => sets the winner's reward to your current items.
|
||||
/savezone [zone-name] author:tommytony,someguy => adds these players as authors of the warzone, allowing them to edit it.
|
||||
/savezone [zone-name] deleteauthor:tommytony,someguy => removes these players from the warzone authors.
|
||||
/savezone [zone-name] warhubmaterial:<floor/outline/gate/light> => while holding block, changes look for different parts of warhub.
|
||||
/savezone [zone-name] -> Basic save - name optional if standing inside. \\
|
||||
/savezone [zone-name] lifepool:8 teamsize:5 ... -> set warzone configuration options as you save. See /warcfg and /zonecfg for details.
|
||||
setzonelobby:
|
||||
description: War> Creates or changes the position of the warzone lobby.
|
||||
usage: Creates or changes the position of the warzone lobby.
|
||||
Ex -
|
||||
==Attached lobby==>
|
||||
\\\\ Attached lobby \\
|
||||
Must be standing in warzone or lobby.
|
||||
/setzonelobby <north/east/south/west/n/e/s/w>
|
||||
==Detached lobby==>
|
||||
\\\\ Detached lobby \\
|
||||
Must be standing outside warzone or lobby.
|
||||
/setzonelobby <zone-name>
|
||||
setteam:
|
||||
description: War> Creates or moves a team spawn. The lobby is updated.
|
||||
usage: Creates or moves a team spawn. The lobby is updated. Must be standing in warzone.
|
||||
Ex -
|
||||
/setteam <diamond/iron/gold/white/orange/magenta/blue/green/pink/gray/purple/navy/brown/darkgreen/red/black>
|
||||
/setteam <diamond/iron/gold/white/orange/magenta/blue/green/pink/gray/purple/navy/brown/darkgreen/red/black/>
|
||||
setmonument:
|
||||
description: War> Creates or moves a monument. Monuments can be capture with wool from your team and give your health.
|
||||
usage: Creates or moves a monument. Monuments can be capture with wool from your team and give your health. Must be standing in warzone.
|
||||
@ -140,7 +130,7 @@ commands:
|
||||
description: War> Creates/moves a team flag post for CTF.
|
||||
usage: Creates/moves a team flag post for CTF. Must be standing in warzone.
|
||||
Ex -
|
||||
/setteamflag <team-color>
|
||||
/setteamflag <diamond/iron/gold/white/orange/magenta/blue/green/pink/gray/purple/navy/brown/darkgreen/red/black/>
|
||||
setbomb:
|
||||
description: War> Creates or moves a bomb. Get the bomb to the other team's spawn. People from other teams can blow you up.
|
||||
usage: Creates or moves a bomb. Get the bomb to the other team's spawn. People from other teams can blow you up. Must be standing in warzone.
|
||||
@ -191,54 +181,45 @@ commands:
|
||||
usage: Deletes the cake. Provide a zone name if not standing in warzone or lobby.
|
||||
Ex -
|
||||
/deletecake [zone-name] <cake-name>
|
||||
setzoneconfig:
|
||||
description: War> Use named parameters to change the configuration of the warzone. Resets blocks like /nextbattle. Does not save zone blocks like /savezone.
|
||||
usage: Use named parameters to change the configuration of the warzone. Resets blocks like /nextbattle. Does not save zone blocks like /savezone. Provide a zone name if not standing in warzone or lobby.
|
||||
Ex -
|
||||
/setzoneconfig [zone-name] lifepool:8 teamsize:5 maxscore:7 autoassign:on ff:on blockheads:on spawnstyle:<big/flat/small/invisible> unbreakable:on nocreatures:on disabled:on monumentheal:<0-20>
|
||||
flagreturn:<both/spawn/flag> flagpointsonly:false glasswalls:on pvpinzone:true instabreak:false nodrops:false nohunger:false saturation:<0-20> minplayers:1 minteams:1
|
||||
/setzoneconfig [zone-name] loadout:default => sets the respawn inventory to your current items,
|
||||
/setzoneconfig [zone-name] loadout:<extra-loadout-name> => adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn
|
||||
/setzoneconfig [zone-name] deleteloadout:<extra-loadout-name> => removed the specified loadout from the choices. You cannot remove the default loadout.
|
||||
/setzoneconfig [zone-name] reward:default => sets the winner's reward to your current items.
|
||||
/setzoneconfig [zone-name] author:tommytony,someguy => adds these players as authors of the warzone, allowing them to edit it.
|
||||
/setzoneconfig [zone-name] deleteauthor:tommytony,someguy => removes these players from the warzone authors.
|
||||
/setzoneconfig [zone-name] material:<main/stand/light> => while holding block, changes look for structures like flag stands and monuments.
|
||||
/setzoneconfig [zone-name] lobbymaterial:<floor/outline/gate/light> => while holding block, changes look for different parts of lobby.
|
||||
zonecfg:
|
||||
description: War> Alias for /setzoneconfig
|
||||
usage: Use named parameters to change the configuration of the warzone and default team settings. Resets blocks like /nextbattle. Does not save zone blocks like /savezone. Provide a zone name if not standing in warzone or lobby.
|
||||
Ex -
|
||||
/zonecfg [zone-name] lifepool:8 teamsize:5 maxscore:7 autoassign:on ff:on blockheads:on spawnstyle:<big/flat/small/invisible> unbreakable:on nocreatures:on disabled:on monumentheal:<0-20>
|
||||
flagreturn:<both/spawn/flag> flagpointsonly:false glasswalls:on pvpinzone:true instabreak:false nodrops:false nohunger:false saturation:<0-20> minplayers:1 minteams:1
|
||||
/zonecfg [zone-name] loadout:default => sets the respawn inventory to your current items,
|
||||
/zonecfg [zone-name] loadout:<extra-loadout-name> => adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn
|
||||
/zonecfg [zone-name] deleteloadout:<extra-loadout-name> => removed the specified loadout from the choices. You cannot remove the default loadout.
|
||||
/zonecfg [zone-name] reward:default => sets the winner's reward to your current items.
|
||||
/zonecfg [zone-name] author:tommytony,someguy => adds these players as authors of the warzone, allowing them to edit it.
|
||||
/zonecfg [zone-name] deleteauthor:tommytony,someguy => removes these players from the warzone authors.
|
||||
/zonecfg [zone-name] material:<main/stand/light> => while holding block, changes look for structures like flag stands and monuments.
|
||||
/zonecfg [zone-name] lobbymaterial:<floor/outline/gate/light> => while holding block, changes look for different parts of lobby.
|
||||
setteamconfig:
|
||||
description: War> Use named parameters to change team-specific settings. Resets warzone blocks like /nextbattle. Does not save zone blocks like /savezone.
|
||||
usage: Use named parameters to change the configuration of the warzone. Resets blocks like /nextbattle. Does not save zone blocks like /savezone. Provide a zone name if not standing in warzone or lobby.
|
||||
Ex -
|
||||
/setteamconfig [zone-name] <team-name> lifepool:8 teamsize:5 maxscore:7 autoassign:on ff:on blockheads:on spawnstyle:<big/flat/small/invisible>
|
||||
flagreturn:<both/spawn/flag> flagpointsonly:false nohunger:false saturation:<0-20>
|
||||
/setteamconfig [zone-name] <team-name> loadout:default => sets the respawn inventory to your current items,
|
||||
/setteamconfig [zone-name] <team-name> loadout:<extra-loadout-name> => adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn
|
||||
/setteamconfig [zone-name] <team-name> deleteloadout:<extra-loadout-name> => removed the specified loadout from the choices. You cannot remove the default loadout.
|
||||
/setteamconfig [zone-name] <team-name> reward:default => sets the winner's reward to your current items.
|
||||
description: War> Use named parameters to change the configuration of the warzone. May require a /resetzone.
|
||||
usage: Use named parameters to change the configuration of the warzone and default team settings. May require a /resetzone. Provide a zone name if not standing in warzone or lobby.
|
||||
\\\\ Warzone config \\
|
||||
/zonecfg [zone-name] disabled:off -> prevents players from joining. \\
|
||||
/zonecfg [zone-name] autoassign:off blockheads:on deathmessages:on friendlyfire:off glasswalls:on instabreak:off
|
||||
minteams:1 minplayers:1 monumentheal:5 nocreatures:off nodrops:off pvpinzone:on realdeaths:off
|
||||
resetonempty:off resetonconfigchange:off resetonload:off resetonunload:off unbreakable:off \\
|
||||
/zonecfg lobbymaterial:<floor/outline/gate/light> -> while holding block, change the look of the lobby (use air block to keep original floor). \\
|
||||
/zonecfg material:<main/stand/light> -> while holding block, change the look of the monument, flag, cake and bomb.
|
||||
\\\\ Team defaults \\
|
||||
/zonecfg [zone-name] lifepool:7 -> each death consumes a life from the team's pool, an empty lifepool end the battle and gives a point to the other teams. \\
|
||||
/zonecfg maxscore:10 -> once a team reaches this value, the game is ended. \\
|
||||
/zonecfg teamsize:10 flagmustbehome:on flagpointsonly:off flagreturn:<both/flag/spawn> nohunger:off respawntimer:0 saturation:10 spawnstyle:<small/flat/big/invisible> \\
|
||||
/zonecfg loadout:default -> sets the default respawn inventory to your current items. \\
|
||||
/zonecfg loadout:<extra-loadout-name> -> adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn. \\
|
||||
/zonecfg deleteloadout:<extra-loadout-name> -> removes the specified loadout from the choices. \\
|
||||
/zonecfg playerloadoutasdefault:true -> the player can bring a copy of his outside-world inventory to fight, it replaces the default loadout. \\
|
||||
/zonecfg reward:default -> sets the winner's reward to your current items.
|
||||
\\\\ Print config \\
|
||||
/zonecfg [zone-name] -print (or /zonecfg -p) -> prints out the current warzone settings. \\
|
||||
aliases:
|
||||
- setzoneconfig
|
||||
teamcfg:
|
||||
description: War> Alias for /setteamconfig
|
||||
usage: Use named parameters to change the team-specific settings. Resets warzone blocks like /nextbattle. Does not save zone blocks like /savezone. Provide a zone name if not standing in warzone or lobby.
|
||||
Ex -
|
||||
/teamcfg [zone-name] <team-name> lifepool:8 teamsize:5 maxscore:7 spawnstyle:<big/flat/small/invisible> unbreakable:on nocreatures:on disabled:on monumentheal:<0-20>
|
||||
flagreturn:<both/spawn/flag> flagpointsonly:false nohunger:false saturation:<0-20>
|
||||
/teamcfg [zone-name] <team-name> loadout:default => sets the respawn inventory to your current items,
|
||||
/teamcfg [zone-name] <team-name> loadout:<extra-loadout-name> => adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn
|
||||
/teamcfg [zone-name] <team-name> deleteloadout:<extra-loadout-name> => removed the specified loadout from the choices. You cannot remove the default loadout.
|
||||
/teamcfg [zone-name] <team-name> reward:default => sets the winner's reward to your current items.
|
||||
description: War> Use named parameters to change team-specific settings. May require a /resetzone.
|
||||
usage: Use named parameters to change the team-specific settings. May require a /resetzone. Provide a zone name if not standing in warzone or lobby.
|
||||
\\\\ Team config \\
|
||||
/teamcfg [zone-name] <team-name> lifepool:7 -> each death consumes a life from the team's pool, an empty lifepool end the battle and gives a point to the other teams. \\
|
||||
/teamcfg <team-name> maxscore:10 -> once a team reaches this value, the game is ended. \\
|
||||
/teamcfg <team-name> teamsize:10 flagmustbehome:on flagpointsonly:off flagreturn:<both/flag/spawn> nohunger:off respawntimer:0 saturation:10 spawnstyle:<small/flat/big/invisible> \\
|
||||
/teamcfg <team-name> loadout:default -> sets the default respawn inventory to your current items. \\
|
||||
/teamcfg <team-name> loadout:<extra-loadout-name> -> adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn. \\
|
||||
/teamcfg <team-name> deleteloadout:<extra-loadout-name> -> removes the specified loadout from the choices. \\
|
||||
/teamcfg <team-name> playerloadoutasdefault:true -> the player can bring a copy of his outside-world inventory to fight, it replaces the default loadout. \\
|
||||
/teamcfg <team-name> reward:default -> sets the winner's reward to your current items.
|
||||
\\\\ Print config \\
|
||||
/teamcfg [zone-name] <team-name> -print (or /teamcfg -p) -> prints out the current team settings. \\
|
||||
aliases:
|
||||
- setteamconfig
|
||||
zonemaker:
|
||||
description: War> Toggles between player mode and zone maker mode. Or gives/removes access to zonemaker commands for another player.
|
||||
usage: Toggles between player mode and zone maker mode. Or gives/removes access to zonemaker commands for another player.
|
||||
@ -274,32 +255,34 @@ commands:
|
||||
usage: Enables the War plugin.
|
||||
Ex -
|
||||
/loadwar
|
||||
setwarconfig:
|
||||
warcfg:
|
||||
description: War> Change gobal settings and the default warzone configuration values.
|
||||
usage: Change global settings and the default warzone and team configuration values.
|
||||
Ex -
|
||||
/setwarconfig pvpinzonesonly:on buildinzonesonly:on disablepvpmessage:off tntinzonesonly:off maxzones:12 => Global settings,
|
||||
/setwarconfig lifepool:8 teamsize:5 maxscore:7 autoassign:on ff:on blockheads:on spawnstyle:<big/flat/small/invisible> unbreakable:on nocreatures:on disabled:on monumentheal:<0-20>
|
||||
flagreturn:<both/spawn/flag> flagpointsonly:false glasswalls:on pvpinzone:true instabreak:false nodrops:false nohunger:false saturation:<0-20> minplayers:1 minteams:1
|
||||
=> Warzone defaults,
|
||||
/setwarconfig loadout:default => sets the respawn inventory to your current items,
|
||||
/setwarconfig loadout:<extra-loadout-name> => adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn
|
||||
/setwarconfig deleteloadout:<extra-loadout-name> => removed teh specified loadout from the choices. You cannot remove the default loadout.
|
||||
/setwarconfig reward:default => sets the winner's reward to your current items.
|
||||
/setwarconfig rallypoint:<warzone-name> => changes when players get teleported at the end of a match for that zone, useful for chaining warzones together in a sequence, or preventing players from rejoining immediately
|
||||
warcfg:
|
||||
description: War> Alias for /setwarconfig
|
||||
usage: Change global settings and the default warzone and team configuration values.
|
||||
Ex -
|
||||
/warcfg pvpinzonesonly:on buildinzonesonly:on disablepvpmessage:off tntinzonesonly:off maxzones:12 => Global settings,
|
||||
/warcfg lifepool:8 teamsize:5 maxscore:7 autoassign:on ff:on blockheads:on spawnstyle:<big/flat/small/invisible> unbreakable:on nocreatures:on disabled:on monumentheal:<0-20>
|
||||
flagreturn:<both/spawn/flag> flagpointsonly:false glasswalls:on pvpinzone:true instabreak:false nodrops:false nohunger:false saturation:<0-20> minplayers:1 minteams:1
|
||||
=> Warzone defaults,
|
||||
/warcfg loadout:default => sets the respawn inventory to your current items,
|
||||
/warcfg loadout:<extra-loadout-name> => adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn
|
||||
/warcfg deleteloadout:<extra-loadout-name> => removed teh specified loadout from the choices. You cannot remove the default loadout.
|
||||
/warcfg reward:default => sets the winner's reward to your current items.
|
||||
/warcfg rallypoint:<warzone-name> => changes when players get teleported at the end of a match for that zone, useful for chaining warzones together in a sequence, or preventing players from rejoining immediately
|
||||
\\\\ War config \\
|
||||
/warcfg buildinzonesonly:on disablebuildmessage:off -> requires war.build permission to build outside warzones. \\
|
||||
/warcfg pvpinzonesonly:on disablepvpmessage:off tntinzonesonly:off -> pvp and tnt denied outside zones (use war.pvp permission to allow pvp). \\
|
||||
/warcfg maxzones:12 keepoldzoneversions:on -> manage War's resource usage. \\
|
||||
/warcfg warhubmaterial:<floor/outline/gate/light> -> while holding block, change the look of the warhub (use air block to keep original floor). \\
|
||||
/warcfg rallypoint:<warzone-name> -> changes game-end teleport destination from lobby to current location - useful for chaining warzones together in a sequence, or preventing players from rejoining immediately.
|
||||
\\\\ Warzone defaults \\
|
||||
/warcfg autoassign:off blockheads:on deathmessages:on disabled:off friendlyfire:off glasswalls:on
|
||||
instabreak:off minteams:1 minplayers:1 monumentheal:5 nocreatures:off nodrops:off pvpinzone:on
|
||||
realdeaths:off resetonempty:off resetonconfigchange:off resetonload:off resetonunload:off unbreakable:off \\
|
||||
/warcfg lobbymaterial:<floor/outline/gate/light> -> while holding block, change the look of the lobby (use air block to keep original floor). \\
|
||||
/warcfg material:<main/stand/light> -> while holding block, change the look of the monument, flag, cake and bomb.
|
||||
\\\\ Team defaults \\
|
||||
/warcfg lifepool:7 -> each death consumes a life from the team's pool, a death with an empty lifepool ends the battle and gives a point to the other teams. \\
|
||||
/warcfg maxscore:10 -> once a team reaches this value, the game is ended. \\
|
||||
/warcfg teamsize:10 flagmustbehome:on flagpointsonly:off flagreturn:<both/flag/spawn> nohunger:off respawntimer:0 saturation:10 spawnstyle:<small/flat/big/invisible> \\
|
||||
/warcfg loadout:default -> sets the default respawn inventory to your current items. \\
|
||||
/warcfg loadout:<extra-loadout-name> -> adds an extra loadout (i.e. another player class) that the players can toggle to by sneaking while inside the spawn. \\
|
||||
/warcfg deleteloadout:<extra-loadout-name> -> removes the specified loadout from the choices. \\
|
||||
/warcfg playerloadoutasdefault:true -> the player can bring a copy of his outside-world inventory to fight, it replaces the default loadout. \\
|
||||
/warcfg reward:default -> sets the winner's reward to your current items.
|
||||
\\\\ Print config \\
|
||||
/warcfg -print (or /warcfg -p) -> prints out the current War settings. \\
|
||||
aliases:
|
||||
- setwarconfig
|
||||
# Fallback
|
||||
war:
|
||||
description: War> Short War help. Can also be used as a prefix for all War commands as a fallback if they conflict with other plugins.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user