v1.3.1.48 - update all the things in the doc

doc/changelog.md

@@ -1,3 +1,4 @@
+- v1.3.1.48 - update all the things in the doc
 - v1.3.1.46 - pull #106 - thanks a TON to @Oruss7 for putting together this load of information!
 - v1.3.1.45 - the final update for 1.7.9 - unless critical errors arrive. I need to get ready for 1.9
 - v1.3.1.44 - prevent an NPE in the WarmupJoin module

doc/commands.md

@@ -23,7 +23,7 @@ _(Permission: pvparena.admin OR ownership AND pvparena.create)_
 
 Command | Shorthand | Definition
 ------------- | ------------- | -------------
-[/pa blacklist \(or whitelist\)](commands/blacklist.md) | /pa !bl (!wl) | Manage arena blacklist or whitelists
+[/pa blacklist \(or whitelist\)](commands/blacklist.md) | /pa !bl (!wl) | Manage arena blacklists or whitelists
 [/pa check](commands/check.md) | /pa !ch | Checks an arena configuration
 [/pa class](commands/class.md) | /pa !cl | Manage arena classes
 [/pa create](commands/create.md) | /pa !c | Creates an arena

doc/commands/spawn.md

@@ -14,4 +14,12 @@ Command |  Definition
 ## Details
 
 If you get a message "spawn unknown", this is probably because you did not install / activate a goal / module ; be sure that you install and activate stuff you want to add, 
-e.g. the "Flags" goal, or the "StandardSpectate" module...
+e.g. the "Flags" goal, or the "StandardSpectate" module...
+
+## Spawn Offset
+
+Since v1.3.1.31 you can define unique offsets for each spawn name, in order to not be placed on the block center but rather one edge:
+
+- /pa {arenaname} spawn [spawnname] offset X Y Z
+
+For example 0.5 0 0.5 as X Y Z would work setting you on an edge. You might want to keep F3 at hand to see if you actually have to add or subtract to get to the right edge.

doc/configuration.md

@@ -1,13 +1,14 @@
 # Configuration File
 
-This is a default configuation file. All parameters can be change via commands in-game.
+This is a default configuation file. All parameters can be changed via in-game commands ([/pa set](commands/set.md)).
 
     configversion: 1.0.6.198
     chat:
       colorNick: true               
       defaultTeam: false
       enabled: true
       onlyPrivate: false
+      toGlobal: none
     cmds:
       defaultjoin: true
       whitelist: []
@@ -83,6 +84,7 @@ This is a default configuation file. All parameters can be change via commands i
       hungerforkill: 0
       foodLevel: 20
       health: -1
+      healforkill: false
       hunger: true
       mayChangeArmor: true
       maxhealth: -1

doc/creation.md

@@ -1,7 +1,7 @@
 
 ## Basic creation
 
-_\[Required] (Optional) Arena name is optional but if you have more than one arena it is required._
+_\[Required] (Optional) Arena name is optional if you are inside an arena or in edit mode, but if you have more than one arena it is required._
 
 ### 1. Create the arena.
 
@@ -51,7 +51,7 @@ Add more classes with the [class command](commands/class.md)
 
 Place the signs in each lobby, and an iron block (configurable). The iron block is the default ready block, and you push it when your ready to start the match.
 
-:triangular_flag_on_post: Tip : You can set a default class using the parameter `AutoLoad`.
+:triangular_flag_on_post: Tip : You can set a default class using the config parameter `autoClass`.
 
 ### 5. Join the arena!
 

doc/enhancements.md

@@ -30,6 +30,7 @@ Goal | Description
 [PlayerLives](goals/playerlives.md) | Player deaths lose (pre-installed)
 [Sabotage](goals/sabotage.md) | Ignite TNT (pre-installed)
 [Tank](goals/tank.md) | all vs one (pre-installed)
+[TeamDeathConfirm](goals/teamdeathconfirm.md) | Confirmed Team kills win (pre-installed)
 [TeamDeathMatch](goals/teamdeathmatch.md) | Team kills win (pre-installed)
 [TeamLives](goals/teamlives.md) | Team deaths lose (pre-installed)
 [Time](goals/time.md) | Time ends the arena (pre-installed)
@@ -44,12 +45,16 @@ Mod | Description
 [Announcements](mods/announcements.md) | announce events happening
 [ArenaBoards](mods/arenaboards.md) | stats display
 [ArenaMaps](mods/arenamaps.md) | never lose yourself ever again!
