Skip to content

Scripted management, statistics, and bot for Killing Floor 2 server.

License

Notifications You must be signed in to change notification settings

WilliamBrown42/kf-magicked-admin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Killing Floor 2 Magicked Administrator

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 administrator, 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.

Player commands

  • !me - display a summary of your stats
  • !stats player - display a summary of player's stats
  • !help - displays the help text in chat
  • !info - displays information about this project
  • !dosh - display the players recorded dosh and rank by dosh
  • !top_dosh - displays the players with the highest recorded dosh
  • !kills - display the players recorded kills and rank by kills
  • !top_kills - displays the players with the most recorded kills
  • !server_kills - displays total number of zeds killed on the server
  • !server_dosh - displays total dosh earned on the server

Admin commands

  • !difficulty {normal|hard|suicidal|hell} - sets difficulty of next game
    • Example: !difficulty hard
  • !length {short|medium|long} - sets length of next game
    • Example: !length medium
  • !start_tc n command - repeat command every n seconds
    • Example: !start_tc 5 say test
  • !stop_tc - stop all timed commands
  • !start_wc n command - run command when wave n is reached.
    • Example: !start_wc say Wave Started. - posts a message EVERY wave.
    • Example: !start_wc 4 say Wave 4 Started. - This posts a message when wave 4 starts.
  • !stop_wc - stop all wave commands
  • !start_trc command - run command every time the trader opens
    • Example: !start_trc say Traders open.
  • !stop_trc - stop trader commands
  • !say mesg - display mesg in the chat, generally for use in conjuction with other commands
    • Example: !say This is an example.
  • !silent - toggles output in chat
  • !restart - immediately restarts the current map
  • !load_map map_name - immediately loads map_name
  • !toggle_pass - toggles the configured game password (specified in magicked_admin.conf)

Other features

  • Writing a server_name.motd file with pairs of %PLR and %SCR and enabling the motd_scoreboard option will put a live scoreboard in the motd.
    • %SRV_D and %SRV_K will be replaced by the total dosh and kills on the server respectively.
  • Writting a server_name.init with a list of commands will run the commands when the bot starts on server_name

Dependancies/building

  • Python 3.4+
  • cx_freeze
  • requests
  • lxml
  • colorama
  • termcolor

build by running the provided scripts build.bat or build.sh after installing dependancies via pip.

Minimal configuration

If running from source you will need to copy the example configs from the config folder to the root folder, the build scripts do this automatically. After the cofiguration is present, edit these lines in magicked_admin.conf to match your server details:

address = 127.0.0.1:8080
username = Admin
password = 123

See the Steam guide for more detailed usage information

Running

Run python main.py (python 3 is required!) if executing from source. If you're using a binary execute magicked_admin.exe.

Packages

No packages published

Languages

  • Python 99.8%
  • Other 0.2%