v1.3.2.99 - add Beacons settings and documentation

doc/changelog.md

@@ -1,3 +1,5 @@
+- v1.3.2.99 - add Beacons settings and documentation
+- v1.3.2.97 - add Titles API hooks, documentation will follow
 - v1.3.2.96 - add a configuration node to change the schematics folder for WorldEdit - adds github issue #129
 - v1.3.2.95 - add region command documentation - thanks @Oruss7
 - v1.3.2.94 - add Language for special Duel/Vault hooking

doc/enhancements.md

@@ -16,6 +16,7 @@ Create ways to win the game or lose the game!
 
 Goal | Description
 ------------- | -------------
+[Beacons](goals/beacons.md) | Stand near beacons and claim them to win!
 [BlockDestroy](goals/blockdestroy.md) | Destroy blocks (pre-installed)
 [Domination](goals/domination.md) | Dominate flag positions (pre-installed)
 [Flags](goals/flags.md) | Capture flags and bring 'em home (pre-installed)
@@ -81,6 +82,7 @@ Mod | Description
 [Squads](mods/squads.md) | add squads to the game, basically only showing players belonging together apart from teams and classes.
 [StartFreeze](mods/startfreeze.md) | freeze players at start
 [TeamSizeRestrict](mods/teamsizerestrict.md) | a small mod to restrict the size of specific teams
+[Titles](mods/titles.md) | send messages to players as the "title" command would do
 [TempPerms](mods/tempperms.md) | add temporary perms
 [Turrets](mods/turrets.md) | add turrets where players fire projectiles
 [Vault](mods/vault.md) | add economy

doc/goals/beacons.md

@@ -0,0 +1,34 @@
+# Beacons
+
+## Description
+
+The Beacons goal is designed to use teams. As always, it defaults to red and blue.
+
+It activates GLASS (to set) that can be claimed by players. To indicate claim status, a Beacon block will be spawned below the block (and remain there!!)
+In order to claim, they have to stand near the active beacon light, alone or at least only one team.
+Beacons can be unclaimed if a different team or multiple teams are too close to a claimed beacon.
+
+A claimed beacon gives points every few seconds (tickinterval) that add up to a score, the first team to have enough points wins.
+
+## Setup
+
+The GLASS blocks have to be added. In order to do that, use `/pa [arenaname] beacon`. This toggles edit mode.
+Don't forget to exit it again after setting the beacons. Set them by clicking the GLASS blocks which will color according to claim status.
+
+## Config Settings  
+
+- spamoffset => after how many updates should the arena announce? (default: 3)
+- claimrange => how near need players to be? (default: 3)
+- blives => claim lives ( max points to achieve )
+- tickinterval => the amount of ticks to wait before doing an update (default: 60 = 3 seconds)
+- tickreward => the amount of points to give for each score (default: 1)
+- changeseconds => the amount of seconds after which the server will calculate a new active beacon (default: 30, set to -1 to disable)
+- changeonclaim => change the active beacon as soon as it is claimed (and add the score)
+
+## Warnings
+
+This game mode has to check for player's position. Based on the player count this can lag your server. But, how else should I determine a claimed beacon? :p
+
+## Supported Game Modes
+
+Supports both game modes, but we suggest you use the team game mode!

doc/goals/domination.md

@@ -7,13 +7,12 @@ Domination is designed to use teams. As always, it defaults to red and blue.
 It activates Flags (to set) that can be claimed by players. In order to do that, they have to stand near that flag, 
 alone or at least only one team. Flags can be unclaimed if a different team or multiple teams are too close to a claimed flag. 
 
-Each claimed flag gives points every 3 seconds that add up to a score, the first team to have enough points wins.
+Each claimed flag gives points every few seconds (tickinterval) that add up to a score, the first team to have enough points wins.
 
 ## Setup
 
 Flags have to be added.In order to do that, use `/pa [arenaname] flag`. This toggles edit mode. 
-Don't forget to exit it again after setting the flags. Set them by clicking the flag type (WOOL by default). 
-Don't click with your wand, just click with your hand or anything else.
+Don't forget to exit it again after setting the flags. Set them by clicking the flag type (WOOL by default).
 
 ## Config Settings  
 

doc/mods/titles.md

