MyGamingTalk - User contributions [en]

LESM Installation

2015-05-07T00:04:36Z

Zelly: Finished configuration page

== Lua Enhanced Server Mod Install Guide ==
This guide will teach you how to install LESM on your server. Please read it carefully.
 When I refer to the server's mod directory I mean:
 '''/etdirectory/mod/''' Your qagame.mp.i386.so or qagame.mp.i386.dll will be in this directory.
 Example: ''/home/et/silent/''
 When I refer to the '''/LESM/''' directory that is inside your server's mod directory.
 Example: ''/home/et/silent/LESM/''
 JSON Files(files ending in ''.json'') can be picky when editing them, you can use [http://jsonformatter.curiousconcept.com/ jsonformatter] to ensure you have valid JSON format, if they are not valid it will cause errors.
== Requirements ==
The only requirement is that you have lua 5.1 installed on your server. For silent mod, it comes with the mod and you do not need to make any further adjustments. For other mods you will need to follow their instructions on how to install it. Usually it just requires you to download the lua 5.1 library, and using a specific qagame.
== Download LuaESMod ==
Download [http://mygamingtalk.com/forums/files/file/45-lua-enhanced-server-mod/ LuaESMod] and extract it to some temporary folder on your computer.
== Install ==
The Files/Folders you need are: ''LuaESMod.lua'' and the entire ''LESM'' folder.
 Upload those to your server's mod directory.
 Next you will need to go into your server config edit your ''lua_modules'' cvar to include ''LuaESMod.lua''
 Will look something like <code>set lua_modules "LuaESMod.lua"</code> or <code>set lua_modules "LuaESMod.lua test.lua testlua2.lua"</code>
 '''Note:''' If your server uses a seperate fs_homepath you will need to manually create the following directories: <pre>/fs_homepath/mod/LESM/
/fs_homepath/mod/LESM/save/
/fs_homepath/mod/LESM/extra/
/fs_homepath/mod/LESM/logs/</pre>
 Also you will need to make sure Commands.json is in /fs_homepath/mod/LESM/save/Commands.json
Basic rule of thumb is you keep only the '''.lua''' files in ''/fs_basepath/fs_game/'' and everything else can go into ''/fs_homepath/fs_game/''
== First Run ==
Restart/start your server.
 You can verify if the script is running by typing: <code>lua_status</code> in rcon
 If it is running then you can continue on to configuring the server.
 The configuration file is '''/LESM/save/Config.json''' you may edit values there. (See below for what the configuration values mean)
 If your config fails to load for some reason or there are keys that were missing, a '''ConfigDefaults.json''' will be created with your old values and new values. This file is just for you to read and copy to '''Config.json''' if you wish, it is not actually loaded ever.
 The most important values are Level.Leader and Level.Admin as this determines the level at which you can use some commands.
== Updating ==
If you are updating from a previous version it is basically the same thing as installing, you will overwrite all the lua files. There is ''Commands.json'' shipped with releases so the lua will know which commands were added. This only needs to be replaced if the new lua version adds a command, if it doesn't then you do not need to bother. If it does add a command but you have already edited your Commands.json and you do not want to lose your changes, you will need to find out which commands were added and add a section for each new command to your ''Commands.json''.
== Other Config Files ==
Other specific configuration files:
=== Colors ===
Colors are saved in '''/LESM/save/Colors.json''' If you want to change the color scheme you can that do that in this file. There are 3 keys in here you probably want to change to match your server's theme
 '''Primary''' Is your main message color, white is a safe bet, definitely don't use black as it is hard to see.
 '''Secondary''' Is the color used to highlight important information
 '''Tertiary''' Is used for symbols or brackets surrounding text
 The capital letter keys like LIGHT_BLUE are currently not used, in the future they may be used.
 The rest are command colors, used in the help command.
=== Banners ===
Banners are saved in '''/LESM/save/Banners.json''' See related config options [[#Banner | here]]
 If you want to use banners you will need to edit this file.
 Each message in a quote is a new banner.
 When making banner messages you can use <color1> to use your Color.Primary <color2> to use Color.Secondary and <color3> to use Color.Tertiary. You can still use normal color codes though if you wish.
 The beginning of the file must start with a [ and end of the file must end with ]
 Also every new message must end with , UNLESS it is the last one which ends with nothing
In the example will Color.Primary equals ^7 Color.Secondary equals ^5 and Color.Tertiary equals 2
So for example: <pre>[ "<color1>Registration <color2>required<color1> for xpsave and admin level<color3>!",
"<color1>Autolevel up to level <color2>600",
"<color3>/<color2>lua help<color1> to view all your commands<color3>!" ]</pre>
Means the messages are: <pre>^7Registration ^5required^7 for xpsave and admin level^2!
^7Autolevel up to level ^5600
^2/^5lua help^7 to view all your commands^5!</pre>
=== Rules ===
Rules are saved in '''/LESM/save/Rules.json'''
 If you want to use the rules command, or add rules to banners then you will need to edit this file.
 Same rules apply to Rules that apply to Banners
=== Sounds ===
Sounds are saved in '''/LESM/save/Sounds.json'''
 This file isn't meant to be created/edited manually.
 I package a python script that will create a Sounds.json from all the sounds in a pk3 named '''sounds.py'''
 If you do not know how to use a python script, post on forums with a link to your sounds pk3 I can easily get you setup.
 You can edit your sounds ingame with the [[LESM Commands#PlaySound | playsound ]] command
 <code>!playsound hello level 5</code> you need to be a leader of authorized to do this
=== Maps ===
Maps is just a list of your map vote pool and is found in '''/LESM/save/Maps.json'''
Will look something like this:
<pre>
[
"adlernest",
"oasis",
"frostbite"
]</pre>
To get info for this list type in rcon: '''dir maps bsp'''
 You can try manually creating this list. Or post on forums and we will create one for you.
=== Grammar/SwearFilter ===
Found in '''/LESM/save/Grammar.json''' and '''/LESM/save/SwearFilter.json'''
 Grammar is more of a spellcheck and is used when players have the ''grammarcheck'' key.
 SwearFilter replace swear words with less vulgar words.
== Commands ==
See [[LESM Commands | Commands]] for a list of commands.
 The '''/LESM/save/Commands.json''' file decides what command gets loaded, and who can use it. This file needs to be updated each time a new command is added in a new version. When it comes with the release package it only contains a list of paths to lua commands. After it LESM loads it will then update the Commands.json to include: '''auth force level load login''' keys. These keys you can toggle to control loading commands(Explained below).
=== load ===
If load is set to '''true''' the command will load if the conditions are right. Almost all commands will be loaded, except for certain ones on certain mods, for example: Admintest on silent mod, since silentmod already has admintest. If load is set to '''false''' then the command will not load no matter what. By default all the commands '''load''' will be set to '''true'''.
=== force ===
If force is set to '''true''' it will force the command to load even if the command isn't supposed to load(Like admintest in the above example). If set to '''false''' nothing special happens and it will continue on default behavior. If you force load a command it may produce odd results. By default all of the commands '''force''' are set to '''false'''.
=== level ===
Set this to the minimum level required to use this command, or set to 0 to allow everyone to use the command. By default this key is set to either 0, Config.Level.Admin, or Config.Level.Leader depending on the command on first run.
=== login ===
If login is set to '''true''' then you must be logged into a profile to use this command. If set to '''false''' you are not required to be logged in. The default value for this depends on the command.
=== auth ===
If auth is set to '''true''' then you must be logged into a profile '''and''' have the '''authorize''' profile key set to '''true''' to use this command. The default value for this depends on the command.
=== path ===
Path is the path to the lua command file relative to '''/fs_homepath/fs_game/'''
=== Examples ===
Let's say for example you want to give all your admins level 5 and up access to the ammo command. What I changed here from default is I set login and auth to false, and set level to 5.
<pre>{
"auth": false,
"force": false,
"level": 5,
"load": true,
"login": false,
"path": "LESM/commands/ammo.lua"
}</pre>
 Now let us say we do not like the afk command, so we want to disable the afk and back command.
So we simply change load to false in both commmands: <pre>
{
"auth": false,
"force": false,
"level": 0,
"load": false,
"login": false,
"path": "LESM/commands/afk.lua"
}, {
"auth": false,
"force": false,
"level": 0,
"load": false,
"login": false,
"path": "LESM/commands/back.lua"
}</pre>
If you want more examples I can do them. Please request.
== Config ==
Found in '''/LESM/save/Config.json''' saves all your config keys it can be edited directly or from ingame. If you are editing ingame with the config commmand you need to use <code>!config save</code> after you have made your changes. Also the config only gets loaded when map restarts, this means if you change the file directly, and then go ingame and type use <code>!config save</code> your changes will be overwritten by what is currently loaded on the server. Now on to the keys
=== AdminWatchConsole ===
If enabled will send adminwatch messages to console print(So it will show up in server log and similar stuff). Only really useful for when you have access to direct server console output.
 '''Values:''' ''true'' or ''false''
=== BlockNoSilentFlag ===
If the player does not have the silent command flag '''3''' it will block silent commands that output messages to everyone, such as !afk and !me. For example it will block <code>/me Slaps players</code> & <code>/!me Slaps player</code> & <code>/lua me Slaps player</code>. But it will still allow commands to be used in chat: <code>!me slaps player</code>
 '''Values:''' ''true'' or ''false''
=== ConvertNoSilentFlag ===
If the player does not have the silent command flag '''3''' it will convert command to a chat command if enabled. Example: <code>/me Slaps player</code> turns into <code>!me Slaps player</code> in the global chat.
 '''Values:''' ''true'' or ''false''
=== ClassHPMax ===
Experimental, only works on silent mod. If enabled it will take the value defined in '''/LESM/extra/Classes.json''' for each class and make it their maximum health.
 '''Values:''' ''true'' or ''false''
=== ClassHPRegen ===
Experimental, only works on silent mod. If enabled it will take the value defined in '''/LESM/extra/Classes.json''' for each class and regenerate that amount of health each second.
 '''Values:''' ''true'' or ''false''
=== DamagePrint ===
Experimental, only works on silent mod. Allows players to see how much damage they are taking each hit.
 '''Warning''' this enabled g_debugBullets which spams the console log with a lot of messages(each hit), use at own risk.
 On legacy this feature is greatly expanded with more info on each hit, hopefully silent mod will soon bring et_Damage callback for this feature.
 '''Values:''' ''true'' or ''false''
=== DisplayRegister ===
Displays information on how to register and why to register when player connects.
 '''Values:''' ''true'' or ''false''
=== EncryptSha1 ===
Uses sha1 for passwords and other similar things. Downside adds about 3/4 a second to load time, upside is no one is gonna figure out the passwords. If not enabled uses a weak string jumbler instead.
 '''Values:''' ''true'' or ''false''
=== FreezeStart ===
Uses lua to force clients into the same position for '''FreezeStartTime''' seconds, will also add that time onto the timelimit so no time is lost. Useful to allow clients with bad computers or connections to start at the same time as everyone else. Also prevents bots from being 60 feet ahead at beginning of map.
 '''Values:''' ''true'' or ''false''
=== FreezeStartTime ===
Seconds to remain frozen at map start. My suggestion is around 8.
 '''Values:''' ''number''
=== PauseStart ===
Similar to '''FreezeStart'''. This will pause the game and immediately unpause the game at the start of the map, so no one can get an unfair start. Disadvantages to this one is that you can't tweak the time paused.
 '''Values:''' ''true'' or ''false''
=== MapEnts ===
Enables the map entity functions, for disabling objectives.
 '''Values:''' ''true'' or ''false''
=== MapListStart ===
Number to determine where your nextmap variables start. (Usually 1) if in your mapcycle.cfg you have vstr d1 at the end then set this value to '''1'''.
 '''Values:''' ''number''
=== MapListVarName ===
Variable name to determine where your nextmap variables start. (Usually d) if in your mapcycle.cfg you have vstr d1 at the end then set this value to '''d'''.
 '''Values:''' ''string''
=== MaxReports ===
Number of allowed reports (Through the /report command) per game.
 '''Values:''' ''number''
=== ReportToMail ===
Whether or not reports should report to admin mail(Only players with '''Config.Level.Admin''' level and plus can read). If not enabled then reports will save in a json format in '''/LESM/save/''' directory.
 '''Values:''' ''true'' or ''false''
=== MetricDistance ===
Whether or not to use metric distance by default in distance output. (Users can change this them self with the metricdistance profile key)
 '''Values:''' ''true'' or ''false''
=== MinNameLength ===
Minmum name length before getting renamed to a random name.
 '''Values:''' ''number''
=== Rename ===
A list of names to be automatically renamed to a random name.
Example: <code>"Rename": [ "ETPlayer", "UnnamedPlayer" ],</code>
 '''Values:''' ''list''
=== SetLevelMax ===
Maximum allowed level distance allowed to promote to. Example: If this were '''2''' and you were level ''10'' you could only promote to level ''8''.
 '''Values:''' ''number''
=== ShrubCommandFix ===
A temporary bug fix for using certain shrub commands alongside lua commands of the same name. Shouldn't need this, unless told.
 '''Values:''' ''list''
=== SpamProtect ===
Amount of time in seconds (float value) that must pass before using another command.
 '''Values:''' ''float number''
=== SpawnWalkthrough ===
If enabled players spawning (Only from spawn, not revive) will be able to walk through players for as long as they have their spawn shield.
 Works with g_spawnInvulFair
 '''Values:''' ''true'' or ''false''
=== Spec999 ===
Amount of seconds to pass after map has started to check if clients that have no ping/are downloading still should be moved spec.
 Set to 0 to disable.
 '''Values:''' ''number''
=== TeamBlock ===
Amount of seconds to pass before blocking the team command. To be used with '''TeamBlockMultiplier'''. If a certain player is switch a lot their teamblock will keep getting larger until eventually it will take 10-60 seconds before they can switch team again. This prevents players from constantly switching to the better team, if configured correctly.
 Resets each map. Set to 0.0 to disable.
 '''Values:''' ''float number''
=== TeamBlockMultiplier ===
Amount to multiply '''TeamBlock''' by. Suggested is between 1.0 and 3.0.
 Set to 0.0 to disable.
 '''Values:''' ''float number''
=== AutoLevel ===
----
==== Enabled ====
Whether or not to use the autolevel feature.
 '''Values:''' ''true'' or ''false''
==== StartLevel ====
The first level to start the autolevel. Players will get this level when they reach ''XPBase'' xp.
 '''Values:''' ''number''
==== EndLevel ====
Last level autolevel levels to.
 '''Values:''' ''number''
==== NoSetLevel ====
Whether or not to allow admins with lower than ''Config.Level.Leader'' to setlevel people in the autolevel range.
 '''Values:''' ''true'' or ''false''
==== RequireLogin ====
Require player to be logged in to get automatically leveled.
 '''Values:''' ''true'' or ''false''
==== XPBase ====
The base xp to start the autolevel. Players will get ''StartLevel'' when they reach this.
 '''Values:''' ''float number''
==== XPModifier ====
The amount to multiply ''XPBase'' by for levels after ''StartLevel''. Example:
<pre>XPBase: 500 , XPModifier: 1.75 , StartLevel: 1 , EndLevel: 5
Level 1: 500 , Level 2: 875 , Level 3: 1531 , Level 4: 2679 , Level 5: 4689</pre>
 '''Values:''' ''float number''
=== Balance ===
----
Balance only moves the player switching to a team, it will not move anyone who was already on the team. That is still being worked on as another feature.
 Some actions can be combined, for example: ''PutSpec'' and ''BlockTeam''
==== Enabled ====
Whether or not to use the balance feature.
 '''Values:''' ''true'' or ''false''
==== CountBots ====
Whether or not to count bots into the balance calculation. Example: 4 players 1 bot on axis vs 1 player 4 bots on allies would still be considered fair, if enabled.
 '''Values:''' ''true'' or ''false''
==== MaxSwitches ====
Maximum amount of switches before action is taken. There will be two ''warning messages'' given prior to the action taken, if ''MaxSwitches'' is set high enough. Example: MaxSwitches: 2 Switch to unbalanced team 1: Please do not switch to the stacked team.
 Switch to unbalanced team 1: **WARNING** If you switch again action will be taken
 (Action taken here)
 '''Values:''' ''number''
==== PutSpec ====
(Action) Will put the player spectator when ''MaxSwitches'' is reached.
 '''Values:''' ''true'' or ''false''
==== BlockTeam ====
Will block the team command (Command used to switch teams) for this round.
 '''Values:''' ''true'' or ''false''
==== BlacklistTime ====
Will blacklist(kick/ban) a user for the specified time.
 Time format is: 1 for 1 second, 1m for 1 minute, 1h for 1 hour, 1d for 1 day, 1o for 1 month
 Set to 0 to not kick.
 Set below 0 to permanently ban.
 '''Values:''' ''timeformat''
==== KickReason ====
Message to be given to players that get blacklisted.
 '''Values:''' ''string''
==== ExcludeOnline ====
Exclude people who are logged in from balance actions.
 '''Values:''' ''true'' or ''false''
==== ExcludeAuth ====
Exclude authorized users from balance actions.
 '''Values:''' ''true'' or ''false''
==== ExcludeLevel ====
Exclude players with at least this level from balance actions.
 '''Values:''' ''number''
=== Banner ===
----
==== Enabled ====
Whether or not banners are enabled.
 '''Values:''' ''true'' or ''false''
==== Delay ====
The delay between banner prints in seconds.
 '''Values:''' ''number''
==== AddRules ====
Whether or not to add the rules to the banners as well.
 '''Values:''' ''true'' or ''false''
==== Random ====
Whether or not to randomize the order in which the banners are printed.
 '''Values:''' ''true'' or ''false''
==== Location ====
The location in which to print the banners.
 '''Values:''' ''print bannerprint centerprint chat echo printclean bannerprintclean centerprintclean chatclean echoclean''
=== Blacklist ===
----
==== AllowIfAuth ====
Allow blacklisted users to connect if there is an authorized user online.
 '''Values:''' ''true'' or ''false''
==== AllowIfLeader ====
Allow blacklisted users to connect if there is a leader online.
 '''Values:''' ''true'' or ''false''
=== ClanTag ===
----
==== Enabled ====
Whether or not to enable clantag protection.
 '''Values:''' ''true'' or ''false''
==== Level ====
Level in which your tag is ok to be used. Example: Level 3 and below will be warned if set to 4.
 '''Values:''' ''number''
==== MaxRenames ====
Maximum amount of renames before action is taken.
 Set to 0 to take action right away.
 '''Values:''' ''number''
==== Exact ====
Whether or not to use exact match (including color codes). If false it will clear ignore case and color codes.
 '''Values:''' ''true'' or ''false''
==== Tags ====
List of tags to protect. Example: <code>[ "TT|", "(TT)", "xTTx" ],</code>
 '''Values:''' ''string list''
==== BlacklistTime ====
(Action) Blacklists user for specified time format when ''MaxRenames'' is reached.
 Time format is: 1 for 1 second, 1m for 1 minute, 1h for 1 hour, 1d for 1 day, 1o for 1 month
 Set to 0 to not kick.
 Set below 0 to permanently ban.
 '''Values:''' ''timeformat''
==== Warn ====
Will warn the user when ''MaxRenames'' is reached.
 '''Values:''' ''true'' or ''false''
==== Message ====
Message to be used in the warn or blacklist
 '''Values:''' ''string''
=== ConnectPrint ===
----
==== Location ====
Location where to print the message.
 '''Values:''' ''print bannerprint centerprint chat echo printclean bannerprintclean centerprintclean chatclean echoclean''
==== Bots ====
Will show connect print for bots.
 '''Values:''' ''true'' or ''false''
==== Ip ====
Will show a partial ip.
 '''Values:''' ''true'' or ''false''
==== Name ====
Will show name.
 '''Values:''' ''true'' or ''false''
==== Username ====
Will show username if autologged in. Required ''Name''
 '''Values:''' ''true'' or ''false''
==== Country ====
Will show country of connecting user if exist.
 '''Values:''' ''true'' or ''false''
==== ETVersion ====
Will show ET Version if exists.
 '''Values:''' ''true'' or ''false''
==== Protocol ====
Will show protocol(2.55,2.56,2.60,2.60b) if exists.
 '''Values:''' ''true'' or ''false''
==== Level ====
Will show level.
 '''Values:''' ''true'' or ''false''
=== DeathPrint ===
----
==== Location ====
Location where to print the message.
 '''Values:''' ''print bannerprint centerprint chat echo printclean bannerprintclean centerprintclean chatclean echoclean''
==== Distance ====
Print distance from killer.
 '''Values:''' ''true'' or ''false''
==== Name ====
Print killer name.
 '''Values:''' ''true'' or ''false''
==== Hp ====
Print killer hp.
 '''Values:''' ''true'' or ''false''
=== Debug ===
There are many debug values, you shouldn't ever need them, they will spam your console log.
=== DynamiteCounter ===
----
==== Enabled ====
 '''Values:''' ''true'' or ''false''
==== CountDown ====
List of times when to print the current time till detonation. Example: <code>[ 20, 10, 5, 3, 2, 1 ],</code>
 '''Values:''' ''number list''
==== Location ====
Location where to print the message.
 '''Values:''' ''print bannerprint centerprint chat echo printclean bannerprintclean centerprintclean chatclean echoclean''
==== PrintAll ====
If enabled it will print to all teams. If not enabled it will only print to the team that planted the dynamite.
 '''Values:''' ''true'' or ''false''
==== Plant ====
Print a message when dynamite gets planted.
 '''Values:''' ''true'' or ''false''
==== Defuse ====
Print a message when dynamite gets defused.
 '''Values:''' ''true'' or ''false''
==== Explode ====
Print a message when dynamite explodes.
 '''Values:''' ''true'' or ''false''
=== Intermission ===
----
==== BlockSpec ====
Blocks spectators from voting for a map.
 '''Values:''' ''true'' or ''false''
==== Mute ====
Blocks muted playersfrom voting for a map.
 '''Values:''' ''true'' or ''false''
==== ReadyMessage ====
Prints a message when a player is ready during intermission.
 '''Values:''' ''true'' or ''false''
==== VoteMessage ====
Prints a message when a player votes for a map during intermission.
 '''Values:''' ''true'' or ''false''
==== PrintBoth ====
If enabled prints both ready and vote messages separately. If not enabled it will wait until the player both votes and is ready before printing a message.
 '''Values:''' ''true'' or ''false''
==== RequireLevel ====
Requires level to vote for a map.
 '''Values:''' ''number''
==== RequireLogin ====
Requires to be logged into a profile to vote for a map.
 '''Values:''' ''true'' or ''false''
=== JSON ===
----
Paths to each of the JSON files.
=== Karma ===
----
==== Consecutive ====
Number of consecutive karma actions to one player allowed.
 '''Values:''' ''number''
==== Time ====
Time required to pass before taking another karma action.
 '''Values:''' ''timeformat''
=== Level ===
----
==== Admin ====
The level your admin starts(Admin meaning they are apart of your clan)
 '''Values:''' ''number''
==== Admin ====
The level your leader status starts
 '''Values:''' ''number''
=== Log ===
----
==== Colors ====
Keep colors in the logs.
 '''Values:''' ''true'' or ''false''
==== Full ====
Do a full log message output. This is easier to read manually, but harder for scripts to parse.
 '''Values:''' ''true'' or ''false''
==== OneFile ====
Output all log to one file. If not enabled it will separate logs by day.
 '''Values:''' ''true'' or ''false''
=== Message ===
----
==== ColorReplace ====
Allow to replace <color1> 2 and 3 in messages and chat.
 '''Values:''' ''true'' or ''false''
==== NameMentions====
Allow to use @name and @last in messages and chat.
 '''Values:''' ''true'' or ''false''
==== EventMentions ====
Allow to replace <event> with certain info.
 Work in progress feature, doesn't work well at the moment.
 Events: <code><killer><victim><heal><revive><name><weapon><ip><guid><ammo></code>
 '''Values:''' ''true'' or ''false''
==== GrammarCheck ====
Force grammarcheck globally.
 '''Values:''' ''true'' or ''false''
==== NoCaps ====
Force nocaps globally.
 '''Values:''' ''true'' or ''false''
==== NoColors ====
Force nocolors globally.
 '''Values:''' ''true'' or ''false''
==== SwearFilter ====
Force swearfilter globally.
 '''Values:''' ''true'' or ''false''
==== Format ====
Format in which messages are printed. Useful to keep a color scheme or style to all your messages.
 Example: <code><color3><<color2>< <color1><message> <color2>><color3>></code>
 Looks like: << Message here >>
 '''Values:''' ''string''
==== TableSymbol ====
Symbol to use for table border.
 Note: Use only one character!
 '''Values:''' ''character''
==== TableColor ====
Color of table symbol. Suggested: <color3>
 '''Values:''' ''color''
=== PingMonitor ===
----
Ping Monitor will add the players current ping to a list and then take the average of that list. If the average is over ''Ping'' then action will be taken. Ping checks happen about every 10 seconds. Player must be in a team for it to check.
==== Ping ====
Action will be taken when the average ping after ''MinChecks'' ping checks.
 Set above 1000 to disable.
 '''Values:''' ''number''
==== MinChecks ====
Number of times ping must be checked before
 '''Values:''' ''number''
==== BlacklistTime ====
(Action) The amount of time the player will be blacklisted for.
 Set to 0 to not blacklist.
 Set below 0 for permanent blacklist.
 '''Values:''' ''timeformat''
==== Warn ====
(Action) Warn the player with ''Message''
 '''Values:''' ''true'' or ''false''
==== Spec ====
(Action) Puts the player spectator.
 '''Values:''' ''true'' or ''false''
==== Message ====
Message to be sent when blacklisting and warning.
 '''Values:''' ''string''
=== Prefix ===
----
==== Chat ====
Prefix for commands done in chat.
 Example if set to '''!''': <code>!help</code>
 I don't recommend changing this as it is used to hook itself into shrubbot.
 '''Values:''' ''string''
==== Admin ====
Prefix for commands done in console.
 Example if set to '''!''': <code>/!help</code>
 I don't recommend changing this as it is used to hook itself into shrubbot.
 '''Values:''' ''string''
==== Lua ====
Prefix for lua commands done in console.
 Example if set to '''lua''': <code>/lua help</code>
 '''Values:''' ''string''
==== Auth ====
Prefix for authorized lua commands done in console.
 Example if set to '''sudo''': <code>/sudo help</code>
 '''auth''' is used by silent mod, so be careful if you set it to '''auth''' it could break silent mod functionality.
 '''Values:''' ''string''
==== Mail ====
Prefix for mail commands done in console.
 Example if set to '''mail''': <code>/mail inbox</code>
 '''Values:''' ''string''
=== Profile ===
----
==== AutoCreate ====
Automatically creates a profile for every player that joins.
 '''Values:''' ''true'' or ''false''
==== ForceRegister ====
If enabled players will need to register a profile before they are able to join a team.
 '''Values:''' ''true'' or ''false''
==== RequireBoth ====
If enabled this will require an ip and a guid to match to automatically be logged in.
 '''Values:''' ''true'' or ''false''
==== MaxIp ====
Maximum amount of profiles allowed on one ip.
 '''Values:''' ''number''
==== MaxGuid ====
Maximum amount of profiles allowed on one guid.
 '''Values:''' ''number''
==== Greetings ====
Allow users with profiles to customize their own greeting message. (For when they connect)
 '''Values:''' ''true'' or ''false''
==== Farewells ====
Allow users with profiles to customize their own farewell message. (For when they disconnect)
 '''Values:''' ''true'' or ''false''
==== SoundGreetings ====
Allow users with profiles to choose a sound (From the playsound list) to play when they connect.
 '''Values:''' ''true'' or ''false''
==== SoundFarewells ====
Allow users with profiles to choose a sound (From the playsound list) to play when they disconnect.
 '''Values:''' ''true'' or ''false''
==== Location ====
Default location for greeting and farewell messages.
 '''Values:''' ''location''
=== Sound ===
----
I package a small soundpack with the release that you can use if you want, it is not required. You can make your own soundpack if you wish.
 Sounds marked with ''(Local)'' Only play to the client the event happens to.
 Sounds marked with ''(Global)'' Play to all clients on the server.
 Set to <nowiki>""</nowiki> if you want to disable.
==== Enabled ====
Global value to enable or disable all sounds made by LESM.
 '''Values:''' ''true'' or ''false''
==== AdminWatch ====
(Local) Will play a sound when an adminwatch message is received when user has ''adminwatchsound'' profile key.
 '''Values:''' ''path''
==== Afk ====
(Global) Plays when a user goes away.
 '''Values:''' ''path''
==== Return ====
(Global) Plays when a user returns from being away.
 '''Values:''' ''path''
==== AutoLevel ====
(Global) Plays when a user is automatically leveled up.
 '''Values:''' ''path''
==== BlackList ====
(Local) Plays to authorized and leaders users when a blacklisted player trys to connect.
 '''Values:''' ''path''
==== Hello ====
(Global) Plays when the '''hi''' lua command is used.
 '''Values:''' ''path''
==== Bye ====
(Global) Plays when the '''bye''' lua command is used.
 '''Values:''' ''path''
==== Welcome ====
(Global) Plays when the '''welcome''' lua command is used.
 '''Values:''' ''path''
==== Salute ====
(Global) Plays when the '''salute''' lua command is used.
 '''Values:''' ''path''
==== Connect ====
(Global) Plays when a client connects for the first time.
 '''Values:''' ''path''
==== Disconnect ====
(Global) Plays when a client disconnects.
 '''Values:''' ''path''
==== Command ====
(Local) Plays when a command is executed.
 '''Values:''' ''path''
==== Error ====
(Local) Plays when an error is encountered in a command.
 '''Values:''' ''path''
==== KillConfirm ====
(Local) Plays when you get a kill. (To confirm that you did kill the player)
 '''Values:''' ''path''
==== TeamKillConfirm ====
(Local) Plays when you get a teamkill.
 '''Values:''' ''path''
==== Login ====
(Local) Plays when you use the login command to login.
 '''Values:''' ''path''
==== Logout ====
(Local) Plays when you use the logout command to logout.
 '''Values:''' ''path''
==== Register ====
(Local) Plays when you register a new account.
 '''Values:''' ''path''
==== NewMail ====
(Local) Plays when you receive a new ingame mail message.
 '''Values:''' ''path''
==== PrivateMessage ====
(Local) Plays when you receive an ingame privatemessage.
 '''Values:''' ''path''
==== Mention ====
(Local) Plays when you are mentioned in a command or chat.
 TODO
 '''Values:''' ''path''
==== Warn ====
(Local) Plays when you are warned by LESM.
 '''Values:''' ''path''
=== Vote ===
----
==== Mute ====
If enabled you cannot call votes while muted.
 '''Values:''' ''true'' or ''false''
==== Mute ====
If enabled you cannot call votes unless you are logged into a profile.
 '''Values:''' ''true'' or ''false''
==== RequireLevel ====
Requires specified level to call a vote.
 '''Values:''' ''number''
=== Warn ===
----
==== Shrubbot ====
Use shrubbot warns when LESM automatically warns someone.
 If set the rest of the options do not matter.
 '''Values:''' ''true'' or ''false''
==== AllowNoReason ====
Allow warnings with no reason.
 '''Values:''' ''true'' or ''false''
==== Mail ====
All warnings will go to admin-mail.
 '''Values:''' ''true'' or ''false''
==== RemoveLast ====
Removes last warning when ''Max'' warnings is reached.
 '''Values:''' ''true'' or ''false''
==== Max ====
Maximum amount of warns before action is taken.
 '''Values:''' ''number''
==== Expires ====
How long a warning lasts before it expires.
 '''Values:''' ''timeformat''
==== BlacklistTime ====
(Action) Time for client to be blacklisted when ''Max'' warnings is reached.
 Set to '''0''' to not blacklist.
 Set to '''-1''' to permanently blacklist.
 '''Values:''' ''timeformat''
=== XpSave ===
----
Only recommended for mods that do not have their own xpsave system.
==== Enabled ====
Enable LESM xpsave.
 '''Values:''' ''true'' or ''false''
==== RequireLogin ====
Require client to be logged in to save XP.
 '''Values:''' ''true'' or ''false''
==== Bots ====
Save bots xp as well.
 '''Values:''' ''true'' or ''false''
==== Expire ====
Time in seconds for when the xp will expire when there is no activity.
 Set to 0 to never expire.
 '''Values:''' ''number''
==== Expire ====
Time in seconds for when the xp will start to decay when there is no activity.
 Set to 0 to never decay.
 '''Values:''' ''number''
==== DecayMin ===
The minimum amount of xp to decay to.
 '''Values:''' ''number''
==== DecayRate ===
The rate at which xp decays each skill per second.
 '''Values:''' ''float number''

LESM Installation

2015-05-03T06:07:31Z

Zelly: Config Options

== Lua Enhanced Server Mod Install Guide ==
This guide will teach you how to install LESM on your server. Please read it carefully.
 When I refer to the server's mod directory I mean:
 '''/etdirectory/mod/''' Your qagame.mp.i386.so or qagame.mp.i386.dll will be in this directory.
 Example: ''/home/et/silent/''
 When I refer to the '''/LESM/''' directory that is inside your server's mod directory.
 Example: ''/home/et/silent/LESM/''
 JSON Files(files ending in ''.json'') can be picky when editing them, you can use [http://jsonformatter.curiousconcept.com/ jsonformatter] to ensure you have valid JSON format, if they are not valid it will cause errors.
== Requirements ==
The only requirement is that you have lua 5.1 installed on your server. For silent mod, it comes with the mod and you do not need to make any further adjustments. For other mods you will need to follow their instructions on how to install it. Usually it just requires you to download the lua 5.1 library, and using a specific qagame.
== Download LuaESMod ==
Download [http://mygamingtalk.com/forums/files/file/45-lua-enhanced-server-mod/ LuaESMod] and extract it to some temporary folder on your computer.
== Install ==
The Files/Folders you need are: ''LuaESMod.lua'' and the entire ''LESM'' folder.
 Upload those to your server's mod directory.
 Next you will need to go into your server config edit your ''lua_modules'' cvar to include ''LuaESMod.lua''
 Will look something like <code>set lua_modules "LuaESMod.lua"</code> or <code>set lua_modules "LuaESMod.lua test.lua testlua2.lua"</code>
 '''Note:''' If your server uses a seperate fs_homepath you will need to manually create the following directories: <pre>/fs_homepath/mod/LESM/
/fs_homepath/mod/LESM/save/
/fs_homepath/mod/LESM/extra/
/fs_homepath/mod/LESM/logs/</pre>
 Also you will need to make sure Commands.json is in /fs_homepath/mod/LESM/save/Commands.json
Basic rule of thumb is you keep only the '''.lua''' files in ''/fs_basepath/fs_game/'' and everything else can go into ''/fs_homepath/fs_game/''
== First Run ==
Restart/start your server.
 You can verify if the script is running by typing: <code>lua_status</code> in rcon
 If it is running then you can continue on to configuring the server.
 The configuration file is '''/LESM/save/Config.json''' you may edit values there. (See below for what the configuration values mean)
 If your config fails to load for some reason or there are keys that were missing, a '''ConfigDefaults.json''' will be created with your old values and new values. This file is just for you to read and copy to '''Config.json''' if you wish, it is not actually loaded ever.
 The most important values are Level.Leader and Level.Admin as this determines the level at which you can use some commands.
== Updating ==
If you are updating from a previous version it is basically the same thing as installing, you will overwrite all the lua files. There is ''Commands.json'' shipped with releases so the lua will know which commands were added. This only needs to be replaced if the new lua version adds a command, if it doesn't then you do not need to bother. If it does add a command but you have already edited your Commands.json and you do not want to lose your changes, you will need to find out which commands were added and add a section for each new command to your ''Commands.json''.
== Other Config Files ==
Other specific configuration files:
=== Colors ===
Colors are saved in '''/LESM/save/Colors.json''' If you want to change the color scheme you can that do that in this file. There are 3 keys in here you probably want to change to match your server's theme
 '''Primary''' Is your main message color, white is a safe bet, definitely don't use black as it is hard to see.
 '''Secondary''' Is the color used to highlight important information
 '''Tertiary''' Is used for symbols or brackets surrounding text
 The capital letter keys like LIGHT_BLUE are currently not used, in the future they may be used.
 The rest are command colors, used in the help command.
=== Banners ===
Banners are saved in '''/LESM/save/Banners.json''' See related config options [[#Banner | here]]
 If you want to use banners you will need to edit this file.
 Each message in a quote is a new banner.
 When making banner messages you can use <color1> to use your Color.Primary <color2> to use Color.Secondary and <color3> to use Color.Tertiary. You can still use normal color codes though if you wish.
 The beginning of the file must start with a [ and end of the file must end with ]
 Also every new message must end with , UNLESS it is the last one which ends with nothing
In the example will Color.Primary equals ^7 Color.Secondary equals ^5 and Color.Tertiary equals 2
So for example: <pre>[ "<color1>Registration <color2>required<color1> for xpsave and admin level<color3>!",
"<color1>Autolevel up to level <color2>600",
"<color3>/<color2>lua help<color1> to view all your commands<color3>!" ]</pre>
Means the messages are: <pre>^7Registration ^5required^7 for xpsave and admin level^2!
^7Autolevel up to level ^5600
^2/^5lua help^7 to view all your commands^5!</pre>
=== Rules ===
Rules are saved in '''/LESM/save/Rules.json'''
 If you want to use the rules command, or add rules to banners then you will need to edit this file.
 Same rules apply to Rules that apply to Banners
=== Sounds ===
Sounds are saved in '''/LESM/save/Sounds.json'''
 This file isn't meant to be created/edited manually.
 I package a python script that will create a Sounds.json from all the sounds in a pk3 named '''sounds.py'''
 If you do not know how to use a python script, post on forums with a link to your sounds pk3 I can easily get you setup.
 You can edit your sounds ingame with the [[LESM Commands#PlaySound | playsound ]] command
 <code>!playsound hello level 5</code> you need to be a leader of authorized to do this
=== Maps ===
Maps is just a list of your map vote pool and is found in '''/LESM/save/Maps.json'''
Will look something like this:
<pre>
[
"adlernest",
"oasis",
"frostbite"
]</pre>
To get info for this list type in rcon: '''dir maps bsp'''
 You can try manually creating this list. Or post on forums and we will create one for you.
=== Grammar/SwearFilter ===
Found in '''/LESM/save/Grammar.json''' and '''/LESM/save/SwearFilter.json'''
 Grammar is more of a spellcheck and is used when players have the ''grammarcheck'' key.
 SwearFilter replace swear words with less vulgar words.
== Commands ==
See [[LESM Commands | Commands]] for a list of commands.
 The '''/LESM/save/Commands.json''' file decides what command gets loaded, and who can use it. This file needs to be updated each time a new command is added in a new version. When it comes with the release package it only contains a list of paths to lua commands. After it LESM loads it will then update the Commands.json to include: '''auth force level load login''' keys. These keys you can toggle to control loading commands(Explained below).
=== load ===
If load is set to '''true''' the command will load if the conditions are right. Almost all commands will be loaded, except for certain ones on certain mods, for example: Admintest on silent mod, since silentmod already has admintest. If load is set to '''false''' then the command will not load no matter what. By default all the commands '''load''' will be set to '''true'''.
=== force ===
If force is set to '''true''' it will force the command to load even if the command isn't supposed to load(Like admintest in the above example). If set to '''false''' nothing special happens and it will continue on default behavior. If you force load a command it may produce odd results. By default all of the commands '''force''' are set to '''false'''.
=== level ===
Set this to the minimum level required to use this command, or set to 0 to allow everyone to use the command. By default this key is set to either 0, Config.Level.Admin, or Config.Level.Leader depending on the command on first run.
=== login ===
If login is set to '''true''' then you must be logged into a profile to use this command. If set to '''false''' you are not required to be logged in. The default value for this depends on the command.
=== auth ===
If auth is set to '''true''' then you must be logged into a profile '''and''' have the '''authorize''' profile key set to '''true''' to use this command. The default value for this depends on the command.
=== path ===
Path is the path to the lua command file relative to '''/fs_homepath/fs_game/'''
=== Examples ===
Let's say for example you want to give all your admins level 5 and up access to the ammo command. What I changed here from default is I set login and auth to false, and set level to 5.
<pre>{
"auth": false,
"force": false,
"level": 5,
"load": true,
"login": false,
"path": "LESM/commands/ammo.lua"
}</pre>
 Now let us say we do not like the afk command, so we want to disable the afk and back command.
So we simply change load to false in both commmands: <pre>
{
"auth": false,
"force": false,
"level": 0,
"load": false,
"login": false,
"path": "LESM/commands/afk.lua"
}, {
"auth": false,
"force": false,
"level": 0,
"load": false,
"login": false,
"path": "LESM/commands/back.lua"
}</pre>
If you want more examples I can do them. Please request.
== Config ==
Found in '''/LESM/save/Config.json''' saves all your config keys it can be edited directly or from ingame. If you are editing ingame with the config commmand you need to use <code>!config save</code> after you have made your changes. Also the config only gets loaded when map restarts, this means if you change the file directly, and then go ingame and type use <code>!config save</code> your changes will be overwritten by what is currently loaded on the server. Now on to the keys
=== AdminWatchConsole ===
If enabled will send adminwatch messages to console print(So it will show up in server log and similar stuff). Only really useful for when you have access to direct server console output.
 '''Values:''' ''true'' or ''false''
=== BlockNoSilentFlag ===
If the player does not have the silent command flag '''3''' it will block silent commands that output messages to everyone, such as !afk and !me. For example it will block <code>/me Slaps players</code> & <code>/!me Slaps player</code> & <code>/lua me Slaps player</code>. But it will still allow commands to be used in chat: <code>!me slaps player</code>
 '''Values:''' ''true'' or ''false''
=== ConvertNoSilentFlag ===
If the player does not have the silent command flag '''3''' it will convert command to a chat command if enabled. Example: <code>/me Slaps player</code> turns into <code>!me Slaps player</code> in the global chat.
 '''Values:''' ''true'' or ''false''
=== ClassHPMax ===
Experimental, only works on silent mod. If enabled it will take the value defined in '''/LESM/extra/Classes.json''' for each class and make it their maximum health.
 '''Values:''' ''true'' or ''false''
=== ClassHPRegen ===
Experimental, only works on silent mod. If enabled it will take the value defined in '''/LESM/extra/Classes.json''' for each class and regenerate that amount of health each second.
 '''Values:''' ''true'' or ''false''
=== DamagePrint ===
Experimental, only works on silent mod. Allows players to see how much damage they are taking each hit.
 '''Warning''' this enabled g_debugBullets which spams the console log with a lot of messages(each hit), use at own risk.
 On legacy this feature is greatly expanded with more info on each hit, hopefully silent mod will soon bring et_Damage callback for this feature.
 '''Values:''' ''true'' or ''false''
=== DisplayRegister ===
Displays information on how to register and why to register when player connects.
 '''Values:''' ''true'' or ''false''
=== EncryptSha1 ===
Uses sha1 for passwords and other similar things. Downside adds about 3/4 a second to load time, upside is no one is gonna figure out the passwords. If not enabled uses a weak string jumbler instead.
 '''Values:''' ''true'' or ''false''
=== FreezeStart ===
Uses lua to force clients into the same position for '''FreezeStartTime''' seconds, will also add that time onto the timelimit so no time is lost. Useful to allow clients with bad computers or connections to start at the same time as everyone else. Also prevents bots from being 60 feet ahead at beginning of map.
 '''Values:''' ''true'' or ''false''
=== FreezeStartTime ===
Seconds to remain frozen at map start. My suggestion is around 8.
 '''Values:''' ''number''
=== PauseStart ===
Similar to '''FreezeStart'''. This will pause the game and immediately unpause the game at the start of the map, so no one can get an unfair start. Disadvantages to this one is that you can't tweak the time paused.
 '''Values:''' ''true'' or ''false''
=== MapEnts ===
Enables the map entity functions, for disabling objectives.
 '''Values:''' ''true'' or ''false''
=== MapListStart ===
Number to determine where your nextmap variables start. (Usually 1) if in your mapcycle.cfg you have vstr d1 at the end then set this value to '''1'''.
 '''Values:''' ''number''
=== MapListVarName ===
Variable name to determine where your nextmap variables start. (Usually d) if in your mapcycle.cfg you have vstr d1 at the end then set this value to '''d'''.
 '''Values:''' ''string''
=== MaxReports ===
Number of allowed reports (Through the /report command) per game.
 '''Values:''' ''number''
=== ReportToMail ===
Whether or not reports should report to admin mail(Only players with '''Config.Level.Admin''' level and plus can read). If not enabled then reports will save in a json format in '''/LESM/save/''' directory.
 '''Values:''' ''true'' or ''false''
=== MetricDistance ===
Whether or not to use metric distance by default in distance output. (Users can change this them self with the metricdistance profile key)
 '''Values:''' ''true'' or ''false''
=== MinNameLength ===
Minmum name length before getting renamed to a random name.
 '''Values:''' ''number''
=== Rename ===
A list of names to be automatically renamed to a random name.
Example: <code>"Rename": [ "ETPlayer", "UnnamedPlayer" ],</code>
 '''Values:''' ''list''
=== SetLevelMax ===
Maximum allowed level distance allowed to promote to. Example: If this were '''2''' and you were level ''10'' you could only promote to level ''8''.
 '''Values:''' ''number''
=== ShrubCommandFix ===
A temporary bug fix for using certain shrub commands alongside lua commands of the same name. Shouldn't need this, unless told.
 '''Values:''' ''list''
=== SpamProtect ===
Amount of time in seconds (float value) that must pass before using another command.
 '''Values:''' ''float number''
=== SpawnWalkthrough ===
If enabled players spawning (Only from spawn, not revive) will be able to walk through players for as long as they have their spawn shield.
 Works with g_spawnInvulFair
 '''Values:''' ''true'' or ''false''
=== Spec999 ===
Amount of seconds to pass after map has started to check if clients that have no ping/are downloading still should be moved spec.
 Set to 0 to disable.
 '''Values:''' ''number''
=== TeamBlock ===
Amount of seconds to pass before blocking the team command. To be used with '''TeamBlockMultiplier'''. If a certain player is switch a lot their teamblock will keep getting larger until eventually it will take 10-60 seconds before they can switch team again. This prevents players from constantly switching to the better team, if configured correctly.
 Resets each map. Set to 0.0 to disable.
 '''Values:''' ''float number''
=== TeamBlockMultiplier ===
Amount to multiply '''TeamBlock''' by. Suggested is between 1.0 and 3.0.
 Set to 0.0 to disable.
 '''Values:''' ''float number''
=== AutoLevel ===
----
==== Enabled ====
Whether or not to use the autolevel feature.
 '''Values:''' ''true'' or ''false''
==== StartLevel ====
The first level to start the autolevel. Players will get this level when they reach ''XPBase'' xp.
 '''Values:''' ''number''
==== EndLevel ====
Last level autolevel levels to.
 '''Values:''' ''number''
==== NoSetLevel ====
Whether or not to allow admins with lower than ''Config.Level.Leader'' to setlevel people in the autolevel range.
 '''Values:''' ''true'' or ''false''
==== RequireLogin ====
Require player to be logged in to get automatically leveled.
 '''Values:''' ''true'' or ''false''
==== XPBase ====
The base xp to start the autolevel. Players will get ''StartLevel'' when they reach this.
 '''Values:''' ''float number''
==== XPModifier ====
The amount to multiply ''XPBase'' by for levels after ''StartLevel''. Example:
<pre>XPBase: 500 , XPModifier: 1.75 , StartLevel: 1 , EndLevel: 5
Level 1: 500 , Level 2: 875 , Level 3: 1531 , Level 4: 2679 , Level 5: 4689</pre>
 '''Values:''' ''float number''
=== Balance ===
----
Balance only moves the player switching to a team, it will not move anyone who was already on the team. That is still being worked on as another feature.
 Some actions can be combined, for example: ''PutSpec'' and ''BlockTeam''
==== Enabled ====
Whether or not to use the balance feature.
 '''Values:''' ''true'' or ''false''
==== CountBots ====
Whether or not to count bots into the balance calculation. Example: 4 players 1 bot on axis vs 1 player 4 bots on allies would still be considered fair, if enabled.
 '''Values:''' ''true'' or ''false''
==== MaxSwitches ====
Maximum amount of switches before action is taken. There will be two ''warning messages'' given prior to the action taken, if ''MaxSwitches'' is set high enough. Example: MaxSwitches: 2 Switch to unbalanced team 1: Please do not switch to the stacked team.
 Switch to unbalanced team 1: **WARNING** If you switch again action will be taken
 (Action taken here)
 '''Values:''' ''number''
==== PutSpec ====
(Action) Will put the player spectator when ''MaxSwitches'' is reached.
 '''Values:''' ''true'' or ''false''
==== BlockTeam ====
Will block the team command (Command used to switch teams) for this round.
 '''Values:''' ''true'' or ''false''
==== BlacklistTime ====
Will blacklist(kick/ban) a user for the specified time.
 Time format is: 1 for 1 second, 1m for 1 minute, 1h for 1 hour, 1d for 1 day, 1o for 1 month
 Set to 0 to not kick.
 Set below 0 to permanently ban.
 '''Values:''' ''timeformat''
==== KickReason ====
Message to be given to players that get blacklisted.
 '''Values:''' ''string''
==== ExcludeOnline ====
Exclude people who are logged in from balance actions.
 '''Values:''' ''true'' or ''false''
==== ExcludeAuth ====
Exclude authorized users from balance actions.
 '''Values:''' ''true'' or ''false''
==== ExcludeLevel ====
Exclude players with at least this level from balance actions.
 '''Values:''' ''number''
=== Banner ===
----
==== Enabled ====
Whether or not banners are enabled.
 '''Values:''' ''true'' or ''false''
==== Delay ====
The delay between banner prints in seconds.
 '''Values:''' ''number''
==== AddRules ====
Whether or not to add the rules to the banners as well.
 '''Values:''' ''true'' or ''false''
==== Random ====
Whether or not to randomize the order in which the banners are printed.
 '''Values:''' ''true'' or ''false''
==== Location ====
The location in which to print the banners.
 '''Values:''' ''print bannerprint centerprint chat echo printclean bannerprintclean centerprintclean chatclean echoclean''
=== Blacklist ===
----
==== AllowIfAuth ====
Allow blacklisted users to connect if there is an authorized user online.
 '''Values:''' ''true'' or ''false''
==== AllowIfLeader ====
Allow blacklisted users to connect if there is a leader online.
 '''Values:''' ''true'' or ''false''
=== ClanTag ===
----
==== Enabled ====
Whether or not to enable clantag protection.
 '''Values:''' ''true'' or ''false''
==== Level ====
Level in which your tag is ok to be used. Example: Level 3 and below will be warned if set to 4.
 '''Values:''' ''number''
==== MaxRenames ====
Maximum amount of renames before action is taken.
 Set to 0 to take action right away.
 '''Values:''' ''number''
==== Exact ====
Whether or not to use exact match (including color codes). If false it will clear ignore case and color codes.
 '''Values:''' ''true'' or ''false''
==== Tags ====
List of tags to protect. Example: <code>[ "TT|", "(TT)", "xTTx" ],</code>
 '''Values:''' ''string list''
==== BlacklistTime ====
(Action) Blacklists user for specified time format when ''MaxRenames'' is reached.
 Time format is: 1 for 1 second, 1m for 1 minute, 1h for 1 hour, 1d for 1 day, 1o for 1 month
 Set to 0 to not kick.
 Set below 0 to permanently ban.
 '''Values:''' ''timeformat''
==== Warn ====
Will warn the user when ''MaxRenames'' is reached.
 '''Values:''' ''true'' or ''false''
==== Message ====
Message to be used in the warn or blacklist
 '''Values:''' ''string''
=== ConnectPrint ===
----
==== Location ====
Location where to print the message.
 '''Values:''' ''print bannerprint centerprint chat echo printclean bannerprintclean centerprintclean chatclean echoclean''
==== Bots ====
Will show connect print for bots.
 '''Values:''' ''true'' or ''false''
==== Ip ====
Will show a partial ip.
 '''Values:''' ''true'' or ''false''
==== Name ====
Will show name.
 '''Values:''' ''true'' or ''false''
==== Username ====
Will show username if autologged in. Required ''Name''
 '''Values:''' ''true'' or ''false''
==== Country ====
Will show country of connecting user if exist.
 '''Values:''' ''true'' or ''false''
==== ETVersion ====
Will show ET Version if exists.
 '''Values:''' ''true'' or ''false''
==== Protocol ====
Will show protocol(2.55,2.56,2.60,2.60b) if exists.
 '''Values:''' ''true'' or ''false''
==== Level ====
Will show level.
 '''Values:''' ''true'' or ''false''
=== DeathPrint ===
----
==== Location ====
Location where to print the message.
 '''Values:''' ''print bannerprint centerprint chat echo printclean bannerprintclean centerprintclean chatclean echoclean''
==== Distance ====
Print distance from killer.
 '''Values:''' ''true'' or ''false''
==== Name ====
Print killer name.
 '''Values:''' ''true'' or ''false''
==== Hp ====
Print killer hp.
 '''Values:''' ''true'' or ''false''
=== Debug ===
There are many debug values, you shouldn't ever need them, they will spam your console log.
=== DynamiteCounter ===
----
==== Enabled ====
 '''Values:''' ''true'' or ''false''
==== CountDown ====
List of times when to print the current time till detonation. Example: <code>[ 20, 10, 5, 3, 2, 1 ],</code>
 '''Values:''' ''number list''
==== Location ====
Location where to print the message.
 '''Values:''' ''print bannerprint centerprint chat echo printclean bannerprintclean centerprintclean chatclean echoclean''
==== PrintAll ====
If enabled it will print to all teams. If not enabled it will only print to the team that planted the dynamite.
 '''Values:''' ''true'' or ''false''
==== Plant ====
Print a message when dynamite gets planted.
 '''Values:''' ''true'' or ''false''
==== Defuse ====
Print a message when dynamite gets defused.
 '''Values:''' ''true'' or ''false''
==== Explode ====
Print a message when dynamite explodes.
 '''Values:''' ''true'' or ''false''
=== Intermission ===
----
==== BlockSpec ====
Blocks spectators from voting for a map.
 '''Values:''' ''true'' or ''false''
==== Mute ====
Blocks muted playersfrom voting for a map.
 '''Values:''' ''true'' or ''false''
==== ReadyMessage ====
Prints a message when a player is ready during intermission.
 '''Values:''' ''true'' or ''false''
==== VoteMessage ====
Prints a message when a player votes for a map during intermission.
 '''Values:''' ''true'' or ''false''
==== PrintBoth ====
If enabled prints both ready and vote messages separately. If not enabled it will wait until the player both votes and is ready before printing a message.
 '''Values:''' ''true'' or ''false''
==== RequireLevel ====
Requires level to vote for a map.
 '''Values:''' ''number''
==== RequireLogin ====
Requires to be logged into a profile to vote for a map.
 '''Values:''' ''true'' or ''false''
=== JSON ===
----
Paths to each of the JSON files.
=== Karma ===
----
==== Consecutive ====
Number of consecutive karma actions to one player allowed.
 '''Values:''' ''number''
==== Time ====
Time required to pass before taking another karma action.
 '''Values:''' ''timeformat''
=== Level ===
----
==== Admin ====
The level your admin starts(Admin meaning they are apart of your clan)
 '''Values:''' ''number''
==== Admin ====
The level your leader status starts
 '''Values:''' ''number''
=== Log ===
----
==== Colors ====
Keep colors in the logs.
 '''Values:''' ''true'' or ''false''
==== Full ====
Do a full log message output. This is easier to read manually, but harder for scripts to parse.
 '''Values:''' ''true'' or ''false''
==== OneFile ====
Output all log to one file. If not enabled it will separate logs by day.
 '''Values:''' ''true'' or ''false''
=== Message ===
----
==== ColorReplace ====
Allow to replace <color1> 2 and 3 in messages and chat.
 '''Values:''' ''true'' or ''false''
==== NameMentions====
Allow to use @name and @last in messages and chat.
 '''Values:''' ''true'' or ''false''
==== EventMentions ====
Allow to replace <event> with certain info.
 Work in progress feature, doesn't work well at the moment.
 Events: <code><killer><victim><heal><revive><name><weapon><ip><guid><ammo></code>
 '''Values:''' ''true'' or ''false''
==== GrammarCheck ====
Force grammarcheck globally.
 '''Values:''' ''true'' or ''false''
==== NoCaps ====
Force nocaps globally.
 '''Values:''' ''true'' or ''false''
==== NoColors ====
Force nocolors globally.
 '''Values:''' ''true'' or ''false''
==== SwearFilter ====
Force swearfilter globally.
 '''Values:''' ''true'' or ''false''
==== Format ====
Format in which messages are printed. Useful to keep a color scheme or style to all your messages.
 Example: <code><color3><<color2>< <color1><message> <color2>><color3>></code>
 Looks like: << Message here >>
 '''Values:''' ''string''
==== TableSymbol ====
Symbol to use for table border.
 Note: Use only one character!
 '''Values:''' ''character''
==== TableColor ====
Color of table symbol. Suggested: <color3>
 '''Values:''' ''color''
=== PingMonitor ===
----
=== Prefix ===
----
=== Profile ===
----
=== Sound ===
----
=== Vote ===
----
=== Warn ===
----
=== XpSave ===
----

LESM Installation

2015-05-03T02:04:02Z

Zelly: Added few links and corrections

LESM Installation

2015-05-02T18:37:40Z

Zelly: Configuration Autolevel and Balance

== Lua Enhanced Server Mod Install Guide ==
This guide will teach you how to install LESM on your server. Please read it carefully.
When I refer to the server's mod directory I mean:
'''/etdirectory/mod/''' Your qagame.mp.i386.so or qagame.mp.i386.dll will be in this directory.
Example: '''/home/et/silent/'''
JSON Files can be picky when editing them, you can use [http://jsonformatter.curiousconcept.com/ jsonformatter] to ensure you have valid JSON format, if they are not valid it will cause errors.
== Requirements ==
The only requirement is that you have lua 5.1 installed on your server. For silent mod, it comes with the mod and you do not need to make any further adjustments. For other mods you will need to follow their instructions on how to install it. Usually it just requires you to download the lua 5.1 library, and using a specific qagame.
== Download LuaESMod ==
Download LuaESMod and extract it to some temporary folder on your computer.
== Install ==
The Files/Folders you need are:
'''LuaESMod.lua''' and the entire LESM''' folder.
Upload those to your server's mod directory.
Next you will need to go into your server config edit your '''lua_modules''' cvar to include '''LuaESMod.lua'''
Will look something like '''set lua_modules "LuaESMod.lua"''' or '''set lua_modules "LuaESMod.lua test.lua testlua2.lua"'''
Note: If your server uses a seperate fs_homepath you will need to manually create the following directories:
'''
/fs_homepath/mod/LESM/
/fs_homepath/mod/LESM/save/
/fs_homepath/mod/LESM/extra/
/fs_homepath/mod/LESM/logs/'''
(Also you will need to make sure Commands.json is in /fs_homepath/mod/LESM/save/Commands.json
Basic rule of thumb is you keep luas in fs_basepath/fs_game/ and everything else can go into fs_homepath/fs_game/

== First Run ==
Restart/start your server.
You can verify if the script is running by typing: '''lua_status''' in rcon
If it is running then you can continue on to configuring the server.
The configuration file is '''/LESM/save/Config.json''' you may edit values there.
If your config fails to load for some reason or there are keys that were missing, a '''ConfigDefaults.json''' will be created with your old values and new values. This file is just for you to read and copy to '''Config.json''' if you wish, it is not actually loaded ever.
The most important values are Level.Leader and Level.Admin as this determines the level at which you can use some commands.
== Updating ==
If you are updating from a previous version it is basically the same thing as installing, you will overwrite all the lua files. There is Commands.json shipped with releases so the lua will know which commands were added. This only needs to be replaced if the new lua version adds a command, if it doesn't then you do not need to bother. If it does add a command but you have already edited your Commands.json and you do not want to lose your changes, you will need to find out which commands were added and add a section for each new command to your Commands.json.
== Other Config Files ==
Other specific configuration files:
=== Colors ===
Colors are saved in '''/LESM/save/Colors.json''' If you want to change the color scheme you can that do that in this file.
There are 3 keys in here you probably want to change to match your server's theme
Primary Is your main message color, white is a safe bet, definitely don't use black as it is hard to see.
Secondary Is the color used to highlight important information
Tertiary Is used for symbols or brackets surrounding text
The capital letter keys like LIGHT_BLUE are currently not used, in the future they may be used.
The rest are command colors, used in the help command.
=== Banners ===
Banners are saved in '''/LESM/save/Banners.json''' See related config options here
If you want to use banners you will need to edit this file.
Each message in a quote is a new banner.
When making banner messages you can use <color1> to use your Color.Primary <color2> to use Color.Secondary and <color3> to use Color.Tertiary
You can still use normal color codes though if you wish.
The beginning of the file must start with a [ and end of the file must end with ]
Also every new message must end with , UNLESS it is the last one which ends with nothing
In the example will Color.Primary equals ^7 Color.Secondary equals ^5 and Color.Tertiary equals 2
So for example:
<nowiki>[ "<color1>Registration <color2>required<color1> for xpsave and admin level<color3>!",
"<color1>Autolevel up to level <color2>600",
"<color3>/<color2>lua help<color1> to view all your commands<color3>!" ]</nowiki>
Means the messages are:
<nowiki>^7Registration ^5required^7 for xpsave and admin level^2!
^7Autolevel up to level ^5600
^2/^5lua help^7 to view all your commands^5!</nowiki>
=== Rules ===
Sounds are saved in '''/LESM/save/Rules.json'''
If you want to use the rules command, or add rules to banners then you will need to edit this file.
Same rules apply to Rules that apply to Banners
=== Sounds ===
Rules are saved in '''/LESM/save/Sounds.json'''
Sounds are kind of complex, and are not meant to be created manually, though they could if you really wanted.
I package a python script that will create a Sounds.json from all the sounds in a pk3 named '''sounds.py'''
If you do not know how to use a python script, post on forums with a link to your sounds pk3 I can easily get you setup.
Once you have your generated Sounds.json you are good to go
However if you want to edit what level each sound requires to play you can do that before you put it on your server
You can also do this ingame with the playsound command
''!playsound hello level 5'' you need to be a leader of authorized to do this
=== Maps ===
Maps is just a list of your map vote pool and is found in '''/LESM/save/Maps.json'''
Will look something like this:
<nowiki>
[
"adlernest",
"oasis",
"frostbite"
]</nowiki>
To get info for this list type in rcon: '''dir maps bsp'''
You can try manually creating this list.
Or post on forums and we will create one for you.
=== Grammar/SwearFilter ===
Found in '''/LESM/save/Grammar.json''' and '''/LESM/save/SwearFilter.json'''
Grammar is more of a spellcheck and is used when players have the ''grammarcheck'' key.
SwearFilter replace swear words with less vulgar words.
== Commands ==
The '''/LESM/save/Commands.json''' file decides what command gets loaded, and who can use it. This file needs to be updated each time a new command is added in a new version. When it comes with the release package it only contains a list of paths to lua commands. After it LESM loads it will then update the Commands.json to include: '''auth force level load login''' keys. These keys you can toggle to control loading commands(Explained below).
=== load ===
If load is set to '''true''' the command will load if the conditions are right. Almost all commands will be loaded, except for certain ones on certain mods, for example: Admintest on silent mod, since silentmod already has admintest. If load is set to '''false''' then the command will not load no matter what. By default all the commands '''load''' will be set to '''true'''.
=== force ===
If force is set to '''true''' it will force the command to load even if the command isn't supposed to load(Like admintest in the above example). If set to '''false''' nothing special happens and it will continue on default behavior. If you force load a command it may produce odd results. By default all of the commands '''force''' are set to '''false'''.
=== level ===
Set this to the minimum level required to use this command, or set to 0 to allow everyone to use the command. By default this key is set to either 0, Config.Level.Admin, or Config.Level.Leader depending on the command on first run.
=== login ===
If login is set to '''true''' then you must be logged into a profile to use this command. If set to '''false''' you are not required to be logged in. The default value for this depends on the command.
=== auth ===
If auth is set to '''true''' then you must be logged into a profile '''and''' have the '''authorize''' profile key set to '''true''' to use this command. The default value for this depends on the command.
=== path ===
Path is the path to the lua command file relative to '''/fs_homepath/fs_game/'''
=== Examples ===
Let's say for example you want to give all your admins level 5 and up access to the ammo command. What I changed here from default is I set login and auth to false, and set level to 5.
<pre>{
"auth": false,
"force": false,
"level": 5,
"load": true,
"login": false,
"path": "LESM/commands/ammo.lua"
}</pre> 
Now let us say we do not like the afk command, so we want to disable the afk and back command.
So we simply change load to false in both commmands: <pre>
{
"auth": false,
"force": false,
"level": 0,
"load": false,
"login": false,
"path": "LESM/commands/afk.lua"
}, {
"auth": false,
"force": false,
"level": 0,
"load": false,
"login": false,
"path": "LESM/commands/back.lua"
}</pre>
If you want more examples I can do them. Please request.
== Config ==
Found in '''/LESM/save/Config.json''' saves all your config keys it can be edited directly or from ingame. If you are editing ingame with the config commmand you need to use <code>!config save</code> after you have made your changes. Also the config only gets loaded when map restarts, this means if you change the file directly, and then go ingame and type use <code>!config save</code> your changes will be overwritten by what is currently loaded on the server. Now on to the keys
=== AdminWatchConsole ===
If enabled will send adminwatch messages to console print(So it will show up in server log and similar stuff). Only really useful for when you have access to direct server console output.
 '''Values:''' ''true'' or ''false''
=== BlockNoSilentFlag ===
If the player does not have the silent command flag '''3''' it will block silent commands that output messages to everyone, such as !afk and !me. For example it will block <code>/me Slaps players</code> & <code>/!me Slaps player</code> & <code>/lua me Slaps player</code>. But it will still allow commands to be used in chat: <code>!me slaps player</code>
 '''Values:''' ''true'' or ''false''
=== ConvertNoSilentFlag ===
If the player does not have the silent command flag '''3''' it will convert command to a chat command if enabled. Example: <code>/me Slaps player</code> turns into <code>!me Slaps player</code> in the global chat.
 '''Values:''' ''true'' or ''false''
=== ClassHPMax ===
Experimental, only works on silent mod. If enabled it will take the value defined in '''/LESM/extra/Classes.json''' for each class and make it their maximum health.
 '''Values:''' ''true'' or ''false''
=== ClassHPRegen ===
Experimental, only works on silent mod. If enabled it will take the value defined in '''/LESM/extra/Classes.json''' for each class and regenerate that amount of health each second.
 '''Values:''' ''true'' or ''false''
=== DamagePrint ===
Experimental, only works on silent mod. Allows players to see how much damage they are taking each hit.
 '''Warning''' this enabled g_debugBullets which spams the console log with a lot of messages(each hit), use at own risk.
 On legacy this feature is greatly expanded with more info on each hit, hopefully silent mod will soon bring et_Damage callback for this feature.
 '''Values:''' ''true'' or ''false''
=== DisplayRegister ===
Displays information on how to register and why to register when player connects.
 '''Values:''' ''true'' or ''false''
=== EncryptSha1 ===
Uses sha1 for passwords and other similar things. Downside adds about 3/4 a second to load time, upside is no one is gonna figure out the passwords. If not enabled uses a weak string jumbler instead.
 '''Values:''' ''true'' or ''false''
=== FreezeStart ===
Uses lua to force clients into the same position for '''FreezeStartTime''' seconds, will also add that time onto the timelimit so no time is lost. Useful to allow clients with bad computers or connections to start at the same time as everyone else. Also prevents bots from being 60 feet ahead at beginning of map.
 '''Values:''' ''true'' or ''false''
=== FreezeStartTime ===
Seconds to remain frozen at map start. My suggestion is around 8.
 '''Values:''' ''number''
=== PauseStart ===
Similar to '''FreezeStart'''. This will pause the game and immediately unpause the game at the start of the map, so no one can get an unfair start. Disadvantages to this one is that you can't tweak the time paused.
 '''Values:''' ''true'' or ''false''
=== MapEnts ===
Enables the map entity functions, for disabling objectives.
 '''Values:''' ''true'' or ''false''
=== MapListStart ===
Number to determine where your nextmap variables start. (Usually 1) if in your mapcycle.cfg you have vstr d1 at the end then set this value to '''1'''.
 '''Values:''' ''number''
=== MapListVarName ===
Variable name to determine where your nextmap variables start. (Usually d) if in your mapcycle.cfg you have vstr d1 at the end then set this value to '''d'''.
 '''Values:''' ''string''
=== MaxReports ===
Number of allowed reports (Through the /report command) per game.
 '''Values:''' ''number''
=== ReportToMail ===
Whether or not reports should report to admin mail(Only players with '''Config.Level.Admin''' level and plus can read). If not enabled then reports will save in a json format in '''/LESM/save/''' directory.
 '''Values:''' ''true'' or ''false''
=== MetricDistance ===
Whether or not to use metric distance by default in distance output. (Users can change this them self with the metricdistance profile key)
 '''Values:''' ''true'' or ''false''
=== MinNameLength ===
Minmum name length before getting renamed to a random name.
 '''Values:''' ''number''
=== Rename ===
A list of names to be automatically renamed to a random name.
Example: <code>"Rename": [ "ETPlayer", "UnnamedPlayer" ],</code>
 '''Values:''' ''list''
=== SetLevelMax ===
Maximum allowed level distance allowed to promote to. Example: If this were '''2''' and you were level ''10'' you could only promote to level ''8''.
 '''Values:''' ''number''
=== ShrubCommandFix ===
A temporary bug fix for using certain shrub commands alongside lua commands of the same name. Shouldn't need this, unless told.
 '''Values:''' ''list''
=== SpamProtect ===
Amount of time in seconds (float value) that must pass before using another command.
 '''Values:''' ''float number''
=== SpawnWalkthrough ===
If enabled players spawning (Only from spawn, not revive) will be able to walk through players for as long as they have their spawn shield.
 Works with g_spawnInvulFair
 '''Values:''' ''true'' or ''false''
=== Spec999 ===
Amount of seconds to pass after map has started to check if clients that have no ping/are downloading still should be moved spec.
 Set to 0 to disable.
 '''Values:''' ''number''
=== TeamBlock ===
Amount of seconds to pass before blocking the team command. To be used with '''TeamBlockMultiplier'''. If a certain player is switch a lot their teamblock will keep getting larger until eventually it will take 10-60 seconds before they can switch team again. This prevents players from constantly switching to the better team, if configured correctly.
 Resets each map. Set to 0.0 to disable.
 '''Values:''' ''float number''
=== TeamBlockMultiplier ===
Amount to multiply '''TeamBlock''' by. Suggested is between 1.0 and 3.0.
 Set to 0.0 to disable.
 '''Values:''' ''float number''
=== AutoLevel ===
==== Enabled ====
Whether or not to use the autolevel feature.
 '''Values:''' ''true'' or ''false''
==== StartLevel ====
The first level to start the autolevel. Players will get this level when they reach ''XPBase'' xp.
 '''Values:''' ''number''
==== EndLevel ====
Last level autolevel levels to.
 '''Values:''' ''number''
==== NoSetLevel ====
Whether or not to allow admins with lower than ''Config.Level.Leader'' to setlevel people in the autolevel range.
 '''Values:''' ''true'' or ''false''
==== RequireLogin ====
Require player to be logged in to get automatically leveled.
 '''Values:''' ''true'' or ''false''
==== XPBase ====
The base xp to start the autolevel. Players will get ''StartLevel'' when they reach this.
 '''Values:''' ''float number''
==== XPModifier ====
The amount to multiply ''XPBase'' by for levels after ''StartLevel''. Example:
<pre>XPBase: 500 , XPModifier: 1.75 , StartLevel: 1 , EndLevel: 5
Level 1: 500 , Level 2: 875 , Level 3: 1531 , Level 4: 2679 , Level 5: 4689</pre>
 '''Values:''' ''float number''
=== Balance ===
Balance only moves the player switching to a team, it will not move anyone who was already on the team. That is still being worked on as another feature.
 Some actions can be combined, for example: ''PutSpec'' and ''BlockTeam''
==== Enabled ====
Whether or not to use the balance feature.
 '''Values:''' ''true'' or ''false''
==== CountBots ====
Whether or not to count bots into the balance calculation. Example: 4 players 1 bot on axis vs 1 player 4 bots on allies would still be considered fair, if enabled.
 '''Values:''' ''true'' or ''false''
==== MaxSwitches ====
Maximum amount of switches before action is taken. There will be two ''warning messages'' given prior to the action taken, if ''MaxSwitches'' is set high enough. Example: MaxSwitches: 2 Switch to unbalanced team 1: Please do not switch to the stacked team.
 Switch to unbalanced team 1: **WARNING** If you switch again action will be taken
 (Action taken here)
 '''Values:''' ''number''
==== PutSpec ====
(Action) Will put the player spectator when ''MaxSwitches'' is reached.
 '''Values:''' ''true'' or ''false''
==== BlockTeam ====
Will block the team command (Command used to switch teams) for this round.
 '''Values:''' ''true'' or ''false''
==== BlacklistTime ====
Will blacklist(kick/ban) a user for the specified time.
 Time format is: 1 for 1 second, 1m for 1 minute, 1h for 1 hour, 1d for 1 day, 1o for 1 month
 Set to 0 to not kick.
 Set below 0 to permanently ban.
 '''Values:''' ''timeformat''
==== KickReason ====
Message to be given to players that get blacklisted.
 '''Values:''' ''string''
==== ExcludeOnline ====
Exclude people who are logged in from balance actions.
 '''Values:''' ''true'' or ''false''
==== ExcludeAuth ====
Exclude authorized users from balance actions.
 '''Values:''' ''true'' or ''false''
==== ExcludeLevel ====
Exclude players with at least this level from balance actions.
 '''Values:''' ''number''
=== Banner ===
=== Blacklist ===
=== ClanTag ===
=== ConnectPrint ===
=== DeathPrint ===
=== Debug ===
=== DynamiteCounter ===
=== Intermission ===
=== JSON ===
=== Karma ===
=== Level ===
=== Log ===
=== Message ===
=== PingMonitor ===
=== Prefix ===
=== Profile ===
=== Sound ===
=== Vote ===
=== Warn ===
=== XpSave ===

LESM Installation

2015-05-02T00:52:01Z

Zelly: Begin to add config options

== Lua Enhanced Server Mod Install Guide ==
This guide will teach you how to install LESM on your server. Please read it carefully.
When I refer to the server's mod directory I mean:
'''/etdirectory/mod/''' Your qagame.mp.i386.so or qagame.mp.i386.dll will be in this directory.
Example: '''/home/et/silent/'''
JSON Files can be picky when editing them, you can use [http://jsonformatter.curiousconcept.com/ jsonformatter] to ensure you have valid JSON format, if they are not valid it will cause errors.
== Requirements ==
The only requirement is that you have lua 5.1 installed on your server. For silent mod, it comes with the mod and you do not need to make any further adjustments. For other mods you will need to follow their instructions on how to install it. Usually it just requires you to download the lua 5.1 library, and using a specific qagame.
== Download LuaESMod ==
Download LuaESMod and extract it to some temporary folder on your computer.
== Install ==
The Files/Folders you need are:
'''LuaESMod.lua''' and the entire LESM''' folder.
Upload those to your server's mod directory.
Next you will need to go into your server config edit your '''lua_modules''' cvar to include '''LuaESMod.lua'''
Will look something like '''set lua_modules "LuaESMod.lua"''' or '''set lua_modules "LuaESMod.lua test.lua testlua2.lua"'''
Note: If your server uses a seperate fs_homepath you will need to manually create the following directories:
'''
/fs_homepath/mod/LESM/
/fs_homepath/mod/LESM/save/
/fs_homepath/mod/LESM/extra/
/fs_homepath/mod/LESM/logs/'''
(Also you will need to make sure Commands.json is in /fs_homepath/mod/LESM/save/Commands.json
Basic rule of thumb is you keep luas in fs_basepath/fs_game/ and everything else can go into fs_homepath/fs_game/

== First Run ==
Restart/start your server.
You can verify if the script is running by typing: '''lua_status''' in rcon
If it is running then you can continue on to configuring the server.
The configuration file is '''/LESM/save/Config.json''' you may edit values there.
If your config fails to load for some reason or there are keys that were missing, a '''ConfigDefaults.json''' will be created with your old values and new values. This file is just for you to read and copy to '''Config.json''' if you wish, it is not actually loaded ever.
The most important values are Level.Leader and Level.Admin as this determines the level at which you can use some commands.
== Updating ==
If you are updating from a previous version it is basically the same thing as installing, you will overwrite all the lua files. There is Commands.json shipped with releases so the lua will know which commands were added. This only needs to be replaced if the new lua version adds a command, if it doesn't then you do not need to bother. If it does add a command but you have already edited your Commands.json and you do not want to lose your changes, you will need to find out which commands were added and add a section for each new command to your Commands.json.
== Other Config Files ==
Other specific configuration files:
=== Colors ===
Colors are saved in '''/LESM/save/Colors.json''' If you want to change the color scheme you can that do that in this file.
There are 3 keys in here you probably want to change to match your server's theme
Primary Is your main message color, white is a safe bet, definitely don't use black as it is hard to see.
Secondary Is the color used to highlight important information
Tertiary Is used for symbols or brackets surrounding text
The capital letter keys like LIGHT_BLUE are currently not used, in the future they may be used.
The rest are command colors, used in the help command.
=== Banners ===
Banners are saved in '''/LESM/save/Banners.json''' See related config options here
If you want to use banners you will need to edit this file.
Each message in a quote is a new banner.
When making banner messages you can use <color1> to use your Color.Primary <color2> to use Color.Secondary and <color3> to use Color.Tertiary
You can still use normal color codes though if you wish.
The beginning of the file must start with a [ and end of the file must end with ]
Also every new message must end with , UNLESS it is the last one which ends with nothing
In the example will Color.Primary equals ^7 Color.Secondary equals ^5 and Color.Tertiary equals 2
So for example:
<nowiki>[ "<color1>Registration <color2>required<color1> for xpsave and admin level<color3>!",
"<color1>Autolevel up to level <color2>600",
"<color3>/<color2>lua help<color1> to view all your commands<color3>!" ]</nowiki>
Means the messages are:
<nowiki>^7Registration ^5required^7 for xpsave and admin level^2!
^7Autolevel up to level ^5600
^2/^5lua help^7 to view all your commands^5!</nowiki>
=== Rules ===
Sounds are saved in '''/LESM/save/Rules.json'''
If you want to use the rules command, or add rules to banners then you will need to edit this file.
Same rules apply to Rules that apply to Banners
=== Sounds ===
Rules are saved in '''/LESM/save/Sounds.json'''
Sounds are kind of complex, and are not meant to be created manually, though they could if you really wanted.
I package a python script that will create a Sounds.json from all the sounds in a pk3 named '''sounds.py'''
If you do not know how to use a python script, post on forums with a link to your sounds pk3 I can easily get you setup.
Once you have your generated Sounds.json you are good to go
However if you want to edit what level each sound requires to play you can do that before you put it on your server
You can also do this ingame with the playsound command
''!playsound hello level 5'' you need to be a leader of authorized to do this
=== Maps ===
Maps is just a list of your map vote pool and is found in '''/LESM/save/Maps.json'''
Will look something like this:
<nowiki>
[
"adlernest",
"oasis",
"frostbite"
]</nowiki>
To get info for this list type in rcon: '''dir maps bsp'''
You can try manually creating this list.
Or post on forums and we will create one for you.
=== Grammar/SwearFilter ===
Found in '''/LESM/save/Grammar.json''' and '''/LESM/save/SwearFilter.json'''
Grammar is more of a spellcheck and is used when players have the ''grammarcheck'' key.
SwearFilter replace swear words with less vulgar words.
== Commands ==
The '''/LESM/save/Commands.json''' file decides what command gets loaded, and who can use it. This file needs to be updated each time a new command is added in a new version. When it comes with the release package it only contains a list of paths to lua commands. After it LESM loads it will then update the Commands.json to include: '''auth force level load login''' keys. These keys you can toggle to control loading commands(Explained below).
=== load ===
If load is set to '''true''' the command will load if the conditions are right. Almost all commands will be loaded, except for certain ones on certain mods, for example: Admintest on silent mod, since silentmod already has admintest. If load is set to '''false''' then the command will not load no matter what. By default all the commands '''load''' will be set to '''true'''.
=== force ===
If force is set to '''true''' it will force the command to load even if the command isn't supposed to load(Like admintest in the above example). If set to '''false''' nothing special happens and it will continue on default behavior. If you force load a command it may produce odd results. By default all of the commands '''force''' are set to '''false'''.
=== level ===
Set this to the minimum level required to use this command, or set to 0 to allow everyone to use the command. By default this key is set to either 0, Config.Level.Admin, or Config.Level.Leader depending on the command on first run.
=== login ===
If login is set to '''true''' then you must be logged into a profile to use this command. If set to '''false''' you are not required to be logged in. The default value for this depends on the command.
=== auth ===
If auth is set to '''true''' then you must be logged into a profile '''and''' have the '''authorize''' profile key set to '''true''' to use this command. The default value for this depends on the command.
=== path ===
Path is the path to the lua command file relative to '''/fs_homepath/fs_game/'''
=== Examples ===
Let's say for example you want to give all your admins level 5 and up access to the ammo command. What I changed here from default is I set login and auth to false, and set level to 5.
<pre>{
"auth": false,
"force": false,
"level": 5,
"load": true,
"login": false,
"path": "LESM/commands/ammo.lua"
}</pre> 
Now let us say we do not like the afk command, so we want to disable the afk and back command.
So we simply change load to false in both commmands: <pre>
{
"auth": false,
"force": false,
"level": 0,
"load": false,
"login": false,
"path": "LESM/commands/afk.lua"
}, {
"auth": false,
"force": false,
"level": 0,
"load": false,
"login": false,
"path": "LESM/commands/back.lua"
}</pre>
If you want more examples I can do them. Please request.
== Config ==
Found in '''/LESM/save/Config.json''' saves all your config keys it can be edited directly or from ingame. If you are editing ingame with the config commmand you need to use <code>!config save</code> after you have made your changes. Also the config only gets loaded when map restarts, this means if you change the file directly, and then go ingame and type use <code>!config save</code> your changes will be overwritten by what is currently loaded on the server. Now on to the keys
=== AdminWatchConsole ===
If enabled will send adminwatch messages to console print(So it will show up in server log and similar stuff). Only really useful for when you have access to direct server console output.
 '''Values:''' ''true'' or ''false''
=== BlockNoSilentFlag ===
If the player does not have the silent command flag '''3''' it will block silent commands that output messages to everyone, such as !afk and !me. For example it will block <code>/me Slaps players</code> & <code>/!me Slaps player</code> & <code>/lua me Slaps player</code>. But it will still allow commands to be used in chat: <code>!me slaps player</code>
 '''Values:''' ''true'' or ''false''
=== ConvertNoSilentFlag ===
If the player does not have the silent command flag '''3''' it will convert command to a chat command if enabled. Example: <code>/me Slaps player</code> turns into <code>!me Slaps player</code> in the global chat.
 '''Values:''' ''true'' or ''false''
=== ClassHPMax ===
Experimental, only works on silent mod. If enabled it will take the value defined in '''/LESM/extra/Classes.json''' for each class and make it their maximum health.
 '''Values:''' ''true'' or ''false''
=== ClassHPRegen ===
Experimental, only works on silent mod. If enabled it will take the value defined in '''/LESM/extra/Classes.json''' for each class and regenerate that amount of health each second.
 '''Values:''' ''true'' or ''false''
=== DamagePrint ===
Experimental, only works on silent mod. Allows players to see how much damage they are taking each hit.
 '''Warning''' this enabled g_debugBullets which spams the console log with a lot of messages(each hit), use at own risk.
 On legacy this feature is greatly expanded with more info on each hit, hopefully silent mod will soon bring et_Damage callback for this feature.
 '''Values:''' ''true'' or ''false''
=== DisplayRegister ===
Displays information on how to register and why to register when player connects.
 '''Values:''' ''true'' or ''false''
=== EncryptSha1 ===
Uses sha1 for passwords and other similar things. Downside adds about 3/4 a second to load time, upside is no one is gonna figure out the passwords. If not enabled uses a weak string jumbler instead.
 '''Values:''' ''true'' or ''false''
=== FreezeStart ===
Uses lua to force clients into the same position for '''FreezeStartTime''' seconds, will also add that time onto the timelimit so no time is lost. Useful to allow clients with bad computers or connections to start at the same time as everyone else. Also prevents bots from being 60 feet ahead at beginning of map.
 '''Values:''' ''true'' or ''false''
=== FreezeStartTime ===
Seconds to remain frozen at map start. My suggestion is around 8.
 '''Values:''' ''number''
=== PauseStart ===
Similar to '''FreezeStart'''. This will pause the game and immediately unpause the game at the start of the map, so no one can get an unfair start. Disadvantages to this one is that you can't tweak the time paused.
 '''Values:''' ''true'' or ''false''
=== MapEnts ===
Enables the map entity functions, for disabling objectives.
 '''Values:''' ''true'' or ''false''
=== MapListStart ===
Number to determine where your nextmap variables start. (Usually 1) if in your mapcycle.cfg you have vstr d1 at the end then set this value to '''1'''.
 '''Values:''' ''number''
=== MapListVarName ===
Variable name to determine where your nextmap variables start. (Usually d) if in your mapcycle.cfg you have vstr d1 at the end then set this value to '''d'''.
 '''Values:''' ''string''
=== MaxReports ===
Number of allowed reports (Through the /report command) per game.
 '''Values:''' ''number''
=== ReportToMail ===
Whether or not reports should report to admin mail(Only players with '''Config.Level.Admin''' level and plus can read). If not enabled then reports will save in a json format in '''/LESM/save/''' directory.
 '''Values:''' ''true'' or ''false''
=== MetricDistance ===
Whether or not to use metric distance by default in distance output. (Users can change this them self with the metricdistance profile key)
 '''Values:''' ''true'' or ''false''
=== MinNameLength ===
Minmum name length before getting renamed to a random name.
 '''Values:''' ''number''
=== Rename ===
A list of names to be automatically renamed to a random name.
Example: <code>"Rename": [ "ETPlayer", "UnnamedPlayer" ],</code>
 '''Values:''' ''list''
=== SetLevelMax ===
Maximum allowed level distance allowed to promote to. Example: If this were '''2''' and you were level ''10'' you could only promote to level ''8''.
 '''Values:''' ''number''
=== ShrubCommandFix ===
A temporary bug fix for using certain shrub commands alongside lua commands of the same name. Shouldn't need this, unless told.
 '''Values:''' ''list''
=== SpamProtect ===
Amount of time in seconds (float value) that must pass before using another command.
 '''Values:''' ''float number''
=== SpawnWalkthrough ===
If enabled players spawning (Only from spawn, not revive) will be able to walk through players for as long as they have their spawn shield.
 Works with g_spawnInvulFair
 '''Values:''' ''true'' or ''false''
=== Spec999 ===
Amount of seconds to pass after map has started to check if clients that have no ping/are downloading still should be moved spec.
 Set to 0 to disable.
 '''Values:''' ''number''
=== TeamBlock ===
Amount of seconds to pass before blocking the team command. To be used with '''TeamBlockMultiplier'''. If a certain player is switch a lot their teamblock will keep getting larger until eventually it will take 10-60 seconds before they can switch team again. This prevents players from constantly switching to the better team, if configured correctly.
 Resets each map. Set to 0.0 to disable.
 '''Values:''' ''float number''
=== TeamBlockMultiplier ===
Amount to multiply '''TeamBlock''' by. Suggested is between 1.0 and 3.0.
 Set to 0.0 to disable.
 '''Values:''' ''float number''
=== AutoLevel ===
=== Balance ===
=== Banner ===
=== Blacklist ===
=== ClanTag ===
=== ConnectPrint ===
=== DeathPrint ===
=== Debug ===
=== DynamiteCounter ===
=== Intermission ===
=== JSON ===
=== Karma ===
=== Level ===
=== Log ===
=== Message ===
=== PingMonitor ===
=== Prefix ===
=== Profile ===
=== Sound ===
=== Vote ===
=== Warn ===
=== XpSave ===

LESM Getting Started

2015-05-01T03:05:48Z

Zelly: Made bit easier to understand

== Help ==
First and foremost is you should be able to use the help command. 
<code>/lhelp</code> Will display how all your available commands (Which can vary depending on your level and permissions) 
<code>/lhelp register</code> Will display help for the register command 
All commands have a decent explanation on what they are used for. So use lhelp before you use a command, to be sure you are using it correctly. 
You can also get the same help info by typing: <code>/register help</code>
== Creating a Profile ==
First thing you will need to do is create a profile you will need to use the register command with a username and a password. 
<code>/register <username> <password>
/register Zelly secretpassword</code>
Note: Please choose a unique password you have never used before.
== View ==
You can view online users with <code>/view</code> or <code>/view online</code> 
View a list of everyone registered with <code>/view all</code> 
You can also view a specific user by typing <code>/view username</code> 
== Edit ==
Client specific features are usually toggled with the edit command. 
Type <code>/edit</code> to view a list of keys you can edit. 
Type <code>/edit key</code> to toggle a boolean key on or off. 
Type <code>/edit key value</code> for string and number keys. 
There are location keys that you can control where stuff is printed to you (If at all) the valid locations for those are: print,printclean (Only you console), chat,chatclean (The chat area),echo,echoclean (The obituary area) , CenterPrint , centerprintclean ( Right above your chat area ), banner , bannerclean (The top of the screen), server(Uses server defined default) , none (Disables this specific print) 
The "clean" version is the one that is not formatted(defined by the server) it will still have color codes. 
Example of formatted version: '''>> This is a message <<''' 
Example of non-formatted version: '''This is a message''' 
== Autologin ==
By default your account will automatically login to your guid,silentid, and ip. Whenever found. If you have people on your network/computer you may not want this behavior. 
Perhaps you only want to login when you connect with your silentid. 
You would type <code>/autologin guid</code> and <code>/autologin ip</code> to reset your autologinip and autologinguid. To set them to your current ip/guid just type that again.(Use <code>/autologin silent</code> for silentid) 
You may disable autologin altogether with <code>/autologin</code> then you can only access your profile if you manually login with the login command.
=== Login ===
To login it is same as register <code>/login username password 
/login Zelly secretpassword</code> 
To logout you can do just <code>/logout</code> 
== Authorized Profile ==
To make someone an authorized user you can do use the update command. If it is the first authorized user you will need to do it via rcon(requires lua first argument): <code>lua update testuser authorize true</code>
TestUser will now have access to multiple new commands. He can also now update other users to authorize as well with same syntax ingame.

LESM

2015-05-01T03:01:52Z

Zelly: Added commands page

== Lua Enhanced Server Module ==

Lua Enhanced Server Module or LuaESMod or LESM for short, is a server side mod written in lua which aims to provide many features for server admins and their players. It can be used with various mods that support lua 5.1 and up.

It is still very much in development to make all of the features work in a way that can be easily setup for everyone using it. There are still plenty of ideas I have yet to add.

Some features include:
* Entity Manager to block objectives for a certain timelimit or other various tasks
* Dyno Counter
* User profile to save stats and other keys
** Ability to customize where messages are printed (If at all)
** Ability to ignore players permanently
*** Also ability to ignore lua sounds from a user (While still seeing his/her chat)
* Lua Sounds
** Played on certain events such as a confirmed kill
** Playsound command to remove hassle of creating a sound pack with menus
* Ingame Mail System
* Message formatting
** Admins can block users from using caps lock, as well as replace some commonly misspelled words
** Use @playername to get player full name with colors
* And plenty of more features, see features page to see full list
== Contents ==
*[http://mygamingtalk.com/forums/files/file/45-lua-enhanced-server-mod/ Download]
*[[LESM Installation | Installation]]
*[[LESM Features | Features]]
*[[LESM Getting Started | Getting Started]]
*[[LESM Commands| Commands]]

LESM Commands

2015-05-01T03:01:08Z

Zelly: Fixed nil level and no for login , auth

== Default ==
=== 8Ball ===
----
Ask the 8ball any question woooo
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua 8ball <question></code> - Ask the super question
 '''Example:'''

=== Afk ===
----
Notify server that you are away.. If you are logged in it will tell people how long you are away
 '''Aliases:''' away
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua afk </code> - Goes afk without reason
* <code>/lua afk [reason...]</code> - Goes afk with reason [reason]
 '''Example:'''
* <code>/lua afk </code> - YourName has gone afk!
* <code>/lua afk eating breakfast</code> - YourName is away eating breakfast
=== AveragePingCommand ===
----
Tells you your average ping over the course of a game.. (Must be actively on a team). This will also save your ping over games, if you are logged in.
 '''Aliases:''' getping averageping
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua avgping </code> - Gets your average ping
* <code>/lua avgping <clientname|clientid></code> - Gets <clientname>'s average ping
 '''Example:'''

=== Back ===
----
Notify server that you are back from being away.. If you join a team, this command is automatically executed.
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua back </code> - Notify server that you have returned
 '''Example:'''

=== Banners ===
----
Displays server banners. Can also print individual banner to everyone
 '''Aliases:''' banner
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua banners </code> - Displays all benners
* <code>/lua banners <bannernumber></code> - Displays specific banner number to everyone
* <code>/lua banners add <message></code> - Adds a banner
* <code>/lua banners edit <bannernumber> <message></code> - Edit banner message
* <code>/lua banners delete <bannernumber></code> - Removes banner
* <code>/lua banners refresh</code> - Refreshes banner routine
 '''Example:'''

=== Bye ===
----
Says goodbye!!. Also plays a hello sound
 '''Aliases:''' bai goodbye cya
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua bye </code> - Say goodbye!
* <code>/lua bye <client></code> - Say goodbye to specified person
* <code>/lua bye @last</code> - Say goodbye to last person that connected
 '''Example:'''
* <code>/lua bye Bob</code> - Says goodbye to bob!
* <code>/lua bye @last</code> - Says goodbye to steve! ( Since he was the last person that connected
=== Calculator ===
----
Simple calculator.. ( X Operator Y ) = Answer.. Operators: ( + - x / )
 '''Aliases:''' calc calculate
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua calculator <x> <operator> <y></code> - Does simple math
 '''Example:'''
* <code>/lua calculator 2 + 3</code> - Example would print 5
=== Colors ===
----
Gets all the color codes. You can view and change colors here as well. colortypes: primary secondary tertiary error command console mail default admin lua auth
 '''Aliases:''' color colorcodes
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua colors </code> - Displays all colors
* <code>/lua colors <colortype></code> - Displays color type (Auth)
* <code>/lua colors <colortype> <colorcode></code> - Changed color type to colorcode (Auth)
 '''Example:'''

=== Follow ===
----
Will spectate the player even after death.. Auth spec can only be done while you are dead.
 '''Aliases:''' f spectate spec
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua follow </code> - If following stops following whoever you are following.
* <code>/lua follow </code> - If not following moves you spectator.
* <code>/lua follow <client></code> - Follow a particular client.
* <code>/lua follow <client> auth</code> - Follow a particular client, without going spectator.
 '''Example:'''
* <code>/lua follow Bob</code> - Moves you to spectator and follows bob when he is alive
=== Hi ===
----
Says hello!!. Also plays a hello sound
 '''Aliases:''' hello hey hola hallo
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua hi </code> - Say hello!
* <code>/lua hi <client></code> - Say hello to specified person
* <code>/lua hi @last</code> - Say hello to last person that connected
 '''Example:'''
* <code>/lua hi Bob</code> - Says hello to bob!
* <code>/lua hi @last</code> - Says hello to steve! ( Since he was the last person that connected
=== Ignore ===
----
Silently ignores target. You can decide to ignore only sounds from a client as well
 '''Aliases:''' silentignore signore unignore
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua ignore </code> - List ignored clients
* <code>/lua ignore <client></code> - Silently ignores target
* <code>/lua ignore sound <client></code> - Silently ignores target's sounds
* <code>/lua ignore clear</code> - Clears all ignored players
 '''Example:'''

=== Info ===
----
Displays info about this lua.
 '''Aliases:''' lesm luaesmod zelly
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua info </code> -
 '''Example:'''

=== Login ===
----
Login to your user profile.. Username and password can have A-z 0-9 _ - but it cannot have spaces
 '''Aliases:''' signin
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua login <username> <password></code> - Attempts to login to <username> with <password>
 '''Example:'''
* <code>/lua login BobSteve s3cret</code> -
=== LogoutCommand ===
----
Logs out of your user profile.
 '''Aliases:''' signout
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua logout </code> -
 '''Example:'''

=== MapList ===
----
Gets a list of maps in file.
 '''Aliases:''' map maps
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua maplist </code> - Get a list of maps in the cycle
* <code>/lua maplist <mapnum></code> - Loads <mapnum>
* <code>/lua maplist <mapname></code> - Loads <mapname> , must be in Maps.json
 '''Example:'''

=== Me ===
----
Roleplay-like command. For making your own type of commands. You can also use @clientname to target specfic people. You can also use #killer , #victim , #revive , #health , and #ammo. Which is client that did that event to you. e.g. last person that revived you for #revive.. With this you could make your own binds too.
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua me <message...></code> - Displays message
 '''Example:'''
* <code>/lua me waves hello!</code> - Displays: * Steve waves hello! *
* <code>/lua me waves at @bob</code> - Displays: * Steve waves at SuperBob123 *
=== Mute ===
----
Mute and unmutes a specified user
 '''Aliases:''' unmute
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua mute <client></code> - Mute <client> permanently
* <code>/lua mute <client> <muteTime></code> - Mute <client> for <muteTime> seconds
* <code>/lua mute <client> strict</code> - Mute <client>'s commands permanently
 '''Example:'''

=== PMLevel ===
----
Private messages a level.. Can also private message a range of levels.
 '''Aliases:''' pml
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua pmlevel <level> <message></code> - Private messages all clients at <level>
* <code>/lua pmlevel <level>+ <message></code> - Private messages all clients at <level> or above
* <code>/lua pmlevel <level>- <message></code> - Private messages all clients at <level> or below
 '''Example:'''

=== PlaySound ===
----
Plays a sound from sound list. . You need to have the correct level to use the sound. Authorized users can edit title,message,tags,level,and alias
 '''Aliases:''' play p ps
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua playsound </code> - Shows list of all sounds you have access to
* <code>/lua playsound <soundname></code> - Plays <soundname> if available
* <code>/lua playsound <partialsoundname></code> - Plays <partialsoundname> if available, if there are multiple matches will display all of them
* <code>/lua playsound tags/tag <tagname></code> - Shows list of available sounds with <tagname>
* <code>/lua playsound savesounds</code> - Saves sounds(Auth)
* <code>/lua playsound <soundname> alias <alias></code> - Adds alias (Needs saving)(Auth)
* <code>/lua playsound <soundname> title <title></code> - Edits title(Needs saving)(Auth)
* <code>/lua playsound <soundname> level <level></code> - Edits level (Needs saving)(Auth)
* <code>/lua playsound <soundname> message <desc></code> - Edits description(Needs saving)(Auth)
* <code>/lua playsound <soundname> tag <tag></code> - Adds tag(Needs saving)(Auth)
 '''Example:'''

=== PrivateMessage ===
----
Sends a private message to a client. See also pmlevel
 '''Aliases:''' pm m
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua privatemessage <client> <message></code> - Sends message to client
* <code>/lua privatemessage <client>,<client>,<client>... <message></code> - Sends message to client
* <code>/lua privatemessage admin <message></code> - Sends message to client
* <code>/lua privatemessage leader <message></code> - Sends message to client
 '''Example:'''
* <code>/lua privatemessage bob Hello bob!</code> - Sends pm to bob
* <code>/lua privatemessage bob,steve,joe,4 Hey guys hows it going!?</code> - Sends a pm to bob , steve , joe , and whoever is in client slot #4
=== Register ===
----
Registers a username for your profile.. Username and password can't not have spaces, and some select characters. Make sure to use a unique password, as a malicious admin could potentially see it
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua register <username> <password></code> - Registers a profile using username and password
 '''Example:'''

=== Report ===
----
Reports an issue to the server admins.. Issue could be anything from an issue with a player, the server, or the lua.. The report will automatically include your name and the time you reported.. Keep your report short simple and to the point.. Note you can only input a certain amount of characters into chat( about 125) and console( about 200 ). You are limited to 1 reports per round
 '''Aliases:''' issue bugreport
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua report (message)</code> - Reports an issue with the message being (message)
 '''Example:'''
* <code>/lua report John is being a big ol meanie!</code> -
=== Rules ===
----
Displays server rules. Can also print individual rule to everyone
 '''Aliases:''' rule
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua rules </code> - Displays all rules
* <code>/lua rules <rulenumber></code> - Displays specific rule number to everyone
* <code>/lua rules add <message></code> - Adds a rule
* <code>/lua rules edit <rulenumber> <message></code> - Edit rule message
* <code>/lua rules delete <rulenumber></code> - Removes rule
* <code>/lua rules refresh</code> - Refreshes rule routine
 '''Example:'''

=== Salute ===
----
Salutes players
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua salute </code> - Salutes everyone
* <code>/lua salute <clientname|clientid></code> - Salutes specifc person
* <code>/lua salute @last</code> - Salutes last connected person
 '''Example:'''

=== SetLevel ===
----
Setlevel a client to specified level
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua setlevel <client> <level></code> - Sets clients level to <level>
 '''Example:'''

=== ShowDamage ===
----
Show damages and kills. If value is -1 it means mod isn't supported
 '''Aliases:''' showdmg damages damage dmg
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua showdamage </code> -
 '''Example:'''

=== TimeDate ===
----
Displays time and date
 '''Aliases:''' date time datetime
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua timedate </code> - Displays time and date
 '''Example:'''

=== Welcome ===
----
Welcomes players
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua welcome </code> - Say welcome!
* <code>/lua welcome <client></code> - Say welcome to specified person
* <code>/lua welcome @last</code> - Say welcome to last person that connected
 '''Example:'''

=== WhoAmI ===
----
Tells what you are currently spawned as
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua whoami </code> -
 '''Example:'''

=== ZelRating ===
----
Shows zelrating. In progress rating. Current formula: killrating * ( playerrating * 2 )
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua zelrating </code> -
 '''Example:'''

== Profile ==
=== AutoLogin ===
----
Controls auto logging into your profile.. Autologin requires a silent,guid, or ip to be linked to your profile to work.. Timeoutlength only activates when you have autologin disabled,. this is the time you would like to be remembered before it no longer auto logs you in.
 '''Aliases:''' al alogin
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua autologin </code> - Toggles autologin on and off
* <code>/lua autologin silent</code> - Links ( or resets if already present ) your autologin silent id
* <code>/lua autologin guid</code> - Links ( or resets if already present ) your autologin guid id
* <code>/lua autologin ip</code> - Links ( or resets if already present ) your autologin ip id
* <code>/lua autologin <timeoutlength></code> - Timed autologin
 '''Example:'''
* <code>/lua autologin 3d</code> - Timed autologin (3 Days) use m for minutes and h for hours
=== Edit ===
----
Edits keys in your user profile. . Number keys have min and max they can be. String keys have min length and max length they can be. Some string keys do not allow spaces and other characters
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua edit </code> - Gets info of all commands
* <code>/lua edit <key> -info</code> - Gets info of command
* <code>/lua edit <key></code> - Toggles key on and off (Boolean only)
* <code>/lua edit <key> <value></code> - Edits key with value
 '''Example:'''
* <code>/lua edit singlepistol</code> - Toggles spawning with single pistol
* <code>/lua edit username EpicMan411</code> - Edits your username to EpicMan411
* <code>/lua edit forumsname The Epic Man</code> - Edits your forums name to The Epic Man
=== Karma ===
----
Gives takes and checks karma of players. . You can give or take once an hour.. You can't give or take the same person twice in a row
 '''Aliases:''' kar
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua karma </code> - Shows your karma status
* <code>/lua karma <user></code> - Shows targetclient or targetusernames karma status
* <code>/lua karma <user> +</code> - Gives karma to targetclient or targetusername
* <code>/lua karma <user> -</code> - Takes karma from targetclient or targetusername
 '''Example:'''

=== View ===
----
View your or other users user profile.
 '''Aliases:''' v show display profile
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua view </code> - Views a list of all online users
* <code>/lua view online</code> - Views a list of all online users
* <code>/lua view all</code> - Views a list of all users
* <code>/lua view <username></code> - View <username>'s profile
* <code>/lua view <username> <key></code> - View <username>'s profile key
 '''Example:'''

== Mail ==
=== Help ===
----
Displays commands available to you or help on a specific command.
 '''Aliases:''' luahelp lhelp
 '''Required Level:''' 0
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua help </code> - Displays full list of available commands
* <code>/lua help <command></code> - Displays specific details on that command
* <code>/lua help auth</code> - Displays available authorized commands
* <code>/lua help lua</code> - Displays available lua commands
* <code>/lua help admin</code> - Displays available admin commands
* <code>/lua help mail</code> - Displays available mail commands
* <code>/lua help default</code> - Displays available default commands
 '''Example:'''
* <code>/lua help autologin</code> - Displays help for autologin
* <code>/lua help help</code> - Displays help for help
=== Inbox ===
----
Views your inbox.. Also you can read and delete your messages. You may also empty your inbox
 '''Aliases:''' read
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua inbox </code> - Views your current inbox, with a small summary of each message
* <code>/lua inbox <mail_id></code> - Displays entire <mail_id> message
* <code>/lua inbox delete <mail_id></code> - Deletes <mail_id> from your inbox
* <code>/lua inbox empty</code> - Emptys all messages from your inbox
 '''Example:'''
* <code>/lua inbox 3</code> - Will view and mark as read mail id 3
* <code>/lua inbox delete 4</code> - Will delete mail id 4 and you will no longer see it in your inbox
=== Send ===
----
Composes a mail to another user.
 '''Aliases:''' email
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua send <username> <message...></code> - Sends a message to username.
* <code>/lua send all <message...></code> - Sends a message to everyone.(Auth only)
 '''Example:'''

== Admin ==
=== AutoLevel ===
----
Toggles autolevel for certain clients
 '''Aliases:''' alevel
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua autolevel <client></code> - Toggles autolevel for client
 '''Example:'''

=== Blacklist ===
----
Blacklists a user from the server. Basically a client kick or ban. Can also do partial matches for things such as subnet bans. Editable keys: title,desc,reason,ip,guid,temp
 '''Aliases:'''
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua blacklist <client></code> - Blacklists the client
* <code>/lua blacklist ip <ip></code> - Blacklists an ip manually
* <code>/lua blacklist guid <silentid/guid></code> - Blacklists a specific guid
* <code>/lua blacklist view <id></code> - Views blacklist
* <code>/lua blacklist edit <id></code> - Edits blacklist
* <code>/lua blacklist remove <id></code> - Removes blacklist by id
 '''Example:'''
* <code>/lua blacklist add Bob</code> - Bob's ip,guid, and silent id if they exist are added to the blacklist
* <code>/lua blacklist add ip 127.0.0.1</code> - 127.0.0.1 ip is added to the blacklist
=== Config ===
----
Able to view the servers lua config. Can also temporarily change the values for the map. Note this is also case sensitive
 '''Aliases:''' conf cfg
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua config </code> - Gets list of all config keys and what they are
* <code>/lua config save</code> - Saves config
* <code>/lua config <key></code> - Gets <key>'s value
* <code>/lua config <key> <value></code> - Sets <key>'s value to <value>
 '''Example:'''
* <code>/lua config MapEnts</code> - Would return true or false based on Config.MapEnts
* <code>/lua config MapEnts true</code> - Would set Config.MapEnts to true
=== Cvar ===
----
WIP Toggles cvars
 '''Aliases:'''
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua cvar <cvar></code> - Get cvar info
* <code>/lua cvar <cvar> <value></code> - Set cvar value
* <code>/lua cvar <cvar> <add> <value></code> - Adds to cvar
* <code>/lua cvar <cvar> <value></code> - Subtracts from cvar
 '''Example:'''

=== DoubleJump ===
----
Toggles double jump
 '''Aliases:''' dj toggledj toggledoublejump
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua doublejump </code> -
 '''Example:'''

=== Freeze ===
----
Freezes user in place
 '''Aliases:'''
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua freeze <client></code> - Freezes client in place
 '''Example:'''

=== FriendlyFire ===
----
Toggles friendly fire settings. Friendly fire needs to be for half and reflect to work.
 '''Aliases:''' ff teamdamage
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua friendlyfire </code> - Toggles friendly fire on and off
* <code>/lua friendlyfire half</code> - Toggles half friendly fire damage
* <code>/lua friendlyfire reflect</code> - Toggles reflect friendly fire damage
 '''Example:'''

=== GrammarCheck ===
----
Toggle grammarcheck for client
 '''Aliases:''' gc grammar
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua grammarcheck <client></code> - Enables Grammarcheck for target
 '''Example:'''

=== List ===
----
List currently connected clients
 '''Aliases:''' listplayers li
 '''Required Level:''' Config.Level.Admin (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua list </code> - List currently connected clients
* <code>/lua list all</code> - List offline clients
 '''Example:'''

=== NoCaps ===
----
Toggle nocaps for client
 '''Aliases:''' caps capslock
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua nocaps <target></code> - Enables no caps for target
 '''Example:'''

=== NoColors ===
----
Toggle nocolors for client
 '''Aliases:''' decolor
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua nocolors <target></code> - Enables nocolors for target
 '''Example:'''

=== Seen ===
----

 '''Aliases:''' lastseen
 '''Required Level:''' Config.Level.Admin (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua seen <name></code> -
 '''Example:'''

=== ShoutCast ===
----
Sets yourself shoutcaster
 '''Aliases:''' ms sc makeshoutcaster makeshoutcast shoutcaster
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua shoutcast </code> -
 '''Example:'''

=== SpamProtect ===
----
Sets a multiplier to Clients spam protection.
 '''Aliases:''' spam
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua spamprotect <clientname|clientid> <spammultiplier></code> - Sets targets spam multiplier
 '''Example:'''

=== SwearFilter ===
----
Toggle swearfilter for client
 '''Aliases:''' sf swear censor
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua swearfilter <client></code> - Enables Swearfilter for target
 '''Example:'''

=== Warn ===
----
Manages handing out warnings and removing warnings to clients. Can also handle offline warnings as well by using the offline sub command
 '''Aliases:''' warnings
 '''Required Level:''' Config.Level.Admin (By default)
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua warn </code> - Views all warnings currently issued
* <code>/lua warn <client> <message></code> - Warns a client with reason
* <code>/lua warn <client> remove <warnid></code> - Views all warnings currently issued
* <code>/lua warn <client> clear</code> - Clears all issued warnings for client
* <code>/lua warn offline <client> <message></code> - Warns a client with reason
* <code>/lua warn offline <rudclientid> remove <warnid></code> - Views all warnings currently issued
* <code>/lua warn offline <rudclientid> clear</code> - Clears all issued warnings for client
* <code>/lua warn <client></code> - Warns a client without
* <code>/lua warn offline <rudclientid></code> - Warns a client without
 '''Example:'''

== Authorized ==
=== Adren ===
----
Gives adrenaline to a client.
 '''Aliases:''' adrenaline
 '''Required Level:''' Config.Level.Leader (By default)
 '''Required Login:''' No
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua adren </code> - Give yourself adrenaline for 10 seconds
* <code>/lua adren <seconds></code> - Give yourself adrenaline for <seconds> seconds
* <code>/lua adren <clientname|clientid></code> - Give target adrenaline for 10 seconds
* <code>/lua adren <clientname|clientid> <seconds></code> - Give target adrenaline for <seconds> seconds
 '''Example:'''
* <code>/lua adren 60</code> - Gives yourself 60 seconds of adrenaline
* <code>/lua adren Bob</code> - Gives Bob 10 seconds of adrenaline
* <code>/lua adren Bob 60</code> - Gives Bob 60 seconds of adrenaline
=== Ammo ===
----
Gives specified ammo amount.
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua ammo </code> - Give yourself 30 bullets
* <code>/lua ammo <clientname|clientid></code> - Give target 30 bullets
* <code>/lua ammo <clientname|clientid> <bullets></code> - Give target <bullets> bullets
 '''Example:'''

=== AmmoClip ===
----
Gives specified ammo amount directly to the current clip
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua ammoclip </code> - Give yourself 30 bullets in the clip
* <code>/lua ammoclip <clientname|clientid></code> - Give target 30 bullets
* <code>/lua ammoclip <clientname|clientid> <bullets></code> - Give target <bullets> bullets
 '''Example:'''

=== ChatAs ===
----
Chats as another player.
 '''Aliases:''' chatas
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua chatas <clientname|clientid> (message)</code> - Sends global chat (message) from <clientname>
* <code>/lua chatas <clientname|clientid> -team (message)</code> - Sends team chat (message) from <clientname>
* <code>/lua chatas <clientname|clientid> -fireteam (message)</code> - Sends fireteam chat (message) from <clientname>
 '''Example:'''

=== Disguise ===
----
Gives disguise.. This command needs more testing
 '''Aliases:''' disg
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua disguise </code> - Gives yourself a disguise
* <code>/lua disguise <clientname></code> - Gives <clientname> a disguise
* <code>/lua disguise as <clientname></code> - Disguises you as <clientname>
* <code>/lua disguise custom <class> <rank> <name></code> - Gives you a custom disguise
 '''Example:'''

=== Entity ===
----
Manipulates entities UNSAFE. Gets entity info for MapEnts
 '''Aliases:''' ent
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua entity </code> - Gets entity count
* <code>/lua entity get <ent></code> - Gets all fieldnames from ent
* <code>/lua entity get <ent> <fname></code> - Gets specific fieldname from ent
* <code>/lua entity set <ent> <fname> <value></code> - Attempts to set fieldname to value
* <code>/lua entity find <fname> [text]</code> - Finds all ents with fname matching [text] with their value
* <code>/lua entity atself [distance]</code> - Finds all ents within distance of yourself
* <code>/lua entity atent <ent> [distance]</code> - Finds all ents near <ent>
* <code>/lua entity link <ent></code> - Links entity to map
* <code>/lua entity unlink <ent></code> - Unlinks entity from map
* <code>/lua entity free <ent></code> - Fress entity from the map
* <code>/lua entity tp <ent> <ent></code> - Teleports two entitys
* <code>/lua entity compare <ent> <ent></code> - Gets differences in fieldnames
* <code>/lua entity spawn</code> - test command
* <code>/lua entity copy</code> - test command
* <code>/lua entity health</code> - test command
* <code>/lua entity create</code> - test command
 '''Example:'''

=== GetKey ===
----
Gets User Key
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua getkey <username> <key></code> - Gets <key> from <username>
 '''Example:'''
* <code>/lua getkey Bob adminwatch</code> - Checks if bob has adminwatch enabled or not
=== Health ===
----
Gives specified health amount.
 '''Aliases:''' heal hp
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua health </code> - Heals you to max hp
* <code>/lua health <health></code> - Adds <health> to your health
* <code>/lua health <client></code> - Heals client to max hp
* <code>/lua health <client> <health></code> - Adds <health> to client's health
 '''Example:'''

=== Load ===
----
Teleports you to your saved location. You can save names as well per map. See save command for more details
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua load </code> - Load current cached save location
* <code>/lua load <savename></code> - Loads <savename> save location to the current map
 '''Example:'''

=== MapEnt ===
----
Creates a map entity
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua mapent </code> - Lists all current map ents
* <code>/lua mapent <mapent></code> - Lists all map ent keys
* <code>/lua mapent add <scriptName></code> - Creates a mapent with scriptname for this map
* <code>/lua mapent delete <mapent></code> - Deletes a mapent
* <code>/lua mapent edit <mapent> <key> <value></code> - Edits a mapent
 '''Example:'''

=== Merge ===
----
Merges two users.. BE CAREFUL DATA WILL BE LOST. A backup of the merged player is made in save directory
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua merge <username1> <username2></code> - Merges <username1> INTO <username2> (Second username takes priority)
 '''Example:'''

=== Ping ===
----
Falsifys targets ping. Does not actually affect performance, just for show.
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua ping auto</code> - Toggles automatic fakeping for you.
* <code>/lua ping <pingMin> <pingMax></code> - Sets your fake ping range
* <code>/lua ping <clientName> <pingMin> <pingMax></code> - Sets fake ping range for client
 '''Example:'''

=== Print ===
----
Print messages via the console
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua print print (message)</code> - Prints to console (With Message Format)
* <code>/lua print chat (message)</code> - Prints to chat (With Message Format)
* <code>/lua print echo (message)</code> - Prints to obituary (With Message Format)
* <code>/lua print banner (message)</code> - Prints to banner (With Message Format)
* <code>/lua print centerprint (message)</code> - Prints to center (With Message Format)
* <code>/lua print printclean (message)</code> - Prints to console (Without Message Format)
* <code>/lua print chatclean (message)</code> - Prints to chat (Without Message Format)
* <code>/lua print echoclean (message)</code> - Prints to obituary (Without Message Format)
* <code>/lua print bannerclean (message)</code> - Prints to banner (Without Message Format)
* <code>/lua print centerprintclean (message)</code> - Prints to center (Without Message Format)
 '''Example:'''

=== Reload ===
----
Reloads specific parts of the project
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua reload commands</code> - Reloads commands
 '''Example:'''

=== RemoveUser ===
----
Removes a username. UNSAFE Be careful. A backup will be made in save directory
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua removeuser <username></code> - Removes <username> from existence!
 '''Example:'''

=== Routines ===
----
Displays runframe routines
 '''Aliases:''' runframe
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua routines </code> - Shows all runframe routines
 '''Example:'''

=== RunAs ===
----
Runs a command as another player
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua runas <client> <command> <args></code> - Runs a command as another client
 '''Example:'''

=== Save ===
----
Saves your current location. See also load command
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua save </code> - Saves current location to temporary cache
* <code>/lua save <name></code> - Saves current location <name> for current map
 '''Example:'''

=== Teleport ===
----
Teleports one client to another
 '''Aliases:''' tp
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua teleport <clientname></code> - Teleports you to client
* <code>/lua teleport <clientname> <clientname></code> - Teleports client1 to client2
 '''Example:'''

=== Update ===
----
Updates user's key. There is no error checking in this
 '''Aliases:'''
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua update <username> <key> <value></code> - Updates <username> <key> to <value>
* <code>/lua update all <key> <value></code> - Updates everyone's <key> to <value>
 '''Example:'''
* <code>/lua update Steve42 username steve_42</code> - Updates Steve42's username to steve_42
=== ViewFollowers ===
----
Views who is spectating who
 '''Aliases:''' followers vf
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua viewfollowers </code> -
 '''Example:'''

=== ViewLog ===
----
Views log for this match
 '''Aliases:''' log viewlogs vl
 '''Required Level:''' 0
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua viewlog </code> - Shows entire log
* <code>/lua viewlog <page></code> - Shows page of log
* <code>/lua viewlog bots</code> - Shows only events from bots
* <code>/lua viewlog nobots</code> - Shows only events from players
* <code>/lua viewlog find <text></code> - Shows only events that contain <text>
 '''Example:'''

=== Wiki ===
----
Create wiki commands
 '''Aliases:'''
 '''Required Level:''' 99
 '''Required Login:''' Yes
 '''Required Auth:''' Yes
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua wiki </code> -
 '''Example:'''

LESM Commands

2015-05-01T02:51:44Z

Zelly: Added help info from commands

== Default ==
=== 8Ball ===
----
Ask the 8ball any question woooo
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua 8ball <question></code> - Ask the super question
 '''Example:'''

=== Afk ===
----
Notify server that you are away.. If you are logged in it will tell people how long you are away
 '''Aliases:''' away
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua afk </code> - Goes afk without reason
* <code>/lua afk [reason...]</code> - Goes afk with reason [reason]
 '''Example:'''
* <code>/lua afk </code> - YourName has gone afk!
* <code>/lua afk eating breakfast</code> - YourName is away eating breakfast
=== AveragePingCommand ===
----
Tells you your average ping over the course of a game.. (Must be actively on a team). This will also save your ping over games, if you are logged in.
 '''Aliases:''' getping averageping
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua avgping </code> - Gets your average ping
* <code>/lua avgping <clientname|clientid></code> - Gets <clientname>'s average ping
 '''Example:'''

=== Back ===
----
Notify server that you are back from being away.. If you join a team, this command is automatically executed.
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua back </code> - Notify server that you have returned
 '''Example:'''

=== Banners ===
----
Displays server banners. Can also print individual banner to everyone
 '''Aliases:''' banner
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua banners </code> - Displays all benners
* <code>/lua banners <bannernumber></code> - Displays specific banner number to everyone
* <code>/lua banners add <message></code> - Adds a banner
* <code>/lua banners edit <bannernumber> <message></code> - Edit banner message
* <code>/lua banners delete <bannernumber></code> - Removes banner
* <code>/lua banners refresh</code> - Refreshes banner routine
 '''Example:'''

=== Bye ===
----
Says goodbye!!. Also plays a hello sound
 '''Aliases:''' bai goodbye cya
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua bye </code> - Say goodbye!
* <code>/lua bye <client></code> - Say goodbye to specified person
* <code>/lua bye @last</code> - Say goodbye to last person that connected
 '''Example:'''
* <code>/lua bye Bob</code> - Says goodbye to bob!
* <code>/lua bye @last</code> - Says goodbye to steve! ( Since he was the last person that connected
=== Calculator ===
----
Simple calculator.. ( X Operator Y ) = Answer.. Operators: ( + - x / )
 '''Aliases:''' calc calculate
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua calculator <x> <operator> <y></code> - Does simple math
 '''Example:'''
* <code>/lua calculator 2 + 3</code> - Example would print 5
=== Colors ===
----
Gets all the color codes. You can view and change colors here as well. colortypes: primary secondary tertiary error command console mail default admin lua auth
 '''Aliases:''' color colorcodes
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua colors </code> - Displays all colors
* <code>/lua colors <colortype></code> - Displays color type (Auth)
* <code>/lua colors <colortype> <colorcode></code> - Changed color type to colorcode (Auth)
 '''Example:'''

=== Follow ===
----
Will spectate the player even after death.. Auth spec can only be done while you are dead.
 '''Aliases:''' f spectate spec
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua follow </code> - If following stops following whoever you are following.
* <code>/lua follow </code> - If not following moves you spectator.
* <code>/lua follow <client></code> - Follow a particular client.
* <code>/lua follow <client> auth</code> - Follow a particular client, without going spectator.
 '''Example:'''
* <code>/lua follow Bob</code> - Moves you to spectator and follows bob when he is alive
=== Hi ===
----
Says hello!!. Also plays a hello sound
 '''Aliases:''' hello hey hola hallo
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua hi </code> - Say hello!
* <code>/lua hi <client></code> - Say hello to specified person
* <code>/lua hi @last</code> - Say hello to last person that connected
 '''Example:'''
* <code>/lua hi Bob</code> - Says hello to bob!
* <code>/lua hi @last</code> - Says hello to steve! ( Since he was the last person that connected
=== Ignore ===
----
Silently ignores target. You can decide to ignore only sounds from a client as well
 '''Aliases:''' silentignore signore unignore
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua ignore </code> - List ignored clients
* <code>/lua ignore <client></code> - Silently ignores target
* <code>/lua ignore sound <client></code> - Silently ignores target's sounds
* <code>/lua ignore clear</code> - Clears all ignored players
 '''Example:'''

=== Info ===
----
Displays info about this lua.
 '''Aliases:''' lesm luaesmod zelly
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua info </code> -
 '''Example:'''

=== Login ===
----
Login to your user profile.. Username and password can have A-z 0-9 _ - but it cannot have spaces
 '''Aliases:''' signin
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua login <username> <password></code> - Attempts to login to <username> with <password>
 '''Example:'''
* <code>/lua login BobSteve s3cret</code> -
=== LogoutCommand ===
----
Logs out of your user profile.
 '''Aliases:''' signout
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua logout </code> -
 '''Example:'''

=== MapList ===
----
Gets a list of maps in file.
 '''Aliases:''' map maps
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua maplist </code> - Get a list of maps in the cycle
* <code>/lua maplist <mapnum></code> - Loads <mapnum>
* <code>/lua maplist <mapname></code> - Loads <mapname> , must be in Maps.json
 '''Example:'''

=== Me ===
----
Roleplay-like command. For making your own type of commands. You can also use @clientname to target specfic people. You can also use #killer , #victim , #revive , #health , and #ammo. Which is client that did that event to you. e.g. last person that revived you for #revive.. With this you could make your own binds too.
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua me <message...></code> - Displays message
 '''Example:'''
* <code>/lua me waves hello!</code> - Displays: * Steve waves hello! *
* <code>/lua me waves at @bob</code> - Displays: * Steve waves at SuperBob123 *
=== Mute ===
----
Mute and unmutes a specified user
 '''Aliases:''' unmute
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua mute <client></code> - Mute <client> permanently
* <code>/lua mute <client> <muteTime></code> - Mute <client> for <muteTime> seconds
* <code>/lua mute <client> strict</code> - Mute <client>'s commands permanently
 '''Example:'''

=== PMLevel ===
----
Private messages a level.. Can also private message a range of levels.
 '''Aliases:''' pml
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua pmlevel <level> <message></code> - Private messages all clients at <level>
* <code>/lua pmlevel <level>+ <message></code> - Private messages all clients at <level> or above
* <code>/lua pmlevel <level>- <message></code> - Private messages all clients at <level> or below
 '''Example:'''

=== PlaySound ===
----
Plays a sound from sound list. . You need to have the correct level to use the sound. Authorized users can edit title,message,tags,level,and alias
 '''Aliases:''' play p ps
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua playsound </code> - Shows list of all sounds you have access to
* <code>/lua playsound <soundname></code> - Plays <soundname> if available
* <code>/lua playsound <partialsoundname></code> - Plays <partialsoundname> if available, if there are multiple matches will display all of them
* <code>/lua playsound tags/tag <tagname></code> - Shows list of available sounds with <tagname>
* <code>/lua playsound savesounds</code> - Saves sounds(Auth)
* <code>/lua playsound <soundname> alias <alias></code> - Adds alias (Needs saving)(Auth)
* <code>/lua playsound <soundname> title <title></code> - Edits title(Needs saving)(Auth)
* <code>/lua playsound <soundname> level <level></code> - Edits level (Needs saving)(Auth)
* <code>/lua playsound <soundname> message <desc></code> - Edits description(Needs saving)(Auth)
* <code>/lua playsound <soundname> tag <tag></code> - Adds tag(Needs saving)(Auth)
 '''Example:'''

=== PrivateMessage ===
----
Sends a private message to a client. See also pmlevel
 '''Aliases:''' pm m
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua privatemessage <client> <message></code> - Sends message to client
* <code>/lua privatemessage <client>,<client>,<client>... <message></code> - Sends message to client
* <code>/lua privatemessage admin <message></code> - Sends message to client
* <code>/lua privatemessage leader <message></code> - Sends message to client
 '''Example:'''
* <code>/lua privatemessage bob Hello bob!</code> - Sends pm to bob
* <code>/lua privatemessage bob,steve,joe,4 Hey guys hows it going!?</code> - Sends a pm to bob , steve , joe , and whoever is in client slot #4
=== Register ===
----
Registers a username for your profile.. Username and password can't not have spaces, and some select characters. Make sure to use a unique password, as a malicious admin could potentially see it
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua register <username> <password></code> - Registers a profile using username and password
 '''Example:'''

=== Report ===
----
Reports an issue to the server admins.. Issue could be anything from an issue with a player, the server, or the lua.. The report will automatically include your name and the time you reported.. Keep your report short simple and to the point.. Note you can only input a certain amount of characters into chat( about 125) and console( about 200 ). You are limited to 1 reports per round
 '''Aliases:''' issue bugreport
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua report (message)</code> - Reports an issue with the message being (message)
 '''Example:'''
* <code>/lua report John is being a big ol meanie!</code> -
=== Rules ===
----
Displays server rules. Can also print individual rule to everyone
 '''Aliases:''' rule
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua rules </code> - Displays all rules
* <code>/lua rules <rulenumber></code> - Displays specific rule number to everyone
* <code>/lua rules add <message></code> - Adds a rule
* <code>/lua rules edit <rulenumber> <message></code> - Edit rule message
* <code>/lua rules delete <rulenumber></code> - Removes rule
* <code>/lua rules refresh</code> - Refreshes rule routine
 '''Example:'''

=== Salute ===
----
Salutes players
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua salute </code> - Salutes everyone
* <code>/lua salute <clientname|clientid></code> - Salutes specifc person
* <code>/lua salute @last</code> - Salutes last connected person
 '''Example:'''

=== SetLevel ===
----
Setlevel a client to specified level
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua setlevel <client> <level></code> - Sets clients level to <level>
 '''Example:'''

=== ShowDamage ===
----
Show damages and kills. If value is -1 it means mod isn't supported
 '''Aliases:''' showdmg damages damage dmg
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua showdamage </code> -
 '''Example:'''

=== TimeDate ===
----
Displays time and date
 '''Aliases:''' date time datetime
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua timedate </code> - Displays time and date
 '''Example:'''

=== Welcome ===
----
Welcomes players
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua welcome </code> - Say welcome!
* <code>/lua welcome <client></code> - Say welcome to specified person
* <code>/lua welcome @last</code> - Say welcome to last person that connected
 '''Example:'''

=== WhoAmI ===
----
Tells what you are currently spawned as
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua whoami </code> -
 '''Example:'''

=== ZelRating ===
----
Shows zelrating. In progress rating. Current formula: killrating * ( playerrating * 2 )
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua zelrating </code> -
 '''Example:'''

== Profile ==
=== AutoLogin ===
----
Controls auto logging into your profile.. Autologin requires a silent,guid, or ip to be linked to your profile to work.. Timeoutlength only activates when you have autologin disabled,. this is the time you would like to be remembered before it no longer auto logs you in.
 '''Aliases:''' al alogin
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua autologin </code> - Toggles autologin on and off
* <code>/lua autologin silent</code> - Links ( or resets if already present ) your autologin silent id
* <code>/lua autologin guid</code> - Links ( or resets if already present ) your autologin guid id
* <code>/lua autologin ip</code> - Links ( or resets if already present ) your autologin ip id
* <code>/lua autologin <timeoutlength></code> - Timed autologin
 '''Example:'''
* <code>/lua autologin 3d</code> - Timed autologin (3 Days) use m for minutes and h for hours
=== Edit ===
----
Edits keys in your user profile. . Number keys have min and max they can be. String keys have min length and max length they can be. Some string keys do not allow spaces and other characters
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua edit </code> - Gets info of all commands
* <code>/lua edit <key> -info</code> - Gets info of command
* <code>/lua edit <key></code> - Toggles key on and off (Boolean only)
* <code>/lua edit <key> <value></code> - Edits key with value
 '''Example:'''
* <code>/lua edit singlepistol</code> - Toggles spawning with single pistol
* <code>/lua edit username EpicMan411</code> - Edits your username to EpicMan411
* <code>/lua edit forumsname The Epic Man</code> - Edits your forums name to The Epic Man
=== Karma ===
----
Gives takes and checks karma of players. . You can give or take once an hour.. You can't give or take the same person twice in a row
 '''Aliases:''' kar
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua karma </code> - Shows your karma status
* <code>/lua karma <user></code> - Shows targetclient or targetusernames karma status
* <code>/lua karma <user> +</code> - Gives karma to targetclient or targetusername
* <code>/lua karma <user> -</code> - Takes karma from targetclient or targetusername
 '''Example:'''

=== View ===
----
View your or other users user profile.
 '''Aliases:''' v show display profile
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua view </code> - Views a list of all online users
* <code>/lua view online</code> - Views a list of all online users
* <code>/lua view all</code> - Views a list of all users
* <code>/lua view <username></code> - View <username>'s profile
* <code>/lua view <username> <key></code> - View <username>'s profile key
 '''Example:'''

== Mail ==
=== Help ===
----
Displays commands available to you or help on a specific command.
 '''Aliases:''' luahelp lhelp
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua help </code> - Displays full list of available commands
* <code>/lua help <command></code> - Displays specific details on that command
* <code>/lua help auth</code> - Displays available authorized commands
* <code>/lua help lua</code> - Displays available lua commands
* <code>/lua help admin</code> - Displays available admin commands
* <code>/lua help mail</code> - Displays available mail commands
* <code>/lua help default</code> - Displays available default commands
 '''Example:'''
* <code>/lua help autologin</code> - Displays help for autologin
* <code>/lua help help</code> - Displays help for help
=== Inbox ===
----
Views your inbox.. Also you can read and delete your messages. You may also empty your inbox
 '''Aliases:''' read
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua inbox </code> - Views your current inbox, with a small summary of each message
* <code>/lua inbox <mail_id></code> - Displays entire <mail_id> message
* <code>/lua inbox delete <mail_id></code> - Deletes <mail_id> from your inbox
* <code>/lua inbox empty</code> - Emptys all messages from your inbox
 '''Example:'''
* <code>/lua inbox 3</code> - Will view and mark as read mail id 3
* <code>/lua inbox delete 4</code> - Will delete mail id 4 and you will no longer see it in your inbox
=== Send ===
----
Composes a mail to another user.
 '''Aliases:''' email
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua send <username> <message...></code> - Sends a message to username.
* <code>/lua send all <message...></code> - Sends a message to everyone.(Auth only)
 '''Example:'''

== Admin ==
=== AutoLevel ===
----
Toggles autolevel for certain clients
 '''Aliases:''' alevel
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua autolevel <client></code> - Toggles autolevel for client
 '''Example:'''

=== Blacklist ===
----
Blacklists a user from the server. Basically a client kick or ban. Can also do partial matches for things such as subnet bans. Editable keys: title,desc,reason,ip,guid,temp
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua blacklist <client></code> - Blacklists the client
* <code>/lua blacklist ip <ip></code> - Blacklists an ip manually
* <code>/lua blacklist guid <silentid/guid></code> - Blacklists a specific guid
* <code>/lua blacklist view <id></code> - Views blacklist
* <code>/lua blacklist edit <id></code> - Edits blacklist
* <code>/lua blacklist remove <id></code> - Removes blacklist by id
 '''Example:'''
* <code>/lua blacklist add Bob</code> - Bob's ip,guid, and silent id if they exist are added to the blacklist
* <code>/lua blacklist add ip 127.0.0.1</code> - 127.0.0.1 ip is added to the blacklist
=== Config ===
----
Able to view the servers lua config. Can also temporarily change the values for the map. Note this is also case sensitive
 '''Aliases:''' conf cfg
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua config </code> - Gets list of all config keys and what they are
* <code>/lua config save</code> - Saves config
* <code>/lua config <key></code> - Gets <key>'s value
* <code>/lua config <key> <value></code> - Sets <key>'s value to <value>
 '''Example:'''
* <code>/lua config MapEnts</code> - Would return true or false based on Config.MapEnts
* <code>/lua config MapEnts true</code> - Would set Config.MapEnts to true
=== Cvar ===
----
WIP Toggles cvars
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua cvar <cvar></code> - Get cvar info
* <code>/lua cvar <cvar> <value></code> - Set cvar value
* <code>/lua cvar <cvar> <add> <value></code> - Adds to cvar
* <code>/lua cvar <cvar> <value></code> - Subtracts from cvar
 '''Example:'''

=== DoubleJump ===
----
Toggles double jump
 '''Aliases:''' dj toggledj toggledoublejump
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua doublejump </code> -
 '''Example:'''

=== Freeze ===
----
Freezes user in place
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua freeze <client></code> - Freezes client in place
 '''Example:'''

=== FriendlyFire ===
----
Toggles friendly fire settings. Friendly fire needs to be for half and reflect to work.
 '''Aliases:''' ff teamdamage
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua friendlyfire </code> - Toggles friendly fire on and off
* <code>/lua friendlyfire half</code> - Toggles half friendly fire damage
* <code>/lua friendlyfire reflect</code> - Toggles reflect friendly fire damage
 '''Example:'''

=== GrammarCheck ===
----
Toggle grammarcheck for client
 '''Aliases:''' gc grammar
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua grammarcheck <client></code> - Enables Grammarcheck for target
 '''Example:'''

=== List ===
----
List currently connected clients
 '''Aliases:''' listplayers li
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua list </code> - List currently connected clients
* <code>/lua list all</code> - List offline clients
 '''Example:'''

=== NoCaps ===
----
Toggle nocaps for client
 '''Aliases:''' caps capslock
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua nocaps <target></code> - Enables no caps for target
 '''Example:'''

=== NoColors ===
----
Toggle nocolors for client
 '''Aliases:''' decolor
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua nocolors <target></code> - Enables nocolors for target
 '''Example:'''

=== Seen ===
----

 '''Aliases:''' lastseen
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua seen <name></code> -
 '''Example:'''

=== ShoutCast ===
----
Sets yourself shoutcaster
 '''Aliases:''' ms sc makeshoutcaster makeshoutcast shoutcaster
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua shoutcast </code> -
 '''Example:'''

=== SpamProtect ===
----
Sets a multiplier to Clients spam protection.
 '''Aliases:''' spam
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua spamprotect <clientname|clientid> <spammultiplier></code> - Sets targets spam multiplier
 '''Example:'''

=== SwearFilter ===
----
Toggle swearfilter for client
 '''Aliases:''' sf swear censor
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua swearfilter <client></code> - Enables Swearfilter for target
 '''Example:'''

=== Warn ===
----
Manages handing out warnings and removing warnings to clients. Can also handle offline warnings as well by using the offline sub command
 '''Aliases:''' warnings
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua warn </code> - Views all warnings currently issued
* <code>/lua warn <client> <message></code> - Warns a client with reason
* <code>/lua warn <client> remove <warnid></code> - Views all warnings currently issued
* <code>/lua warn <client> clear</code> - Clears all issued warnings for client
* <code>/lua warn offline <client> <message></code> - Warns a client with reason
* <code>/lua warn offline <rudclientid> remove <warnid></code> - Views all warnings currently issued
* <code>/lua warn offline <rudclientid> clear</code> - Clears all issued warnings for client
* <code>/lua warn <client></code> - Warns a client without
* <code>/lua warn offline <rudclientid></code> - Warns a client without
 '''Example:'''

== Authorized ==
=== Adren ===
----
Gives adrenaline to a client.
 '''Aliases:''' adrenaline
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua adren </code> - Give yourself adrenaline for 10 seconds
* <code>/lua adren <seconds></code> - Give yourself adrenaline for <seconds> seconds
* <code>/lua adren <clientname|clientid></code> - Give target adrenaline for 10 seconds
* <code>/lua adren <clientname|clientid> <seconds></code> - Give target adrenaline for <seconds> seconds
 '''Example:'''
* <code>/lua adren 60</code> - Gives yourself 60 seconds of adrenaline
* <code>/lua adren Bob</code> - Gives Bob 10 seconds of adrenaline
* <code>/lua adren Bob 60</code> - Gives Bob 60 seconds of adrenaline
=== Ammo ===
----
Gives specified ammo amount.
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua ammo </code> - Give yourself 30 bullets
* <code>/lua ammo <clientname|clientid></code> - Give target 30 bullets
* <code>/lua ammo <clientname|clientid> <bullets></code> - Give target <bullets> bullets
 '''Example:'''

=== AmmoClip ===
----
Gives specified ammo amount directly to the current clip
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua ammoclip </code> - Give yourself 30 bullets in the clip
* <code>/lua ammoclip <clientname|clientid></code> - Give target 30 bullets
* <code>/lua ammoclip <clientname|clientid> <bullets></code> - Give target <bullets> bullets
 '''Example:'''

=== ChatAs ===
----
Chats as another player.
 '''Aliases:''' chatas
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua chatas <clientname|clientid> (message)</code> - Sends global chat (message) from <clientname>
* <code>/lua chatas <clientname|clientid> -team (message)</code> - Sends team chat (message) from <clientname>
* <code>/lua chatas <clientname|clientid> -fireteam (message)</code> - Sends fireteam chat (message) from <clientname>
 '''Example:'''

=== Disguise ===
----
Gives disguise.. This command needs more testing
 '''Aliases:''' disg
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua disguise </code> - Gives yourself a disguise
* <code>/lua disguise <clientname></code> - Gives <clientname> a disguise
* <code>/lua disguise as <clientname></code> - Disguises you as <clientname>
* <code>/lua disguise custom <class> <rank> <name></code> - Gives you a custom disguise
 '''Example:'''

=== Entity ===
----
Manipulates entities UNSAFE. Gets entity info for MapEnts
 '''Aliases:''' ent
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua entity </code> - Gets entity count
* <code>/lua entity get <ent></code> - Gets all fieldnames from ent
* <code>/lua entity get <ent> <fname></code> - Gets specific fieldname from ent
* <code>/lua entity set <ent> <fname> <value></code> - Attempts to set fieldname to value
* <code>/lua entity find <fname> [text]</code> - Finds all ents with fname matching [text] with their value
* <code>/lua entity atself [distance]</code> - Finds all ents within distance of yourself
* <code>/lua entity atent <ent> [distance]</code> - Finds all ents near <ent>
* <code>/lua entity link <ent></code> - Links entity to map
* <code>/lua entity unlink <ent></code> - Unlinks entity from map
* <code>/lua entity free <ent></code> - Fress entity from the map
* <code>/lua entity tp <ent> <ent></code> - Teleports two entitys
* <code>/lua entity compare <ent> <ent></code> - Gets differences in fieldnames
* <code>/lua entity spawn</code> - test command
* <code>/lua entity copy</code> - test command
* <code>/lua entity health</code> - test command
* <code>/lua entity create</code> - test command
 '''Example:'''

=== GetKey ===
----
Gets User Key
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua getkey <username> <key></code> - Gets <key> from <username>
 '''Example:'''
* <code>/lua getkey Bob adminwatch</code> - Checks if bob has adminwatch enabled or not
=== Health ===
----
Gives specified health amount.
 '''Aliases:''' heal hp
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua health </code> - Heals you to max hp
* <code>/lua health <health></code> - Adds <health> to your health
* <code>/lua health <client></code> - Heals client to max hp
* <code>/lua health <client> <health></code> - Adds <health> to client's health
 '''Example:'''

=== Load ===
----
Teleports you to your saved location. You can save names as well per map. See save command for more details
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua load </code> - Load current cached save location
* <code>/lua load <savename></code> - Loads <savename> save location to the current map
 '''Example:'''

=== MapEnt ===
----
Creates a map entity
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua mapent </code> - Lists all current map ents
* <code>/lua mapent <mapent></code> - Lists all map ent keys
* <code>/lua mapent add <scriptName></code> - Creates a mapent with scriptname for this map
* <code>/lua mapent delete <mapent></code> - Deletes a mapent
* <code>/lua mapent edit <mapent> <key> <value></code> - Edits a mapent
 '''Example:'''

=== Merge ===
----
Merges two users.. BE CAREFUL DATA WILL BE LOST. A backup of the merged player is made in save directory
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua merge <username1> <username2></code> - Merges <username1> INTO <username2> (Second username takes priority)
 '''Example:'''

=== Ping ===
----
Falsifys targets ping. Does not actually affect performance, just for show.
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua ping auto</code> - Toggles automatic fakeping for you.
* <code>/lua ping <pingMin> <pingMax></code> - Sets your fake ping range
* <code>/lua ping <clientName> <pingMin> <pingMax></code> - Sets fake ping range for client
 '''Example:'''

=== Print ===
----
Print messages via the console
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua print print (message)</code> - Prints to console (With Message Format)
* <code>/lua print chat (message)</code> - Prints to chat (With Message Format)
* <code>/lua print echo (message)</code> - Prints to obituary (With Message Format)
* <code>/lua print banner (message)</code> - Prints to banner (With Message Format)
* <code>/lua print centerprint (message)</code> - Prints to center (With Message Format)
* <code>/lua print printclean (message)</code> - Prints to console (Without Message Format)
* <code>/lua print chatclean (message)</code> - Prints to chat (Without Message Format)
* <code>/lua print echoclean (message)</code> - Prints to obituary (Without Message Format)
* <code>/lua print bannerclean (message)</code> - Prints to banner (Without Message Format)
* <code>/lua print centerprintclean (message)</code> - Prints to center (Without Message Format)
 '''Example:'''

=== Reload ===
----
Reloads specific parts of the project
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua reload commands</code> - Reloads commands
 '''Example:'''

=== RemoveUser ===
----
Removes a username. UNSAFE Be careful. A backup will be made in save directory
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua removeuser <username></code> - Removes <username> from existence!
 '''Example:'''

=== Routines ===
----
Displays runframe routines
 '''Aliases:''' runframe
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua routines </code> - Shows all runframe routines
 '''Example:'''

=== RunAs ===
----
Runs a command as another player
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua runas <client> <command> <args></code> - Runs a command as another client
 '''Example:'''

=== Save ===
----
Saves your current location. See also load command
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' No
 '''Syntax:'''
* <code>/lua save </code> - Saves current location to temporary cache
* <code>/lua save <name></code> - Saves current location <name> for current map
 '''Example:'''

=== Teleport ===
----
Teleports one client to another
 '''Aliases:''' tp
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua teleport <clientname></code> - Teleports you to client
* <code>/lua teleport <clientname> <clientname></code> - Teleports client1 to client2
 '''Example:'''

=== Update ===
----
Updates user's key. There is no error checking in this
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua update <username> <key> <value></code> - Updates <username> <key> to <value>
* <code>/lua update all <key> <value></code> - Updates everyone's <key> to <value>
 '''Example:'''
* <code>/lua update Steve42 username steve_42</code> - Updates Steve42's username to steve_42
=== ViewFollowers ===
----
Views who is spectating who
 '''Aliases:''' followers vf
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua viewfollowers </code> -
 '''Example:'''

=== ViewLog ===
----
Views log for this match
 '''Aliases:''' log viewlogs vl
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua viewlog </code> - Shows entire log
* <code>/lua viewlog <page></code> - Shows page of log
* <code>/lua viewlog bots</code> - Shows only events from bots
* <code>/lua viewlog nobots</code> - Shows only events from players
* <code>/lua viewlog find <text></code> - Shows only events that contain <text>
 '''Example:'''

=== Wiki ===
----
Create wiki commands
 '''Aliases:'''
 '''Required Level:''' nil
 '''Required Login:''' No
 '''Required Auth:''' No
 '''Available in Console:''' Yes
 '''Syntax:'''
* <code>/lua wiki </code> -
 '''Example:'''

LESM Installation

2015-04-30T23:22:23Z

Zelly: Added Commands info

LESM

2015-04-24T01:37:08Z

Zelly: /* Contents */

LESM Getting Started

2015-04-24T01:35:47Z

Zelly: Created a getting started page

== Help ==
First and foremost is you should be able to use the help command.
<code>/lhelp</code> Will display how all your available commands (Which can vary depending on your level and permissions)
<code>/lhelp register</code> Will display help for the register command
All commands have a decent explanation on what they are used for. So use lhelp before you use a command, to be sure you are using it correctly.
You can also get the same help info by typing: <code>/register help</code>
== Creating a Profile ==
First thing you will need to do is create a profile you will need to use the register command with a username and a password.
<code>/register <username> <password>
/register Zelly secretpassword
</code>
Note: Please choose a unique password you have never used before.
== View ==
You can view online users with <code>/view</code> or <code>/view online</code>
View a list of everyone registered with <code>/view all</code>
You can also view a specific user by typing <code>/view username</code>
== Edit ==
Client specific features are usually toggled with the edit command.
Type <code>/edit</code> to view a list of keys you can edit.
Type <code>/edit key</code> to toggle a boolean key on or off.
Type <code>/edit key value</code> for string and number keys.
There are location keys that you can control where stuff is printed to you (If at all) the valid locations for those are: print,printclean (Only you console), chat,chatclean (The chat area),echo,echoclean (The obituary area) , CenterPrint , centerprintclean ( Right above your chat area ), banner , bannerclean (The top of the screen), server(Uses server defined default) , none (Disables this specific print)
The "clean" version is the one that is not formatted(defined by the server) it will still have color codes.
Example of formatted version: '''>> This is a message <<'''
Example of non-formatted version: '''This is a message'''
== Autologin ==
By default your account will automatically login to your guid,silentid, and ip. Whenever found. If you have people on your network/computer you may not want this behavior.
Perhaps you only want to login when you connect with your silentid.
You would type <code>/autologin guid</code> and <code>/autologin ip</code> to reset your autologinip and autologinguid. To set them to your current ip/guid just type that again.(Use <code>/autologin silent</code> for silentid)
You may disable autologin altogether with <code>/autologin</code> then you can only access your profile if you manually login with the login command.
=== Login ===
To login it is same as register <code>/login username password
/login Zelly secretpassword</code>
To logout you can do just <code>/logout</code>
== Authorized Profile ==
To make someone an authorized user you can do use the update command. If it is the first authorized user you will need to do it via rcon(requires lua first argument): <code>lua update testuser authorize true</code>
TestUser will now have access to multiple new commands. He can also now update other users to authorize as well with same syntax ingame.

LESM Installation

2015-04-24T00:58:17Z

Zelly: Added updating section

LESM Installation

2015-04-23T18:59:22Z

Zelly: /* Install */ Added info on fs_homepath

LESM

2015-04-18T23:46:58Z

Zelly: Added features link

LESM Features

2015-04-18T23:46:05Z

Zelly: Intial features page.

(Work in progress)
== Config ==
There are many features so to start off there is a Config.json that you can use to configure all features in the lua. Between this Config.json and Commands.json you can(should be able to, if I forgot an option please notify me) disable all features. Many of the features have several options to them as well, which I may not have included in feature list.
== Commands ==
There are over 75 commands to use. Each command can be disabled or set a required level to use.

== Profiles ==
A profile system where the client can set keys to decide what features he wants and where certain messages print to. Also their are stat tracking keys he can view his own or other players with profiles (offline or online). There are keys to define info about the player such as xfire, realname , age. Depending on server options xp can be saved to the profile so you do not need to worry about etkey/silentid, you would just need your password. Admins can force registration, allow autoprofile creation, or disable profiles altogether (By disabling the commands). By default profiles will automatically be logged into when you connect to the server, if you have other people on your network/computer you can turn this off to only login on your specific guid/silentid or only on your ip, or not at all(In which case you will have to manually log in every time you connect to the server.)

== Regular User Data ==
Admin info to be saved to a client that is applied at all times. Such as warnings/ignoredplayers/xp/mutetime.
== Mail ==
Send offline mail messages to other profiles, also any automatic admin action( if enabled ) will be reported to an admin-mail where only admins can see. The report command will also notify admin-mail. Example: /report Joe was being very rude.
Will report the client who reported and at what time you can then go back in your logs to that timestamp and find out what happen.
== Non-Shrubbot ==
There is a small admin system that can be used for non-shrubbot servers, such as levels( As many as you want ), xpsave, and many of the basic commands: admintest finger warn mute blacklist(Which is basically kick/ban)
== AutoLevel ==
You can define an automatic level range. You choose the beginning level and the ending level and then you choose a basexp and a xp modifier. It will then level the first level when basexp is reached and from then on it will take last level xp (First one would be basexp) times xpmodifier. Example: Level 1: 500 , Level 2: 750 , Level 3: 1125 , Level 4: 1687 etc...
== Server Enhancements ==
=== Setlevel ===
Setlevel can be configured to only allow setting a level when you are at least 2 levels above the player.
=== Ignore ===
You can permanently ignore a player. Also if you wish to still see their chats but do not want to hear the sounds they play you can ignore their sounds. Or you can just ignore lua sounds altogether. (Vsays currently can't be ignored at the moment unless you ignore the player altogether, will look more into it)
=== Mute ===
Mute now has an option to strictmute which will mute them permanently until unmuted, as well as block them from doing commands, changing name , calling votes , and sending privatemessages. Basically it only allows them to play.
=== Warn ===
A new warn system can be used which is basically the same as silent's but instead of using silent mod kick it will use whatever option the server administrator has set when max warns is reached. This is useful because when lua warns it sends it to admin-mail when and why it warned the player.
=== Blacklist ===
Blacklist is my replacement for kick/ban once again when a kick/ban is done it will automatically get reported to admin-mail. You can also add notes on the ban and edit time in game. (see blacklist command for more details)
=== Intermission ===
To help people to start voting during intermission the server can display when someone is ready and when someone votes a map.(It can also display only when they do both) It can block players from voting if they are muted, or if they are spectator, or if they are not logged in.
== AdminWatch ==
Admins with the authorized status can enable a adminwatch to constantly have a live feed to events on the server, such as who called a vote, what command was silently done, team and buddy chat, as well as private messages.
== SpawnWalkThrough ==
Walk through your teammates when you spawn to avoid blocking.
== DamagePrint ==
Print each damage dealt and received by who and with what weapon. Currently limited to only silent and legacy mod. Silent mod can only output damage received and will not who has dealt it. (Has to be enabled server and client side)
== PauseStart ==
A lot of people didn't understand why I had this on my server so I will try and explain it
After warm-up ends the game loads everything and starts the match
On the server end this is almost instant, and is usually why the bots are already a good 20 feet out of spawn already when the game starts
On the clients end this takes about 1-3 seconds(Depending on your computers ability) Where you get that yellow bar and are holding W to try to be the first out of spawn
If I send the command pause and unpause right at the beginning this allows everyone to start the game at the exact same time(When the pause unpauses)
There is only one side effect really and that is that I cannot pause for less than 10 seconds
So there is inadvertently about 5-7 seconds of waiting for nothing, but I think it is worth it. And would be super helpful in scrims.
I have added a freezestart option where it freezes players for a certain amount of seconds instead.
This coupled with spawnwalkthrough make the startup much more fair.
== PingMonitor ==
Take admin actions on players with constant high ping. Block team command and put spectator. Kick them. Warn them.
== DownloadingSpec ==
Put clients to spec x seconds after warmup if they are still downloading or lagged out.
== Balance ==
Automatically balance teams when they are off. Also can take admin action against them, or just block their team command and force them to a team. Currently this only checks when a player moves to a stacked team, am working on making it more automated as well as an accurate rating balancer.
== Connect ==
Print info of client on connect. Level,Name,Username,Country,ET Version,Protocol. Profiles also have a key to print a greeting message and play a greeting sound, same applies to disconnect. (if enabled)
== DeathDistancePrint ==
Print death distance and hp and by whom and with what weapon. Profiles have the option to enable a metric distance instead of feet and inches. (Configurable)
== Names ==
Automatically rename certain names to a randomly generated name.
=== ClanTag ==
Take admin action against clients that do not have level and are using your clantag.
== Sounds ==
=== Events ===
All sound paths can be changed in the config.
There are sounds for certain events:
Error - for when a command fails or is stopped
Command - for when a command succeeds
Adminwatch - for when you receive an adminwatch message
Autolevel - for when a client levels up via autolevel
Welcome - for when you use the welcome command
Connect - for when a client connects (Is replaced by user key greetingsound if exists)
Disconnect - for when a client disconnects(Is replaced by user key farewellsound if exists)
Blacklist - for when a client is blacklists (Plays to authorized or leaders)
Login - for when you login
Logout - for when you logout
Register - for when you register
Salute - for when a client uses salute command
KillConfirm - for when you get a kill Really simple, but I like it a lot
NewMail - for when you get a new mail message
Afk - for when a client goes away Hello for when a client uses hi command, I just use the hello chat in pak0
Bye - for when a client uses the bye command
PrivateMessage - for when you receive a private message
=== Playsounds ===
Sounds for playsound command and greeting/farewells. You can then have an optional soundpack, or a soundpack with a bunch of sounds. Edit the title/message/tags/level to use all in game.
== Rules ==
A rule list to be easily viewed by your players. Can also globally display a rule on command.
== Banners ==
Banners work the same as rules however you can have them printed every x seconds, and also you can have the rules added to the banner rotation.
== Colors ==
The lua follows a pretty simple 3 color rule: Primary color for most text, Secondary color for important text, Tertiary color for symbols/borders and sometimes to highlight information. You can also change the colors for command types.
== EntityManager ==
The entity manager was at first created to play around with entities and I soon realized the strong potential, it can now be used to inspect your map if you are a map developer, play around with certain fieldnames etc. (I don't know as much about it as I should)
=== AntiRush ===
Entities can be removed at a certain time percentage completed or when a certain amount of players are active.
It can also be reversed so they are removed until a certain amount of time is completed or a certain amount of players is reached (The more likely usage). So you can disable objectives until a certain amount of time has passed. Or disable side path's until a certain amount of players are playing. I have recently added the ability to display a message when the objective is removed, when it is readded, and when a player gets close to the removed objective. Also you can limit the messages to x class and within x distance and isCarryingObjective(for when transmitter is disabled) and on x team.
== MessageFilter ==
There is a grammar/spellcheck(Replaces commonly misspelled words with corrected spelling/punctuation) and nocaps(Makes first word capitalized and last word end with punctuation) and nocolors(removes color codes) and swearfilter(Replaces swear words with random words). All of which can be toggled in your profile, also they can be forced upon you by server setting or an admin. (If for example someone is typing in caps a lot, you can use !nocaps player)
=== Colors ===
<color1> is replaced by the primary color code <color2> secondary color <color3> tertiary color.
=== NameMention ===
You can "mention" people by typing @zelly will get their full name with color codes. Also you can do @last for the last player connected
=== EventMention ===
Kind of expieremental as it has been a little bit glitchy when it comes to vsays.
There are event mentions like: <killer> <victim> <guid> <ip> <lastrevive> <lastheal> <lastammo>
Disclaimer: These may be wrong, jotting down from memory.
=== Format ===
You can change the look of tables, and general messages in the config.
== Karma ==
Give and receive karma(Imaginary useless points). You can give karma to someone that has done something good and take karma from someone who has done something bad. There are 4 values of karma: GoodKarma GoodKarmaOut BadKarma BadKarmaOut. When you give someone a karma you get 1 GoodKarmaOut and they get 1 GoodKarma. When you take karma you get one BadKarmaOut and they get one BadKarma. (Pointless I know, I was bored.)
== DynamiteCounter ==
Configurable dynamite counter.
== ClassHealth ==
Experimental changing of class maxhealth and class regen per second.
== Maplist ==
Use !maps command to get the current rotation and a pool of maps to vote from. (Admin can do !map mapname to load that map)

LESM

2015-03-29T02:20:20Z

Zelly: Started contents

== Lua Enhanced Server Module ==

Lua Enhanced Server Module or LuaESMod or LESM for short, is a server side mod written in lua which aims to provide many features for server admins and their players. It can be used with various mods that support lua 5.1 and up.

It is still very much in development to make all of the features work in a way that can be easily setup for everyone using it. There are still plenty of ideas I have yet to add.

Some features include:
* Entity Manager to block objectives for a certain timelimit or other various tasks
* Dyno Counter
* User profile to save stats and other keys
** Ability to customize where messages are printed (If at all)
** Ability to ignore players permanently
*** Also ability to ignore lua sounds from a user (While still seeing his/her chat)
* Lua Sounds
** Played on certain events such as a confirmed kill
** Playsound command to remove hassle of creating a sound pack with menus
* Ingame Mail System
* Message formatting
** Admins can block users from using caps lock, as well as replace some commonly misspelled words
** Use @playername to get player full name with colors
* And plenty of more features, see features page to see full list
== Contents ==
* [http://mygamingtalk.com/wiki/LESM_Installation Install]

LESM Installation

2015-03-29T02:16:17Z

Zelly: Initial page install page

LESM

2015-03-27T01:13:48Z

Zelly: Initial page to get started