Skip to main content

Nukkit Engine Servers Kit (LumiNESK): CLI manager for Nukkit-based Minecraft servers.

Project description

LumiNESK logo

LumiNESK

Nukkit Engine Servers Kit

CLI manager for Minecraft servers based on Nukkit-family engines

PyPI - Version GitHub Release Tests


About the Project

LumiNESK is a tool for managing Minecraft Bedrock Edition servers running on Nukkit-based engines.

The project is designed for:

  • local server development
  • small production deployments
  • convenient management of multiple servers

LumiNESK combines:

  • CLI (command-line interface)
  • TUI (interactive terminal interface)
  • Web GUI (browser-based interface)

Supported engines: Nukkit, PowerNukkitX, Nukkit-MOT, Lumi.


Features

  • create and register servers
  • start servers in normal and loop mode
  • stop and force terminate servers
  • manage server engines
  • environment and provider diagnostics
  • TUI interface with live console
  • Web GUI for monitoring
  • manage multiple servers
  • update server engines

Requirements

Component Version Required
Python 3.13+ (3.14 recommended) Not required if you don’t install via pip
Java 21+ Required for running servers
tmux latest Optional (only for TUI/GUI usage)

Installation

Via PyPI (recommended)

pip install luminesk
uv pip install luminesk
pipx install luminesk

Download prebuilt binaries

Prebuilt binaries are available in the releases section. For Windows: luminesk-windows-amd64.exe For Linux: luminesk-linux-amd64 For macOS: luminesk-darwin-arm64

Example (Linux)

chmod +x luminesk-linux-amd64
luminesk-linux-amd64 --help

Example (Windows)

luminesk-windows-amd64 --help

Example (macOS)

chmod +x luminesk-darwin-arm64
luminesk-darwin-arm64 --help

Installation from source

git clone https://github.com/astra-v1/LumiNESK
cd LumiNESK

uv venv
uv sync

uv run nesk --help # short alias for luminesk

Building a binary

Uses PyInstaller.

Linux/macOS:

pyinstaller --onefile --name luminesk \
  --add-data "luminesk/gui/templates:luminesk/gui/templates" \
  --add-data "luminesk/gui/static:luminesk/gui/static" \
  --add-data "luminesk/tui/styles:luminesk/tui/styles" \
  luminesk/__main__.py

Windows:

pyinstaller --onefile --name luminesk ^
  --add-data "luminesk\\gui\\templates;luminesk\\gui\\templates" ^
  --add-data "luminesk\\gui\\static;luminesk\\gui\\static" ^
  --add-data "luminesk\\tui\\styles;luminesk\\tui\\styles" ^
  luminesk/__main__.py

Quick Start

Show help:

nesk --help

Check environment and sources:

nesk doctor

Create a server:

nesk create -n "My Server" -d ./servers/my -c nukkit -t my_server
# Parameters are optional — Wizard Setup will start if omitted

Start a server:

nesk start -t my_server
# or run inside the server directory

Stop a server:

nesk stop -t my_server
# or run inside the server directory

List servers:

nesk list

Working with tmux

LumiNESK uses tmux to manage server consoles in TUI/GUI mode.

Attach to a console:

tmux attach-session -t luminesk-<server-tag>

Roadmap

Planned features:

  • Plugin manager and DevTools-like system (similar to PMMP)
  • Remote server management (yes, SSH exists, but still)
  • Docker support
  • Automatic and manual backups
  • Cluster mode implementation
  • One-line curl install script (for those who don’t want Python/pip or manual binary downloads)
  • ...and maybe more

License

The project is licensed under GPL-3.0-or-later.

See LICENSE

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

luminesk-0.15.tar.gz (88.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

luminesk-0.15-py3-none-any.whl (83.3 kB view details)

Uploaded Python 3

File details

Details for the file luminesk-0.15.tar.gz.

File metadata

  • Download URL: luminesk-0.15.tar.gz
  • Upload date:
  • Size: 88.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for luminesk-0.15.tar.gz
Algorithm Hash digest
SHA256 08a10a0d4338e6a3b8a74a5c903f63d8fddd76bc3d78fa90b3d3241b6284acb3
MD5 39637e9ecd9537d112436eea395bba1a
BLAKE2b-256 d6ed9b6d0e5a5404a309d8ce50b9c5bfe6734df39953e8cacfa0a2aa24e2293f

See more details on using hashes here.

Provenance

The following attestation bundles were made for luminesk-0.15.tar.gz:

Publisher: ci.yml on astra-v1/LumiNESK

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file luminesk-0.15-py3-none-any.whl.

File metadata

  • Download URL: luminesk-0.15-py3-none-any.whl
  • Upload date:
  • Size: 83.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for luminesk-0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 37367d8b9576da4f5aca16c5794e948223134358d04b721c97a0a1fb504585f4
MD5 7a908416391a431644fb0680b33071ac
BLAKE2b-256 57097e28a238a681eeb7c11335c949237f775a0d0f2cba31375737743d9d9551

See more details on using hashes here.

Provenance

The following attestation bundles were made for luminesk-0.15-py3-none-any.whl:

Publisher: ci.yml on astra-v1/LumiNESK

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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