Metadata-Version: 2.5
Name: mcserver-cli
Version: 4.0.0.dev0
Summary: A CLI tool to manage Minecraft: Java Edition servers.
Project-URL: Homepage, https://github.com/Othecat35/MCServer
Project-URL: Repository, https://github.com/Othecat35/MCServer.git
Project-URL: Changelog, https://github.com/Othecat35/MCServer/blob/main/CHANGELOG.md
Author-email: Othecat35 <othecat35@gmail.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# MCServer
## About
A CLI tool to manage Minecraft: Java Edition servers.

## Platform
Supported platforms:
- Linux
- and Termux.

## Requirements
- Python 3.12 or newer (Python 3.14 is recommended)
- JRE (depends on Minecraft version)

## How to install
- Using pip:
1. Run `pip install mcserver-cli`

- System-wide (Requires root): 
1. Download the `mcserver` script file from GitHub releases
2. Move the file to `/usr/local/bin`
3. Run `chmod +x mcserver`

- Per-user:
1. Create a directory "bin"
2. Download the script from GitHub releases onto that directory
3. Give it "executable" permission with `chmod +x mcserver`
4. Add the directory in the PATH environment:
   - Run `export PATH=$HOME/bin:$PATH` if you're using shell that is POSIX-compliant like Bash, Zsh, or ash
   - Run `fish_add_path ~/bin` if you're using FISH

## Usage
- Initialize a server: `mcserver init [options]`
- List operator players: `mcserver op list`
- Start the server: `mcserver start`
- Stop the server: `mcserver stop`
- List whitelisted players: `mcserver whitelist list`

### Example
- Create a 1.20.1 Fabric (0.19.5) server on current directory
```bash
mcserver init --mc-version=1.20.1 --loader=fabric --loader-version=0.19.5
mcserver start
```

- List all operator and whitelisted players on current directory
```bash
mcserver op list
mcserver whitelist list
```
- Stop (sigterm) a server on current directory
```bash
mcserver stop
```


## Note
This is a **Personal Project**, things may be unstable.
