Scripted management, statistics, and bot for ranked Killing Floor 2 servers. Provides in-game commands, player stat tracking and ranking, live MOTD scoreboard and stats, greeter, and admin functions. Running entirely through the web admin, it does not affect a server's ranked/custom status. It can be ran either directly on the server or remotely, and manage multiple servers at once.
The most recent stable version is 0.1.6. A binary is provided on the releases page for Windows and Linux users.
Old releases
When inputting commands into the chat they need to be prefixed with !.
When writting commands into a script, or chaining them this should be
omitted.
Many commands will look for closest matches to their parameters. For example 'biotics' will match 'kf-biotics-lab' and 'userO' will match 'userOne™/@:®'.
All commands have in-game help text that can be accessed with the -h flag.
- Example:
!commands -h
All commands also have the following flags.
-q- Suppresses output-p- Pads output to hide the username line
Escape sequences as follows are available to format messages.
\n- Newline- Example:
!say line 0\nline 1
- Example:
\t- Tab- Example:
!say line 0\n\tline 1 is indented
- Example:
Commands that can be executed by any player.
Click to see the player commands!
!commands- Shows a list of all commands available to players!stats <user>- Shows general statistics about a user- Example:
!statsShows stats about yourself - Example:
!stats the_zShows stats about the_z
- Example:
!kills <user>- Shows kill statistics about a user- Example:
!killsShows kill stats about yourself - Example:
!kills the_zShows kill stats about the_z
- Example:
!dosh <user>- Shows dosh statistics about a user- Example:
!doshShows dosh stats about yourself - Example:
!dosh the_zShows dosh stats about the_z
- Example:
!time <user>- Shows time statistics about a user- Example:
!doshShows time stats about yourself - Example:
!dosh the_zShows time stats about the_z
- Example:
!map- Shows statistics about the current map!record_wave- Shows the highest wave achieved on the current map!top_kills- Shows the global kills leaderboard!top_dosh- Shows the global dosh leaderboard!top_time- Shows the global play time leaderboard!top_wave_kills- Shows information about who killed the most ZEDs in the current wave. Generally for use withstart_trc- Example:
!start_trc -- top_wave_kills
- Example:
!top_wave_dosh- Shwows information about who earned the most dosh in the current wave. Generally for use with!start_trc- Example:
!start_trc -- top_wave_dosh
- Example:
!server_kills- Shows total kills on the server!server_dosh- Shows total dosh earned on the server!scoreboard- Shows the complete player scoreboard, useful on servers with >6 max players- Alias:
!sbDoes the same
- Alias:
!game- Shows information about the current game!maps [--all]- Shows the current map cycle- Option
-a: Show all available maps
- Option
!player_count- Shows the player count and max players
Commands that can be ran by server administrators or users authorized with
the !op command.
Click to see the admin commands!
!op <user>- Gives a user administrative rights- Example:
!op the_z
- Example:
!deop <user>- Revokes a user's administrative rights- Example:
!deop the_z
- Example:
!say <message>- Echoes a message into chat- Example:
!say The quick brown fox jumps over the lazy dog - Example:
!start_trc -- say The trader is open
- Example:
!players- Shows detailed information about players on the server!kick <user>- Kicks<user>from the match- Example:
!kick the_z
- Example:
!ban <user>- Bans<user>from the server- Example:
!ban the_z - Warnng: The web admin currently has a bug that causes bans to persist after they are deleted, thus there is no unban command
- Example:
!length <length>- Change the length to<length>next game- Example:
!length short
- Example:
!difficulty <difficulty>- Change the difficulty to<difficulty>next game- Example:
!difficulty hell
- Example:
!game_mode <game_mode>- Immediately change the game mode to<game_mode>- Example:
!game_mode endlessChanges the game mode to Endless
- Example:
!load_map <map>- Immediately change the map to<map>- Example:
!load_map bioticsChanges the map to Biotics Lab
- Example:
!restart- Immediately restart the current game!password [--set] <on|off>- Example:
!password onEnables the game password defined in the config - Example:
!password offDisables the game password - Example:
!password --set somePassSets a specific password
- Example:
!start_jc [-r] -- <command>- Start a command that runs every time a player joins --rOnly run for returning players- Example:
!start_jc -- say Welcome %PLR- Greets a player on join - Available tokens:
%PLR- username,%KLL- total kills,%DSH- total dosh;%PLR- username,%BCK- "back" if sessions > 1,%DRK- dosh rank,%KRK- kill rank,%TME- play time,%TRK- play time rank,%SES- sessions
- Example:
!stop_jc- Stops all join commands!start_wc [-w <wave>] -- <command>- Start a command that runs on wave<wave>-wWave to run the command on, can be omitted to have the command run every wave-wCan be negative to count backwards from the boss wave- Example:
!start_wc -1 -- say Welcome to the boss wave
!stop_wc- Stops all wave commands!start_tc [-r, -t <seconds>] -- <command>- Start a command that runs after<seconds>seconds- Option
-r: Add to have the command run repeatedly - Option
-t: Required, the number of seconds before the command runs - Example:
!start_tc -rt 600 -- say Join our Steam group!\n http://steam.group/
- Option
!stop_tc- Stops all timed commands!start_trc [-w <wave>] -- <command>- Start a commands that runs when the trader opens-wWave to run the command on, can be omitted to have the command run every wave-wCan be negative to count backwards from the boss wave- Example:
!start_trc -- top_wave_dosh- Shows who earned the most dosh every wave when the trader opens
!stop_trc- Stop all commands that run on trader open!silent- Toggles suppression of all chat output, commands still have effect, but the response will not be visible to players!run <script_name>- Executes a script from theconf/scriptsfolder, more information in the scripts section- Example:
!run example
- Example:
!marquee <marquee_name>- Runs a marquee in the chat from theconf/marqueefolder, experimental- Example:
!marquee example
- Example:
!update_motd <type>- Refreshes the welcome screen leaderboard, type is one of: kills, dosh, or time- Example:
!start_tc 300 -- update_motd kills
- Example:
!reload_motd- Reloads the server's*.motdfile fromconf!alias- Check the help text!alias -h!enforce_dosh <amount>- Kicks all players that have more dosh than the specifiedamount- Example:
!start_tc 600 -- enforce_dosh 60000
- Example:
A sample .motd file is provided in conf/. The filename should match the server's name as
specified in conf/magicked_admin.conf. The template format is Jinja2. An example follows,
please refer to the Jinja2 designer documentation.
Welcome to our server.
{{ millify(server_kills) }} Zeds killed on this server.
Top Players (total dosh):
{% for player in top_dosh[0:9] -%}
{{loop.index}}. {{player.username|truncate(11)}} [{{millify(player.score)}}] {% if loop.index is divisibleby 3 %}
{% endif %}
{%- endfor %}
Have fun and good luck!
Writing a server_name.init in the conf/scripts folder with a series of commands
will run the commands in sequence when the bot starts on server_name.
Additional scripts can be written in the conf/scripts folder and ran with the
!run command. There is an example already in there that can be ran with
!run example.
- Comments can be added to scripts by prefixing a line with
;.
For gamemodes other than survival to function in full patches have to be
applied to the KFGame/Web/ServerAdmin folder on the server. For this reason
a script is provided in the admin-patches folder that will automatically
patch your server.
There is currently no CLI or Windows build for this component. You can run it
with python3 admin-patches/admin-patches.py. A dialogue box will appear
asking you to locate your server.
Basic setup is done on the first run. However this does not cover all of the
options KF2-MA can offer. Please see the config file, conf/magicked_admin.conf,
for more configuration options as some features are disabled by default.
Each server managed by KF2-MA has a section that looks something like
[server_one], followed by several options (x = y). Copy and edit the
default server section if you want to manage multiple servers. [server_one]
is the name of the server, this can be changed to whatever you want.
Options can be configured in the config file conf/magicked_admin.conf.
address- Web address of the server's webadmin panel. Requires scheme and protocol,
e.g.
https://0.0.0.0:8080
- Web address of the server's webadmin panel. Requires scheme and protocol,
e.g.
username- Webadmin username to login with, this will appear in the chat when the bot has something to output. It's recommended to create a separate account for the bot.
password- Webadmin password that matches the username above.
game_password- Default game password to set when the password is toggled using
!password <on|off>.
- Default game password to set when the password is toggled using
refresh_rate- Integer value, webadmin polling rate
Running with docker is easy. Just issue this command:
docker run -it -p 1880:1880 --name kf2-magicked-admin -v '<host config folder location>':'/magicked_admin/conf' th3z/kf2-magicked-admin
You will need to change <host config folder location> to wherever you want
to store your config folder. /mnt/user/appdata/kf2-magicked-admin is a popular
choice for systems running Unraid.
After this command runs the container will exit out and the logs will tell you
to setup the config file. Go to your conf folder and set things up then run
the container again and you are good to go!
If you want to use the admin_patches so that kf-magicked-admin gets installed into your server directory when the container starts (some gamemodes wont track stats without it) just mount your game directory into the container and set the PATCHES_TARGET_DIR env variable to the directory. You can mount multiple directories and just separate them with a comma "," in the env variable if you have many servers. Here is an example:
docker run -it -p 1880:1880 --name kf2-magicked-admin -v '<host config folder location>':'/magicked_admin/conf' -v '<host kf folder>':/kf2-server -v '<host kf folder>':/kf2-server-two -e 'PATCHES_TARGET_DIR'='/kf2-server,/kf2-server-two' th3z/kf2-magicked-admin
Before contributing code you will need to install the Python requirements.
Examples work on Debian 10 and Ubuntu Xenial, may differ for other operating systems. Install the following packages.
- Python 3.7 -
apt install python3 - Pip -
apt install python3-pip - Pybabel -
apt install python3-babel - Python 3 dependencies -
pip3 install -r requirements.txt- This might complain about cx_freeze not installing if you haven't got zlib-dev, but cx_freeze is only needed for building.
git clone https://github.com/th3-z/kf2-magicked-admin.git
cd kf2-magicked-admin
pip3 install -r requirements.txt
make i18n-compile
python3 -O magicked_admin/magicked_admin.py
The -O flag runs the program in release mode, remove it to run KF2-MA in
debug mode. Debug mode will enable more detailed output.
You can build a binary release for distribution with make after installing
both the run and build requirements.
Examples work on Debian 10 and Ubuntu Xenial, may differ for other operating systems.
- Python 3.7 -
apt install python3 - Pybabel -
apt install python3-babel - Pip -
apt install python3-pip - Pip dependencies -
pip3 install -r requirements.txt - Make -
apt install make
On Windows it's recommend to build with Cygwin. However you can also build it
by running python3 setup.py build. Check the makefile for help building the locale files.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent