WolfAdmin

This page explains you how to install the WolfAdmin module on your Wolfenstein: Enemy Territory or ET: Legacy server.

Table of contents
  1. Installation
  2. Standalone mode added in 1.2.0
  3. Updates

Support & bugs

In case you run into trouble and need support for WolfAdmin, check out the #wolfadmin IRC channel on Quakenet. You may also contact me via mail or via one of the communities where I usually hang around.

For bug reports or feature requests, please use the bug tracker.

Installation standalone add-on added in 1.2.0

As of version 1.2.0, there exist two ways of installing WolfAdmin on your server: an automated script (Linux only), and a manual install.

Requirements

To run WolfAdmin on your server, you must meet some requirements.

  • A working Wolfenstein: Enemy Territory server
  • A Lua-compatible mod (e.g. Legacy, NoQuarter, ETPub, sIlent)
  • Lua 5.1 or higher and Lua modules enabled (installed binaries)
  • A database is required if you want to use the player database. Supported systems:
    • SQLite3
    • MariaDB/MySQL
    In this case the module also requires the LuaSQL library

In case you do not have some of the libraries installed or available, you are able to download them from the file database.

Automated (experimental)

Please follow the instructions below to install WolfAdmin on your server. At the moment, only a Bash script is available.

  1. Copy and unzip the WolfAdmin file in a directory of your choice
  2. Run the deploy.sh script
  3. Fill in the required credentials and information
  4. Let the script copy the required files and create the database
  5. (optional) Disable shrubbot using instructions below
  6. (optional) Modify shrubbot.cfg to add WolfAdmin specific flags
  7. Add /luascripts/wolfadmin/main.lua to the lua_modules CVAR
  8. Run your server

Manual

Please follow the instructions below to install WolfAdmin on your server.

  1. Copy the /luascripts directory into your mod directory
  2. Copy the contents of the /config directory into your mod folder (e.g. legacy or nq) in fs_homepath
  3. Modify wolfadmin.toml to your needs
  4. (optional) Disable shrubbot using instructions below
  5. (optional) Modify shrubbot.cfg to add WolfAdmin specific flags
  6. Run the .sql script in /database/new on your server:
    • for SQLite3, run sqlite3.sql in your SQLite3 CLI or manager
    • for MySQL, run mysql.sql in your MySQL manager
  7. Add /luascripts/wolfadmin/main.lua to the lua_modules CVAR
  8. Run your server

Menu

If you want to use the menu, follow the instructions below.

  1. Copy the .pk3 file corresponding to the WolfAdmin version you downloaded to your mod folder in fs_basepath

Standalone mode added in 1.2.0

To run the module in standalone mode, you might have to disable the built-in shrubbot system. This is not needed in the case of Legacy, since they do not have shrubbot built-in.

To disable shrubbot, you only have to change a CVAR to a selected value, which is listed below.

Mod CVAR Value
ETPub g_shrubbot ""
Legacy none
NoQuarter g_shrubbot ""
silEnt g_dbDirectory ""

Upon restart, WolfAdmin will automatically detect that shrubbot has been disabled and run in standalone mode. In case this does not happen, it is possible to override the installation mode using the standalone setting (more info).

Installation add-on 1.0.0-1.1.x

Before version 1.2.0, the module can only be run in add-on mode on NoQuarter servers. The ability to run the module on other mods cannot be guaranteed.

Requirements

To run WolfAdmin on your server, you must meet some requirements.

  • A working Wolfenstein: Enemy Territory server
  • NoQuarter mod (1.2.7 or higher recommended)
  • Lua 5.1 or higher and Lua modules enabled (installed binaries)
  • A database is required if you want to use the player database. Supported systems:
    • SQLite3
    • MariaDB/MySQL
    In this case the module also requires the LuaSQL library

In case you do not have some of the libraries installed or available, you are able to download them from the file database.

Manual

Please follow the instructions below to install WolfAdmin on your server.

  1. Copy the /luascripts directory into your /nq directory
  2. Copy the contents of the /config directory into your /nq in fs_homepath
  3. (optional) Copy the contents of the cvars.cfg to your own server configuration file
  4. Modify /nq/wolfadmin.cfg to your needs
  5. Modify /nq/shrubbot.cfg to add WolfAdmin specific flags
  6. Run the .sql script in /database/new on your server:
    • for SQLite3, run wolfadmin_sqlite3.sql in your SQLite3 CLI or manager
    • for MariaDB/MySQL, run wolfadmin_mysql.sql in your MySQL manager
  7. Add /luascripts/wolfadmin/main.lua to the lua_modules CVAR
  8. Run your server

Menu

If you want to use the menu, follow the instructions below.

  1. Copy the .pk3 file corresponding to the WolfAdmin version you downloaded to your /nq directory

Updates

Please follow the instructions below to update WolfAdmin.

  1. Delete the /luascripts/wolfadmin or /luascripts/wolfadmin directory in your mod directory
  2. Copy the /luascripts directory into your mod directory
  3. Run the .sql script in /database/upgrade/<previous version> on your server:
    • for SQLite3, run sqlite3.sql in your SQLite3 CLI or manager
    • for MariaDB/MySQL, run mysql.sql in your MySQL manager
  4. Optionally, replace the .pk3 file with the new one

Configuration

Once you have finished setting up the module and have confirmed it's working, you can continue to configure the module.