@@ -0,0 +1,39 @@
+# Titles
+## Description
+
+Change the way how messages are sent, by adding the vanilla "title" command functionality instead of simple messages!
+## Installation
+
+Unzip the module files (files tab, "PA Files v*.*.*") into the /pvparena/files folder and install them via
+- `/pa install [modname]`, activate per arena via
+- `/pa [arenaname] !tm [modname]`
+## Setup
+
+Valid Announcement types:
+
+- JOIN \- players joining the arena
+- ADVERT \- players starting the arena for the first time
+- START \- the match begins
+- END \- the match ends
+- WINNER \- the winner is announced
+- LOSER \- the loser is announced
+- PRIZE \- the winning prize is announced
+- CUSTOM \- not used
+- COUNT \- countdowns like start, respawn and warmup
+
+## Config settings
+
+- all of the above \- is this announcement active?
+- color \- the color to format the announcements (default: AQUA) 
+
+## Commands
+
+- `/pa !tt [type]` \- toggle the title use of types, listed above
+
+## Warnings
+
+\-
+
+## Dependencies
+
+\-

readme.md

@@ -85,7 +85,7 @@ Users tutorials :
 
 ## Changelog
 
-- v1.3.2.97 - add Titles API hooks, documentation will follow
+- v1.3.2.99 - add Beacons settings and documentation
 - [read more](doc/changelog.md)
 
 ***

src/net/slipcor/pvparena/core/Config.java

@@ -169,6 +169,14 @@ public enum CFG {
 
         // ----------
 
+        GOAL_BEACONS_ANNOUNCEOFFSET("goal.beacons.spamoffset", 3, "Beacons"),
+        GOAL_BEACONS_CHANGESECONDS("goal.beacons.changeseconds", 30, "Beacons"),
+        GOAL_BEACONS_CHANGEONCLAIM("goal.beacons.changeonclaim", false, "Beacons"),
+        GOAL_BEACONS_CLAIMRANGE("goal.beacons.claimrange", 3, "Beacons"),
+        GOAL_BEACONS_LIVES("goal.beacons.blives", 10, "Beacons"),
+        GOAL_BEACONS_TICKINTERVAL("goal.beacons.tickinterval", 60, "Beacons"),
+        GOAL_BEACONS_TICKREWARD("goal.beacons.tickreward", 1, "Beacons"),
+
         GOAL_BLOCKDESTROY_BLOCKTYPE("goal.blockdestroy.blocktype", "IRON_BLOCK", false, "BlockDestroy"),
         GOAL_BLOCKDESTROY_LIVES("goal.blockdestroy.bdlives", 1, "BlockDestroy"),
 

src/net/slipcor/pvparena/core/Language.java

@@ -462,6 +462,18 @@ public enum MSG {
         WHITELIST_REMOVED("nulang.whitelist.removed", "Removed &a%1%&r from &e%2%&r whitelist!"),
         WHITELIST_SHOW("nulang.whitelist.show", "Whitelist &e%1%&r:"),
 
+        GOAL_BEACONS_CLAIMING("nulang.goal.beacons.claiming", "&eTeam %1% is claiming the beacon!"),
+        GOAL_BEACONS_CLAIMED("nulang.goal.beacons.claimed", "&eTeam %1% has claimed the beacon!"),
+        GOAL_BEACONS_CLAIMED_REMAINING("nulang.goal.beacons.claimed_remaining", "&eTeam %1% has claimed the beacon! %2% claims remaining!"),
+        GOAL_BEACONS_SCORE("nulang.goal.beacons.score", "&eTeam %1% scored %2% points by holding the beacon!"),
+        GOAL_BEACONS_CHANGED("nulang.goal.beacons.changed", "&eA new beacon has been activated!"),
+        GOAL_BEACONS_CONTESTING("nulang.goal.beacons.contesting", "&eThe beacon claimed by team %1% is being contested!"),
+        GOAL_BEACONS_UNCLAIMING("nulang.goal.beacons.unclaiming", "&eThe beacon claimed by team %1% is being unclaimed!"),
+        GOAL_BEACONS_UNCLAIMINGBY("nulang.goal.beacons.unclaimingby", "&eThe beacon claimed by team %1% is being unclaimed by team %2%!"),
+        GOAL_BEACONS_SET("nulang.goal.beacons.set", "Beacon set: %1%"),
+        GOAL_BEACONS_SETDONE("nulang.goal.beacons.setdone", "Beacon setting mode deactivated."),
+        GOAL_BEACONS_TOSET("nulang.goal.beacons.toset", "Beacon setting mode activated. Hit the glass blocks, then use the command again to save!"),
+
         GOAL_BLOCKDESTROY_TYPESET("nulang.goal.blockdestroy.typeset", "Blocktype set to: &e%1%"),
         GOAL_BLOCKDESTROY_SCORE("lang.goal.blockdestroy.score", "%1% destroyed the block of team %2%! Remaining destructions: %3%"),
         GOAL_BLOCKDESTROY_SET("nulang.goal.blockdestroy.setflag", "Block set: %1%"),