Skip to content

task-v1/LumiNESK

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Warning

The project status of LumiNESK is currently active development (Beta). The tool is well-suited for small private servers and plugin development; however, at this stage, it is not recommended for large commercial projects (Production) without prior testing. Use it at your own risk.


License

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

See LICENSE

About

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

Topics

Resources

License

Stars

Watchers

Forks

Contributors