Skip to content

wilfred-dev/wilfred

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Wilfred

.github/workflows/check.yml Python Versions pypi Language grade: Python Total alerts Downloads Discord Code style: black

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
    • Spigot
    • SpongeVanilla
    • Waterfall
    • Bedrock
  • Mindustry
  • Multi Theft Auto
  • Voice Servers
    • TeamSpeak 3
    • Mumble

Installation

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

Quickstart

Make sure you have Docker installed (see the official documentation for more info). The recommended way of installing Wilfred is via Homebrew. Once brew is installed, Wilfred can easily be installed from the official tap.

brew tap wilfred-dev/wilfred
brew install wilfred

Want the bleeding edge? You can install the latest commit using --HEAD (bugs are to be expected, don't use in production environments!).

brew tap wilfred-dev/wilfred
brew install --HEAD wilfred

Wilfred can also be installed using pip. You need to use Python 3.7 or newer to run Wilfred.

pip install wilfred --upgrade

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

Creating a server in Wilfred

To create your first server, use wilfred create. Most values have a default value, where you can just press return to use them.

Wilfred will ask you which "image" to use. An image is a set of configuration files that defines a specific game within Wilfred. These images are not to be confused with Docker images, Wilfred images sort of wrap around the Docker images. A couple of games are already built into Wilfred, but you can also create your own.

Then, Wilfred will ask you to set any environment variables (if available for that image). The environment variables differ from game to game and most of them have a default value.

Once the server is created, you can use wilfred servers to list available servers. To start it, use wilfred start <name>. To attach to the server console, you can use wilfred console <name>. If you want to start the server and attach to the server console in a single command, you can use wilfred start <name> --console (it will start the server and then immediately attach to the server console).

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.

Copyright (C) 2020-2022, Vilhelm Prytz, vilhelm@prytznet.se