explaingit

xdrushxd/dragonwilds-dedicatedserver-companion

Analysis updated 2026-05-18

0PythonAudience · ops devopsComplexity · 2/5LicenseSetup · moderate

TLDR

A small self-hosted API that reports live player counts, uptime, and resource use for a RuneScape: Dragonwilds dedicated server.

Mindmap

mindmap
  root((Dragonwilds Companion))
    What it does
      Report player count
      Report server uptime
      Report CPU and RAM
    Tech stack
      Python
      Flask
      Docker
    Use cases
      Homepage dashboard
      Homelab monitoring
      REST API access
    Roadmap
      Discord alerts
      Web dashboard
      Backup monitoring

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Show live Dragonwilds server status, player names, and uptime on a Homepage self-hosted dashboard.

USE CASE 2

Poll the REST API from a script to alert when the server's last save is too old.

USE CASE 3

Monitor CPU and memory usage of a self-hosted game server without logging into the box directly.

USE CASE 4

Run the companion as a systemd service on a bare Linux host instead of Docker.

What is it built with?

PythonFlaskDocker

How does it compare?

xdrushxd/dragonwilds-dedicatedserver-companion0xallam/my-recipe0xhassaan/nn-from-scratch
Stars00
LanguagePythonPythonPython
Last pushed2022-11-22
MaintenanceDormant
Setup difficultymoderatemoderatemoderate
Complexity2/52/54/5
Audienceops devopsgeneraldeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Needs Docker (or Python/Flask) plus access to the game server's save file directory.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

In plain English

Dragonwilds Dedicated Server Companion is a lightweight helper API for people running their own dedicated server for the game RuneScape: Dragonwilds. It is built for self hosted setups, homelabs, and dashboard tools like Homepage, giving server owners a simple way to see what is happening on their game server at a glance. The companion watches the running server and reports live details such as how many players are online right now, their names, how long the server has been running, when the game world was last saved, the world's name, and how much CPU and memory the server process is using. All of this is exposed as a small REST API that returns a JSON object, so other tools, scripts, or dashboards can read it easily. The recommended way to run it is with Docker. You clone the repository, edit a docker-compose.yml file to point at your server's save folder and set the maximum number of players, then start it with a single command. Once running, the API is reachable over HTTP at a chosen port, and the README includes a ready made widget configuration for the Homepage dashboard project so the server's status can appear alongside other self hosted services. A manual installation path is also documented for people who prefer not to use Docker: cloning the repository directly onto a Linux server, installing Python and Flask, editing a few configuration values in the app's source file, and running it directly or as a systemd service. The project is still adding features. Its roadmap lists a Discord webhook for notifications, a proper web dashboard, an official Docker image, backup monitoring, and a checker for Steam updates as planned next steps. It is released under the MIT license.

Copy-paste prompts

Prompt 1
Help me set up dragonwilds-DedicatedServer-Companion with Docker Compose and point it at my save folder.
Prompt 2
Show me how to add a custom Homepage widget that reads a JSON status API like this one.
Prompt 3
Write a Flask endpoint that reports Docker container CPU and memory usage as JSON.
Prompt 4
Explain how to run this companion API as a systemd service on Linux instead of Docker.

Frequently asked questions

What is dragonwilds-dedicatedserver-companion?

A small self-hosted API that reports live player counts, uptime, and resource use for a RuneScape: Dragonwilds dedicated server.

What language is dragonwilds-dedicatedserver-companion written in?

Mainly Python. The stack also includes Python, Flask, Docker.

What license does dragonwilds-dedicatedserver-companion use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

How hard is dragonwilds-dedicatedserver-companion to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is dragonwilds-dedicatedserver-companion for?

Mainly ops devops.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.