Skip to main content

A CLI for managing game servers using Docker.

Project description

Wilfred

Build Status Python Versions pypi wilfred 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
    • Waterfall
    • Bedrock
  • Multi Theft Auto
  • Voice Servers
    • Mumble

Installation

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

Quickstart

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.

Contributing

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!

Credits

Created, written and maintained by Vilhelm Prytz.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wilfred-0.4.0.tar.gz (38.8 kB view details)

Uploaded Source

Built Distribution

wilfred-0.4.0-py36-none-any.whl (25.0 kB view details)

Uploaded Python 3.6

File details

Details for the file wilfred-0.4.0.tar.gz.

File metadata

  • Download URL: wilfred-0.4.0.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

File hashes

Hashes for wilfred-0.4.0.tar.gz
Algorithm Hash digest
SHA256 13da7a329cb66202cbf705534640b536f3746c50fbec38cb2964de0e055a58f0
MD5 fa66355ea6d165fc4454c4ae44dcb092
BLAKE2b-256 df3ee66b13427ed2dd737e624f756585d1a9b6badb565a24bd975cf731ac48e3

See more details on using hashes here.

File details

Details for the file wilfred-0.4.0-py36-none-any.whl.

File metadata

  • Download URL: wilfred-0.4.0-py36-none-any.whl
  • Upload date:
  • Size: 25.0 kB
  • Tags: Python 3.6
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

File hashes

Hashes for wilfred-0.4.0-py36-none-any.whl
Algorithm Hash digest
SHA256 c26684160287aa0585fd9f22f3aa132670e264a28ce13af00b5e5f307e06c472
MD5 f889568c465b912e184ffd4ec98cf081
BLAKE2b-256 00eba65eb0c4b208865aec6386aa736187d4af72a1eb4333013b4e78a2f0153d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page