+[AutoSneak](mods/autosneak.md) | automatically hide player nametags by forcing sneak mode
 [AutoVote](mods/autovote.md) | automatism
 [BanKick](mods/bankick.md) | secure your arenas!
 [BattlefieldGuard](mods/battlefieldguard.md) | secure your battlefield
+[BattlefieldManager](mods/battlefieldmanager.md) | manage your battlefield
 [BetterClasses](mods/betterclasses.md) | add potion effects to classes
 [BetterGears](mods/bettergears.md) | give team colored leather
 [BetterFight](mods/betterfight.md) | kill streaks and one-hit-kill items!
+[BetterKillstreaks](mods/betterkillstreaks.md) | even more detailed kill streaks!
+[BlockDissolve](mods/blockdissolve.md) | dissolve blocks under fighting players
 [BlockRestore](mods/blockrestore.md) | restore the battlefield
 [ChestFiller](mods/chestfiller.md) | fill battlefield chests with customizable content!
 [ColorTeams](mods/colorteams.md) | color players!
@@ -60,20 +65,26 @@ Mod | Description
 [FlySpectate](mods/flyspectate.md) | have players spectating a fight in fly mode
 [Items](mods/items.md) | spawn (random) items
 [LateLounge](mods/latelounge.md) | keep playing until enough ppl are joining
+[MatchResultStats](mods/matchresultstats.md) | keep stats of player games, who won, who lost?
 [PlayerFinder](mods/playerfinder.md) | Allow players to find others with a compass
+[Points](mods/points.md) | Allow to restrict certain classes to require players to fight for better classes
 [PowerUps](mods/powerups.md) | exactly that
 [RealSpectate](mods/realspectate.md) | spectate the game, CounterStrike style!
 [RedstoneTriggers](mods/redstonetriggers.md) | add win/lose triggered by redstone
 [RespawnRelay](mods/respawnrelay.md) | add a relay for respawning players
 [ScoreBoards](mods/scoreboards.md) | ScoreBoards!
+[SinglePlayerSupport](mods/singleplayersupport.md) | Allow players to use an arena on their own!
 [Skins](mods/skins.md) | add custom skins to teams/classes
 [SpecialJoin](mods/specialjoin.md) | join via buttons, levers, etc
+[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
 [TempPerms](mods/tempperms.md) | add temporary perms
 [Turrets](mods/turrets.md) | add turrets where players fire projectiles
 [Vault](mods/vault.md) | add economy
 [Walls](mods/walls.md) | define wall regions to simulate "The Walls"
 [WorldEdit](mods/worldedit.md) | backup/restore regions
+[WorldGuard](mods/worldguard.md) | import region definitions from WorldGuard
 
 ### PVP Arena Region Shapes
 

doc/goals/teamdeathconfirm.md

@@ -0,0 +1,23 @@
+# TeamDeathMatch
+
+## Description
+
+Team play. Team kills are counted by collecting the drops when a player is killed, the first team collecting the set amount of drops wins.
+
+The big difference to standard PVP is that a team can prevent the other team from scoring by collecting the drops themselves.
+
+## Setup
+
+\-
+
+## Config Settings
+
+- tdcitem \- the amount of (enemy) drops a team has to collect in order to win
+
+## Warnings
+
+\-
+
+## Supported Game Modes
+
+Only supports team game mode!

doc/mods/autosneak.md

@@ -0,0 +1,29 @@
+# AutoSneak
+## Description
+
+This mod automatically sets players to sneak, in order for their nametags to be hidden all the time.
+
+## 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
+
+\-
+
+## Config settings
+
+\-
+
+## Commands
+
+\-
+## Warnings
+
+\-
+
+## Dependencies
+
+\-

doc/mods/battlefieldmanager.md

@@ -0,0 +1,32 @@
+# BattlefieldManager
+
+## Description
+
+This mod allows to run one arena with several spawn setups. Save and load spawn setup to quickly change the pace of the game.
+
+## 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
+
+Simply create spawns as usual, and then use one of the commands below.
+
+## Config settings
+
+\-
+
+## Commands
+
+- `/pa !bm` \- show the currently loaded battle definitions
+- `/pa !bm [name]` \- load definition [name]
+- `/pa !bm clear` \- start defining a new definition
+- `/pa !bm update` \- update loaded definition with corrections/additions
+- `/pa !bm save [name]` \- save to definition [name]
+
+## Warnings
+
+\-

doc/mods/betterkillstreaks.md

@@ -0,0 +1,39 @@
+# BetterFight
+
+## Description
+
+This mod enhances fighting, by adding kill streak potion effects or items
+
+## 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
+
+Apart from the obvious config settings, there are the potion possibilities. You can set those nodes to a string value that represents a bukkit ENUM, here is the link:
+
+https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/potion/PotionEffectType.html
+
+Case does not matter :)
+
+## Config settings
+
+\-
+
+## Commands
+
+- `/pa [arena] !bk [level]` \- show content of killstreak level [level]
+- `/pa [arena] !bk [level] clear` \- clear the definition level [level]
+- `/pa [arena] !bk [level] items` \- set the items of level [level] to your inventory
+- `/pa [arena] !bc [level] potion [def] [amp] [dur]` \- add potioneffect definition to level [level]
+
+## Warnings
+
+\-
+
+## Dependencies
+
+\-

