Updated Leaderboards (markdown)

garbagemule 2014-07-23 17:16:10 -07:00
parent ec478d0cf8
commit 637ef261d9

@ -1,13 +1,27 @@
The MobArena leaderboards allows for tracking of the following stats. The header column denotes the text displayed on the leaderboard column header, and the code column denotes the code to use when putting up the sign. The codes must be prefixed by `[MA]`, e.g. to get column showing the amount of damage each player has done, put up a sign with the text `[MA]dmgDone` on the first line of the sign.
MobArena supports so-called _leaderboards_ (although technically they are more like scoreboards or session signs). By arranging signs in a two-dimensional grid on a wall, spectators can see which classes each player has chosen, which wave they died on, how many kills and how much damage they have done, etc.
----------------------------
| Header Code |
----------------------------
| Class class |
| Last Wave lastWave |
| Kills kills |
| Damage Done dmgDone |
| Damage Taken dmgTaken |
| Swings swings |
| Hits hits |
----------------------------
![Sign Grid](img/leaderboards/1.png)
The requirements for leaderboards are at the very least two rows of signs on a wall as seen in the screenshot above. The top row should not be empty, however, as it should contain the leaderboard _headers_, which denote what kind of information the signs below them display. How many headers (and which) you want is entirely up to you.
![Top Left Sign](img/leaderboards/2.png)
To get started, replace the top left empty sign (or place it if you haven't already), and write `[MA]<name>`, where `<name>` is the name of your arena, on the first line. In the screenshot above, I have set up the top left sign for the arena named Jail by writing `[MA]jail` on it. MobArena automatically fills in the rest of the text and the colors for you.
![Sign Text Screen](img/leaderboards/3.png)
MobArena will then tell you that the sign has been created, and that you should set up the rest of the signs. The rest of the headers follow the same kind of format as the top left sign, so you simply write `[MA]<stat>`, where `<stat>` is one of the following:
* `class` - The class name of the player
* `lastWave` - The last wave the player was part of (current wave if still alive)
* `kills` - The number of monsters the player has killed
* `dmgDone` - The amount of damage the player has dealt
* `dmgTaken` - The amount of damage the player has taken
* `swings` - The number of times the player has swung their weapon
* `hits` - The number of times the player has swung their weapon and successfully hit a monster
In the screenshot above, I have already set up a couple of signs, and I'm about to set up the sign for damage done. As with the top left sign, your only job is to tell MobArena which stat you want - it'll take care of colors and formatting automatically. Note that MobArena's sign handling is case sensitive, so make sure you get it right.
![Final Setup](img/leaderboards/4.png)
When you're done setting up the leaderboards, they should look something like the screenshot above, and you should be good to go! Leaderboards can be set up anywhere (even outside of the world the arena is in), but you can only have a single leaderboard per arena.