wilfred 0.5.0

A CLI for managing game servers using Docker.

Wilfred

Wilfred is a command-line interface for running and managing game servers locally. It uses Docker to run game servers in containers, which means they are completely separated. Wilfred can run any game that can run in Docker.

⚠️ Wilfred is currently under development and should not be considered stable. Features may break or may not be implemented yet. Use with caution.

Documentation

The official documentation is available here. For support, use our Discord Chat. For bugs, you can open an issue here.

Supported games

As long as your server can run in Docker, it can probably run using Wilfred (after some tinkering). These are the games supported by default. You can submit new games to wilfred-dev/images.

• Minecraft
  • Vanilla Minecraft
  • BungeeCord
  • Paper
  • Waterfall
  • Bedrock
• Multi Theft Auto
• Voice Servers
  • Mumble

Installation

Please refer to the official documentation for further installation instructions and documentation.

Quickstart

Make sure you have Docker installed (see official documentation for more info). Wilfred can be installed using pip. You need to use Python 3.6 or newer to run Wilfred.

pip install wilfred --upgrade --user

A snap package is also in the works but currently not considered stable.

Once you got Wilfred installed, run wilfred setup to set a path for Wilfred to use to store server files.

Helping

The best places to contribute are through the issue tracker and the official Discord server. For code contributions, pull requests and patches are always welcome!

Contributors ✨

Created, written and maintained by Vilhelm Prytz.