doc/mods/blockdissolve.md

@@ -0,0 +1,34 @@
+# BlockDissolve
+
+## Description
+
+This mod adds another layer of tension. Blocks under the player will dissolve, great addition to spleef arenas!
+
+## 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
+
+The mod needs a full server restart to properly alter the configuration. After the restart, you will see a configuration block, as described below. The chests will be filled with a random itemstack count between min and max. So the default will spam items 1-10, 0-5 out of those. There is a rare chance that the same item will be given twice, this chance increases when lowering the items or rising the max count.
+
+## Config settings
+
+- modules.blockdissolve.materials \- the material to dissolve data value / color is ignored
+- modules.blockdissolve.startseconds \- the seconds to count down before the match starts
+- modules.blockdissolve.ticks \- the ticks after what time the block under the player should dissolve (20 ticks = 1 second)
+
+## Commands
+
+\-
+
+## Warnings
+
+\-
+
+## Dependencies
+
+\-

doc/mods/duel.md

@@ -21,8 +21,9 @@ Unzip the module files (files tab, "PA Files v*.*.*") into the /pvparena/files f
 
 ## Commands
 
-- `/pa [arena] duel [player]` \- invite a player to a duel!
-- `/pa [arena] accept` \- accept the duel! 
+- `/pa [arena] duel [player]` \- invite a player to a duel
+- `/pa [arena] accept` \- accept the duel
+- `/pa [arena] decline` \- decline the invitation
 
 ## Warnings
 

doc/mods/matchresultstats.md

@@ -0,0 +1,39 @@
+# MatchResultStats
+
+## Description
+
+This mod adds statistics to the game. It requires a MySQL database, which you have to also check yourself. No GUI added!
+
+A table will be created, but the database has to exist.
+
+## 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
+
+You need to set a spawn called "relay" -> `/pa [arena] spawn relay`
+
+## Config settings ( config.yml !!! NOT per arena! )
+
+- MySQLhost \- the SQL hostname
+- MySQLuser \- the database user
+- MySQLpass \- the user password
+- MySQLdb \- the database name
+- MySQLtable \- the table name
+- MySQLport \- the SQL port
+
+## Commands
+
+- `/pa [arena] !ss reset [playername]` \- reset someone's stats
+
+## Warnings
+
+\-
+
+## Dependencies
+
+\-

doc/mods/points.md

@@ -0,0 +1,39 @@
+# Points
+
+## Description
+
+This mod adds a little restriction to classes. Players have to choose lesser classes and earn points to choose better classes!
+
+## 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
+
+Check the below config settings, after adding the module and doing a full server restart / reload, there should be the mentioned class nodes.
+
+Scores are, for instance, claiming a flag in CTF or Domination, bringing a hostage home or finishing Food in the Food Goal, a trigger is something shortly before a score like unclaiming a flag in Domination or triggering the final score in TeamLives etc.
+
+## Config settings
+
+- modules.points.classes.[classname] \- the required points (in decimals) to choose this class
+- modules.points.reward.PplayerDeath \- how many points should be granted / reduced for a player's death?
+- modules.points.reward.PplayerKill \- how many points should be granted / reduced for a kill?
+- modules.points.reward.PplayerScore \- how many points should be granted / reduced for player scoring?
+- modules.points.reward.Ptrigger \- how many points should be granted / reduced for a player triggering a goal?
+- modules.points.reward.PplayerWin \- how many points should be granted / reduced for a player winning?
+
+## Commands
+
+\-
+
+## Warnings
+
+\-
+
+## Dependencies
+
+\-