@kchips/mcman

Minecraft Server Manager

A Minecraft CLI app to quickly install and manage Minecraft servers

🚀 Features

• Quick interactive server setup: Quickly set up Minecraft servers with specific versions and configurations
• Customizable Server Configurations: Specify memory allocation, server ports, and online modes
• Server List Management: Save, list, and remove server configurations for easy reusability

📦 Installation

npm install -g @kchips/mcman

📋 Commands

init

Initialize a new project with a specific Minecraft version.

mcman init [path] [options]

Options:

• -v, --mc-version <version>: Specify the Minecraft version.
• -b, --build <build>: Specify the build to download.
• -e, --accept-eula: Accept the Minecraft EULA.
• -p, --port <port>: Specify the port to run the server on.
• -o, --online-mode: Enable online mode.

Example:

mcman init ./myserver -v 1.20.1 -e -p 25565 -o

---

start

Start a server.

mcman start [name] [options]

Options:

• --flags <flags>: Specify the Java flags to use.
• --gui: Open the server gui.
• -m, --memory <memory>: Specify the amount of memory to allocate.

Example:

mcman start myserver -m 4G --gui

---

save

Save the current directory as a server.

mcman save [path] [options]

Options:

• -n, --name <name>: Specify the name of the server.

Example:

mcman save ./myserver -n myserver

---

ls (alias: list)

List all saved servers.

mcman ls

Example:

mcman ls

---

rm

Remove a saved server.

mcman rm <name>

Example:

mcman rm myserver

---

config

Open the configuration file in the default editor.

mcman config

Example:

mcman config

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.