spawner
CLI + TUI game server manager. Currently supports Minecraft Java Edition (Vanilla, Paper, Fabric, Forge).
Install
Requires Python 3.10+ and Java 17+.
pipx install spawner-mc
Or install with pip:
pip install spawner-mc
For development:
git clone https://github.com/peroxide-dev/spawner.git && cd spawner
pip install -e .
Quickstart
spawner start
This launches an interactive setup wizard that walks you through:
- Server name
- Server type (Vanilla / Paper / Fabric / Forge)
- Minecraft version (fetched from official APIs)
- Jar source (auto-download or provide path)
- RAM allocation (with 50% hard cap)
- CPU cores
- Port configuration
- UPnP port forwarding (automatic)
- Server directory
- Review and confirm
After confirmation, spawner creates the server directory, downloads the jar, and opens a full-screen TUI with live console, player list, resource monitoring, and a file browser.
Commands
| Command | Description |
|---|---|
spawner start |
Run setup wizard, create server, open TUI |
spawner start <name> |
Relaunch a saved profile directly into TUI |
spawner list |
Show all saved profiles with status |
spawner delete <name> |
Delete a profile (with confirmation) |
spawner stop <name> |
Gracefully stop a running server |
spawner restart <name> |
Stop and relaunch a server |
TUI Controls
Keybinds
| Key | Action |
|---|---|
s |
Stop server |
r |
Restart server |
c |
Toggle command input bar |
f |
Open file browser |
q |
Quit (stops server, cleans up UPnP) |
Escape |
Close overlays |
Panels
- Console — live scrolling server log output
- Player List — click a player name for Op / Kick / Ban actions
- Resources — CPU and RAM bars (server process + system), refreshes every 2s
File Browser
Press f to open a full-screen file browser. Click files to edit, Ctrl+S to save.
Profiles
Server configurations are saved to ~/.spawner/profiles.json and can be relaunched with spawner start <name>.
Downloaded jars are cached at ~/.spawner/jars/.
Supported Server Types
- Vanilla → Official Mojang server
- Paper → High-performance Spigot fork
- Fabric → Lightweight modding platform
- Forge → Full modding framework
Dependencies
1 maintainer
Metadata
1 maintainer
Release files for spawner-mc 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| spawner_mc-0.1.0.tar.gz | 22.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| spawner_mc-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 50.8 kB
Release files / spawner_mc-0.1.0.tar.gz
| Download URL | spawner_mc-0.1.0.tar.gz |
|---|---|
| Size | 22.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a8914af550f451e6c19148dc8f54db88246a1431390dab6f1d3c44e027b2b6b7
|
|
BLAKE2b-256 checksum How to use checksums |
6b3633e46d59987a82e5570e1d9235e7537e47c7bf62607afcf141f7b7bbeee4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 28, 2026.
Transparency logRelease files / spawner_mc-0.1.0-py3-none-any.whl
| Download URL | spawner_mc-0.1.0-py3-none-any.whl |
|---|---|
| Size | 28.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc90a99ae0e07fb37f031a04e4ccc8745271ee615f1f28e097b1fe2a52ed97f2
|
|
BLAKE2b-256 checksum How to use checksums |
1e68935c50a7e05c8e5140da8f3cdeff0f8edfa1d427cc3c82af1a61cb01e162
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 28, 2026.
Transparency log
