one_click_kag_server is a program which tries to fully automate the creation of a King Arthur's Gold server.

Related tags

General Utilitieskag
Overview

one_click_kag_server

one_click_kag_server is a program which tries to fully automate the creation of a King Arthur's Gold server.

It will:

  • Create a virtual machine for you on DigitalOcean
  • Configure the machine to run KAG
  • Create SSH keys
  • Upload and setup mods
  • Setup security configuration such as list of admins
  • Deploy the KAG server with automatic restarts enabled

It can also help with common maintenance tasks such as:

  • Restarting the server with different configuration, such as new mods
  • Viewing the server logs
  • Opening a TCPR console
  • Opening an SSH connection to the server

Everything can be configured from a single config file (see config.yaml).

This is a viable alternative to running a server on your local machine, without the hassle of setting up port forwarding etc. It's also an alternative to dedicated KAG hosting sites such as https://gshost.us/, with the advantage of costing less and not charging based on configuration such as max players. For example, a minimum spec server on DigitalOcean costs $0.007/hour or $5/month (see here). Since this project makes it easy to create and delete servers, you may want to run a more expensive, powerful machine for just a couple of hours and then delete it when you're done.

kagtcprlib example

An admin interface for RCON access can be deployed with the rcon command, using kagtcprlib.

Contact Eluded#1367 on Discord if you have any feedback or need help getting set up.

Instructions

Setup

Before using one_click_kag_server, there are a few things to setup.

  1. Install Python (3.7+) on your system. https://www.python.org/downloads/
  2. Clone this repository. If you don't have Git installed you can also click Code -> Download ZIP from GitHub.
  3. Install one_click_kag_server requirements. Open a terminal in this directory and run pip install -r requirements.txt
  4. Make an account on DigitalOcean. See https://cloud.digitalocean.com/registrations/new
  5. Setup a payment method on DigitalOcean
  6. Create an API token on DigitalOcean.
    • Go to API
    • Click Generate New Token
    • Choose a name for the token and give it both read and write scope

Estimated time: ~10 minutes.

Creating a server

This section describes how to create a server, assuming you have followed the setup instructions above.

  1. Edit config.yaml with a text editor to configure your server.
    • secrets
      • digitalocean_key the DigitalOcean API token you created earlier. Do not share this with anyone, since it gives full access to your account.
    • droplet configures the virtual machine
      • name is the name of the virtual machine (make sure it only contains characters URL-safe characters, so no spaces)
      • region is the short name (a.k.a. slug) for the DigitalOcean region to deploy the server in. If you want a US based server you can leave it as nyc1. For an EU server you could try ams3. For a full list of possible regions see https://slugs.do-api.dev/ (open the Regions tab).
      • image is the type of virtual machine to deploy. Don't change this unless you know what you're doing.
      • size_slug is the size of the machine to deploy. Think about this carefully because there are many options, though more powerful machines are more expensive. For a full list of possible sizes see https://slugs.do-api.dev/ (open the Droplet Sizes tab).
      • backups is whether or not to configure backups. You shouldn't need them, since it's so easy just to delete and re-create your server later.
    • kag configures the KAG server
      • autoconfig can contain any regular option from KAG's autoconfig.cfg
        • sv_name the name of the server
        • sv_info the server description
        • sv_maxplayers the max number of players
        • sv_gamemode the gamemode (e.g. TDM or CTF)
        • sv_register whether to list the server publicly
        • sv_password the password to connect to the server (can be empty for a public server)
        • sv_rconpassword the RCON password for the server
        • security_seclevs path to seclevs file. Don't change this.
      • mods is a list of mods to use. If you add a mod here, also copy it into the Mods directory in this project.
      • security
        • superadmins list of usernames of superadmins
        • admins list of usernames of admins
  2. Open a terminal in this directory and run python -m one_click_kag_server.main up to deploy the server.
    • You should see a bunch of log messages whilst the server is being configured.
    • After around 2 minutes the server should be ready, and you should see a message saying DONE. Server running at {ip_address}. Your server should be ready to play on.

If you wish to have multiple config files with different names then you can pass the --config-file option to switch between them.

Remember to destroy the droplet with one_click_kag_server down once you've finished with the server, since it will be costing you money as long as it's running.

