Metadata-Version: 2.1
Name: mserv
Version: 0.8.2
Summary: A simple wrapper for managing your Minecraft servers.
Home-page: https://github.com/mexiquin/mserv
Author: Quinton Jasper
Author-email: dropatuningmetal@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: beautifulsoup4 (>=4.9.3,<5.0.0)
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: requests (>=2.25.0,<3.0.0)
Requires-Dist: rich (>=9.8.0,<10.0.0)
Project-URL: Repository, https://github.com/mexiquin/mserv
Description-Content-Type: text/markdown

# mserv
A simple wrapper for managing your Minecraft servers.

## What is it?
Mserv is a little commandline utility I wrote in Python to help me better
manage my, and my friend's Minecraft servers.  

Mojang offers a DIY *server.jar* file 
which you can execute and host a server on your own PC for free. But, what if I wanted
separate servers? What if I don't care to go to the Minecraft website and download the file myself?
Or, what if I don't care to remember the server execution parameters?  

Mserv serves to simplify many of these processes, and should make efforts to help those less tech-savvy.

## What can it do?
This is a wrapper around the official server.jar from Mojang
As of right now, it can...

- Download and generate files from the official server executable
- Start and shutdown the server
- Displays network connection information (public ip, port number) so others can join your server
- Can update the server executable (This is still in testing)

## What can it NOT do?
This script can not:
- Port forward for you (You have to do that yourself)
- Execute multiple servers at the same time

# Installation

- Requires system-wide Java JRE to be installed

1. EASY - Use Python's package manager pip:
  ```shell
  pip install mserv
  ```

or  

2. TRICKY - Clone this repository:
```shell
git clone https://github.com/mexiquin/mserv.git
```  

Then execute mserv.py located in the *mserv* directory
```shell
python3 ./mserv/mserv/mserv.py
```

# Generated Help Page
```
Usage: mserv.py [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  gui     Executes the user interface for mserv
  run
  setup   Create a new server.
  update  Download a fresh server.jar file from Mojang.

```


