Installation & Content
This addon supports DarkRP 2.7.0+Extract ch_mayor to your addons folder.
Please visit the Setup & Customizing tab to see how you configure the addon.
CONTENT
There's a single content pack that you must add to your servers workshop collection.Workshop
----------------------------------------------------------------------------------------------------------------
Setup & Customizing
There is a single configuration file to modify various parts of the addon.
Configure the general settings of the addon in lua/ch_mayor/shared/config/ch_mayor_config.lua
View the configuration HERE
SETUP ENTITIES
There are 4 entities that you as an admin/server owner can pre-configure on your server.Announcement boards, city/law board, wanted screens and mayor leaderboards.
You can find all the entities in the Q Menu -> Entities -> Mayor by Crap-Head
Place the entities as you wish and use the console command ch_mayor_saveents to save them to the map.
SETUP VAULT
The mayor vault is spawned via a secondary console command ch_mayor_setvaultpos
Run it as an admin in the position you want the mayor vault to be set at. It will aim in your direction/follow your angle as a player.
You can run the command again to respawn it in a new position.
REMOVING ENTITIES
If you regret setting up some of the spawn points for the entities listed above then you can remove them using the normal Remover Tool and run the console command ch_mayor_saveents to save the current entities to the map.The mayor vault cannot be removed and must be spawned somewhere.
MYSQLOO
By default the addon saved using sqlite (default build into gmod). If you wish to enable MySQLOO then you can do so.
Go to the file lua/ch_mayor/server/sql/ch_mayor_sql_functions.lua
Set the CH_Mayor.SQL.UseMySQLOO config to true
Then fill in your information below. This will of course require that you have the MySQLOO module by FredyH.
-----------------------------------------------------------------------------------------------------------------
Everyone knows that your mayor has a tough time managing the city at it's current state. This addon collects every aspect of being a mayor into a single menu and gives him full control over his citizens and government teams.
The addon includes a range of existing features in DarkRP and new features, such as promotion, interactive screens, catalog, upgrades and much more!
City Dashboard
- View city funds, governments on duty and amount of city residents.
- Deposit money into the city vault (configurable)
- Withdraw money from the city vault (configurable)
Upgrades
- The mayor can purchase upgrades that will stay for his entire period as mayor.
- The upgrades come in levels from 0-5 but are fully variable and can be edited to your liking.
- Upgrade the capacity of the mayors vault.
- Upgrade the government teams paycheck bonus.
- Upgrade the government teams kevlar to equip them with extra kevlar.
- Upgrade the government teams health insurance to grant them extra health.
Taxes
- You can configure a selection of teams that are taxed from their paycheck.
- The taxed money go to the mayor vault.
- The mayor can configure the taxed amount through the menu.
- Server owners can auto-generate a list of taxes using ch_mayor_randomtaxes in-game console.
Catalog
- The mayor can make one-time purchases from the catalog.
- Primarily used to purchase announcements screens, wanted boards, city boards and other mayor entities.
- Purchase a trash dumpster that citizens can drop items into to receive a small money/xp bonus.
Laws
- The mayor can add and remove laws from the laws tab.
- Ability to add new laws onto the big city board.
- Fully compatible with DarkRPs default law system.
- Remove laws via the menu easily.
Licenses
- The mayor can manage gun licenses through the menu.
- Grant or remove gun licenses.
- View if players has an active gun license or not.
Officials Management
- The mayor can view and manage government teams.
- They can demote officials through the menu.
- A custom promoting feature is also included in the menu, that allows the mayor to promote certain teams to certain teams, but a higher rank.
- So for example you can configure that the Police Officer job can be promoted to Police Chief and that the Police Chief job can be promoted to SWAT.
Civilians Management
- The civilian management the mayor can make players wanted or issue warrants.
- The mayor gets to set a time and reason when making a player wanted.
- They also get to set a reason for the search warrant and the warrant time follows DarkRPs default config.
Wanted
- The wanted tab will show all wanted players and their wanted reason.
- They can also cancel the wanted status.
- There are permanently placed wanted board entities available that the server owner can set on the map.
- The boards will show all wanted criminals with their name and a short wanted reason.
- You can press "More Info" to view the players model, name and full wanted reason.
- There is also support for multiple pages and the board is fully interactive with the mouse and E to press buttons.
Warrants
- The mayor can view active search warrants here.
- The menu will show the name, reason for warrant and time remaining.
- They can also cancel the search warrant before the time expires here.
Announcements
- The mayor can update the mayor announcement through this tab.
- It will broadcast the announcement to all announcement screens in the city.
- Citizens are also notified that the announcement has been updated.
Lockdowns
- This tab allows the mayor to initialize a lockdown.
- If there's an active lockdown then the mayor can end it through this menu as well.
- The lockdown system is fully compatible with DarkRPs default system.
Statistics
- This tab shows the players overall personal mayor statistics.
- Total warrants placed
- Total players wanted
- Total times elected as mayor
- Total successful vault robberies during their period
- Total playtime as mayor
- Total players demoted
- Total players promoted
- Total capital added to the mayor vault themselves
- Total lockdowns initiated
- Total lotteries started
Leaderboard
- Leaderboards are placeable by the server owner as permanent entities.
- They can also be bought by the mayor in the catalog if you want that.
- They show all the statistics available in the addon as top 10's.
- They're fully interactive using the mouse to move around and E to switch leaderboard.
- They're networked on demand, so the first time you see it you request the networking (meaning no useless networking on connect)
Mayor Vault
- The mayor vault is placed by the server owner as a permanent entity.
- The vault displays the amount of money the city has.
- The vault offers configuration to permanently save money (via either SQLite or MySQLOO)
- The vault can be robbed by criminal teams (configurable).
- There's a set of configurations such as required players online, required cops online, and so on before starting a robbery.
- The robber must stay alive and close to the vault for x amount of time to successfully rob the money.
- Once a robbery is successful there's a cooldown before a new one can take place.
City Boards
- City boards are spawnable by the server owner and saves permanently to the map.
- They display city funds, city residents and wanted criminals.
- They also act as law boards and will replace the default darkrp law board.
- All laws are updated via the menu or default DarkRP chat commands.
MySQL Support
- By default the addon saves using SQLite that comes with GMod.
- You can enable MySQLOO saving. See the "Setup" tab.
- Both options are efficient to use, however, mysqloo is recommended.
Level System Support
- Receive XP when successfully robbing the vault or when killing an active robber.
- Support for Sublime Levels
- Support for Vrondakis Level System
- Support for Elite XP System (EXP2)
- Support for DarkRP Essentials or Brick's Essentials
- Support for GlorifiedLeveling
bLogs Support
- The addon supports bLogs.
- Logs when a player throws an item into the mayor placed trashcans (player, ent class and reward)
- Logs when a robbery starts (player)
- Logs when a robbery is successful (player, money stolen)
- Logs when a robbery fails (player)
- Logs when the mayor withdraws money from the vault (player, amount)
- Logs when the mayor deposits money into the vault (player, amount)
- Logs when mayor purchases an item from the catalog (player, item, price)
- Logs when mayor purchases an upgrade (player, upgrade, level, price)
- Logs when mayor upgrades are reset.
- Logs when mayor catalog items are reset.
Language System
- English
- French
- Danish
- Spanish
- Polish
- Russian
- Turkish