If you have any issues with the above then please report them to me on Discord (Eluded#1367).

Commands

one_click_kag_server offers a few different commands for maintenance of the server.

up

Run python -m one_click_kag_server.main up to deploy the virtual machine and start KAG.

down

Run python -m one_click_kag_server.main down to destroy the virtual machine.

restart-kag

Run python -m one_click_kag_server.main restart-kag to restart the KAG server. This will also upload any new mods or configuration, for example if you've changed autoconfig in config.yaml.

kag-logs

Run python -m one_click_kag_server.main kag-logs to view the KAG logs in real-time.

ssh

Run python -m one_click_kag_server.main ssh to open an SSH connection to the server. This requires SSH to be installed on your system.

rcon

Run python -m one_click_kag_server.main rcon to open a web based RCON client for remote administration of the KAG server.

Important notes

State

Information about the server is stored in a state file (by default state.pkl in this directory). Every time one_click_kag_server runs, this file is updated. If you delete or move the file then information about the server will be lost, and one_click_kag_server will create a brand new server if you run it again. If you lose your state file, you may need to manually login to DigitalOcean and delete your droplet(s). Also, if you want to deploy multiple servers then you may need multiple state files (use the --state-file argument to change this.)

SSH Keys

one_click_kag_server creates a new SSH key pair for virtual machines access, and uploads this to your DigitalOcean account. These keys can be found under ssh_keys/. If you want to access the server with some other SSH client then you need to use this key pair. For example $ ssh -i ssh_keys/one_click_kag_server_aa0ff419 root@$SERVER_HOST.

Owner
Benjamin Gorman
Benjamin Gorman
Python utilities for writing cross-version compatible libraries

Python utilities for writing cross-version compatible libraries

Tyler M. Kontra 85 Jun 29, 2022
Analyze metadata of your Python project.

Analyze metadata of your Python projects Setup: Clone repo py-m venv venv (venv) pip install -r requirements.txt specify the folders which you want to

Pedro Monteiro de Carvalho e Silva Prado 1 Nov 10, 2021
A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use that mirror

Kali Mirror Finder Using Single Python File A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use tha

MrSingh 6 Dec 12, 2022
This is a python table of data implementation with styles, colors

Table This is a python table of data implementation with styles, colors Example Table adapts to the lack of data Lambda color features Full power of l

Урядов Алексей 5 Nov 09, 2021
Install, run, and update apps without root and only in your home directory

Qube Apps Install, run, and update apps in the private storage of a Qube. Build and install in Qubes Get the code: git clone https://github.com/micahf

Micah Lee 26 Dec 27, 2022
Small Python script to parse endlessh's output and print some neat statistics

endlessh_parser endlessh_parser is a small Python script that parses endlessh's output and prints some neat statistics about it Usage Install all the

ManicRobot 1 Oct 18, 2021
Dynamic key remapper for Wayland Window System, especially for Sway

wayremap Dynamic keyboard remapper for Wayland. It works on both X Window Manager and Wayland, but focused on Wayland as it intercepts evdev input and

Kay Gosho 50 Nov 29, 2022
These scripts look for non-printable unicode characters in all text files in a source tree

find-unicode-control These scripts look for non-printable unicode characters in all text files in a source tree. find_unicode_control.py should work w

Siddhesh Poyarekar 25 Aug 30, 2022
A collection of tools for biomedical research assay analysis in Python.

waltlabtools A collection of tools for biomedical research assay analysis in Python. Key Features Analysis for assays such as digital ELISA, including

Tyler Dougan 1 Apr 18, 2022
✨ Un générateur de lien raccourcis en fonction d'un lien totalement fait en Python par moi, et en français.

Shorter Link ❗ Un générateur de lien raccourcis en fonction d'un lien totalement fait en Python par moi, et en français. Dépendences : pip install pys

MrGabin 3 Jun 06, 2021
Personal Toolbox Package

Jammy (Jam) A personal toolbox by Qsh.zh. Usage setup For core package, run pip install jammy To access functions in bin git clone https://gitlab.com/

5 Sep 16, 2022
Set of scripts for some automation during Magic Lantern development

~kitor Magic Lantern scripts A few automation scripts I wrote to automate some things in my ML development efforts. Used only on Debian running over W

Kajetan Krykwiński 1 Jan 03, 2022
A simple gpsd client and python library.

gpsdclient A small and simple gpsd client and library Installation Needs Python 3 (no other dependencies). If you want to use the library, use pip: pi

Thomas Feldmann 33 Nov 24, 2022
Python Random Number Genrator

This Genrates Random Numbers. This Random Number Generator was made using python. This software uses Time and Random extension. Download the EXE file and run it to get your answer.

Krish Sethi 2 Feb 03, 2022
A plugin to simplify creating multi-page Dash apps

Multi-Page Dash App Plugin A plugin to simplify creating multi-page Dash apps. This is a preview of functionality that will of Dash 2.1. Background Th

Plotly 19 Dec 09, 2022
A python module for extract domains

A python module for extract domains

Fayas Noushad 4 Aug 10, 2022
Daiho Tool is a Script Gathering for Windows/Linux systems written in Python.

Daiho is a Script Developed with Python3. It gathers a total of 22 Discord tools (including a RAT, a Raid Tool, a Nuker Tool, a Token Grabberr, etc). It has a pleasant and intuitive interface to faci

AstraaDev 32 Jan 05, 2023
A simple tool to move and rename Nvidia Share recordings to a more sensible format.

A simple tool to move and rename Nvidia Share recordings to a more sensible format.

Jasper Rebane 8 Dec 23, 2022
Random Number Generator

Application for generating a random number.

Michael J Bailey 1 Oct 12, 2021
Exports the local variables into a global dictionary for later debugging.

PyExfiltrator Julia’s @exfiltrate for Python; Exports the local variables into a global dictionary for later debugging. Installation pip install pyexf

6 Nov 07, 2022