[ Agon ] PVP Leaderboard System

DESCRIPTION

The Cyrus Leaderboard system is a complete PVP leaderboard solution for various Garry's Mod gamemodes such as Sandbox and TTT. It includes a wide variety of features that help keep kills legit, as well as interactive features that keep players interested.

Note This does not replace the existing Scoreboard you have on your network. This is an extension and is triggered with a key and chat command.

FEATURES

• Fully designed GUI with a tabbed theme.
• MySQL driven (see below)
• Customizable ranks allow you to change the names and number of kills to achieve rank right in config file.
• Displays various categories to sort players by including the Top 25 with the most Kills, Deaths, KDR (kill/death ratio), and Latest Activity.
• Personal player stats displayed in bottom left include Player Name, Kill/Death Ratio, Rank, and total Kills/Deaths.
• Optional welcome message greets players when they join and explains how to use the Leaderboard. (See screenshot for demo)
• Bind system allows you to change the bind key using Garry's Mod ENUMS. (See http://wiki.garrysmod.com/page/Enums/KEY)
• Rank system will promote a player when 'x' number of kills have been achieved. (Name and min limit can be modified in config)
• Notification system displays when a player ranks up. (Can be customized for either public or private broadcasting) (See screenshot for demo)
• Godmode Protection keeps players from earning kills while in God Mode.
• Coloring settings within the sh/sh_config.lua allow you to change any of the colors on the board to match your network's color scheme.
• Admin right-click menu (with user-group permissions settings) that allows certain user-groups to reset a players kills/deaths and even remove the player completely from the database with a click. (See config file to edit which user-groups can access this). (See screenshot for demo)
• Highly customizable settings file allows you to change many different aspects including text, color, certain features being toggled on or off and more.
• Version checker allows you to type !cyrus in-game and see if a new version is available for download.

INSTALLATION

This script requires a mysql database in order to function properly.

• Download a copy of the script and extract it to your computer.
• Create a new folder within your Garry's Mod server's /addons/ folder named "cyrus" (Do not use CAPITAL LETTERS or S P A C E S in the folder name -- Lowercase only)
• Upload the extracted folders (lua, materials, resource) to the new folder you created in the /addons/ directory of your server.
• Download a copy of LibMySQL Windows | Linux
• Place the downloaded LibMySQL file(s) in the folder BEFORE /garrymods/
• Download a copy of MySQLOO Windows | Linux
• Place the downloaded MySQLOO file(s) in the folder /garrysmod/lua/bin/
• Open the /sh/ folder and configure sh_config.lua for visual and functionality settings.
• Open the /sv/ folder and configure sv_mysql_config.lua to insert your MySQL information.
• Restart your server and join.
• Check your server-side console for the message 'MySQL Connection Success!'. This confirms you have a good connection.

FAQ

I changed the configuration and things stopped working. Check your values. Anything with a true or false value is a Boolean value, and should only be true or false. Make sure you don't have unneeded quotation marks.

Can players get kills for killing in godmode? No. Protection disables this from happening. If anyone kills another player in Godmode, it simply won't count.

Can I change the rank names? Absolutely! They are located in the configuration file (sh/sh_config.lua). In there you'll find the rank names, as well as the number of kills needed to reach that rank. Both can be modified to whatever you wish. Ranks can also be removed or added to your desired specifications.

I want a different color for my network, how can I do this? Edit the configuration file (sh/sh_config.lua). Within the file is a list of various colors for the panels, buttons, and much more. Simply change the RGB value, and your object color will be set!

When I turn the server on, I get this error /lua/cyrus/sv/sv_board.lua:57: attempt to compare number with nil

This means that you haven't setup your database properly. Ensure in your console that it states that Cyrus has connected successfully to the database. This error occurs because Cyrus cannot connect to the database and fetch the player data.

Do I need anything to make this work? Just the mysqloo library, which can be downloaded here:

**LibMySQL ** Windows | Linux

gmsv_mysqloo_OS.dll Windows | Linux

LICENSES

Fonts

Certain fonts used for this script were made possible thanks to the Open Font License (OFL)

Icons

Certain icons are made possible thanks to Icons8 and IconsDB. They are licensed under the Creative Commons Attribution-NoDerivs 3.0 Unported license.