Skip to content

1. Configuring EasyAdmin

Blue edited this page Jul 20, 2020 · 62 revisions

Configuration of EasyAdmin is done via convars, these can be set via your server config file or by typing it as a command inside your servers' console ( this method may not always work with EasyAdmin and the settings will reset after the server has been restarted. )

setr ea_LanguageName "en"                # set our language to english
setr ea_MenuButton "289"			# set our menu button to F2. default: "289"
setr ea_alwaysShowButtons "false"	# we don't want to see buttons we can't even access, do we? default: "false"
set ea_moderationNotification "false"   # this can be either "false" or a discord webhook address, this will send a discord message if an admin takes actions against a player  ( such as banning and kicking )
set ea_custombanlist "false"            # read docs for this, dont touch it
set ea_enableCallAdminCommand "true"
set ea_enableReportCommand "true"

set ea_minIdentifierMatches 2

The Minimum Amount of Identifiers that have to match before a Player gets "Declined" for being banned.

NEVER PUT THIS BELOW 1

setr ea_LanguageName "en"

This Convars dictates in which language EasyAdmin is displayed ( this includes but is not limited to GUI, Kick Messages, Reasons, Hud Elements.. ) Current Available options are:

en,de,fr,it,sv,pt

setr ea_MenuButton "289"

This Dictates which Key opens the EasyAdmin GUI, default is "289" ( F2 ), you can view available controls in the FiveM Wiki

setr ea_alwaysShowButtons "false"

This convar was mainly used for debugging features, it enables all buttons to be viewed, however, this will not allow people that do not have high enough permissions to use any of them, it just shows their options.

set ea_moderationNotification "false"

This Convar is Documented Here

setr ea_enableDebugging "false"

This Convar enabled a lot of Debugging prints in the Server Logs.

This Convar is your friend, if you cannot open the menu and get no errors, its very likely a permission issue, you can use enableDebugging to view your permissions when you join the server.

set ea_custombanlist "false"

Enables custom Banlist systems, see https://github.com/Bluethefurry/EasyAdmin/wiki/Custom-Banlist-Plugins for further documentation

setr ea_screenshoturl "https://wew.wtf/upload.php"

Defines an Image Uploader for the created Screenshots, make sure ea_screenshotfield is also configured correctly.

setr ea_screenshotfield "files[]"

Defines the name for the form field to add the file to. See screenshot-basic for further information.

setr ea_screenshotOptions "{}"

Defines any arguments that should be passed through to screenshot-basic as a JSON String. See screenshot-basic for further information.

set ea_enableCallAdminCommand "true"

Enables "calladmin" command, will print a message via webhook.

set ea_enableReportCommand "true"

Enables "report" command, see below for additional configuration. Will "Report" a Player and kick it after they have been reported x times

set ea_defaultMinReports 3

Minimum Reports to Ban someone below ea_MinReportPlayers Threshold, if ea_MinReportModifierEnabled, this is the amount always needed for a player to be banned.

set ea_MinReportModifierEnabled "true"

Allows "Variable" Minimum Report Count, Will Divide Current Player Count by ea_MinReportModifier.

set ea_MinReportPlayers 12

Minimum Amount of Players for the "Report Modifier" to enable, would not recommend setting below this number.

set ea_MinReportModifier 4

Amount by which Player Count gets divided to get "minimum reports needed" count, so if 12 Players are on the server and this value is 4, 12/4= 3 Reports

set ea_ReportBanTime 86400

Ban Time in unix time, how long the temporary ban should last after getting reported by x users

set ea_chatReminderTime 0

Time ( in minutes ) of how often there should be a random Chat Reminder printed to Chat, disabled if 0.

ea_addReminder "My Reminder Text"

Make sure to add this parameter BELOW the EasyAdmin start line, otherwise it won't work

Adds a Reminder Text to the pool of available options, can support infinite reminders, following Wildcards are supported:

@admins - Shows all Online Admins in chat, if no admins are online, it just prints @admins
@bancount - Shows the amount of Bans in the Banlist
@time - Shows the Current Time
@date - Shows the Current Date

This also supports colour codes from ^1-^9.

Some Example Reminders:

ea_addReminder "This Server is watched by ^3@admins^7"
ea_addReminder "Current Time: ^5@time^7."
ea_addReminder "Our Banlist has @bancount Entries!"