Skip to content

Latest commit

 

History

History
102 lines (62 loc) · 2.56 KB

README.md

File metadata and controls

102 lines (62 loc) · 2.56 KB
Raw

McServerWrapper

A python package which wraps around a minecraft server, providing easy access for other programs which want to programmatically manage minecraft servers.

Overview

Supported Minecraft versions

Vanilla

Supports versions 1.7.10 to 1.20.4 (excluding 1.8.0, which is severely bugged, 1.8.1+ is fine)

Forge

Supports versions 1.7.10 to 1.16.5 as well as 1.20.3 to 1.20.4

Supported operating systems

Tested to work on Windows 10 and Ubuntu.

Different Linux distros and Windows 11 might work as well. If not, please open a new issue.

Installation

PyPi

Not yet available

Github

To install the latest version directly from Github, run the following command:

pip install git+https://github.com/mcserver-tools/mcserverwrapper.git

This will automatically install all other dependencies.

Usage

A simple usage example is shown below:

from mcserverwrapper import Wrapper

wrapper = Wrapper("/my/server/directory/server.jar")
wrapper.startup()
wrapper.send_command("/say hello minecraft")
wrapper.stop()

In this example, a minecraft server is started by providing the path to its server.jar file. After startup, it sends a command to the server. Finally, the server is stopped gracefully.

More examples can be found in the examples folder.

Run tests locally

In order to run tests locally, there are a few things that have to be setup:

Add credentials for testing

To simulate a player connecting ot the server, it needs to authenticate against microsofts servers. This means, that a microsoft account which owns Minecraft is needed. Don't worry, the credentials are only saved locally.

Create a new file named password.txt in the repository root and add the following content (without the brackets):

(username-here)
(password-here)

Node

Node 20 is needed to use MineFlayer.

Windows

It can be downloaded from here.

Debian/Ubuntu

Install it using the commands found (here)[https://github.com/nodesource/distributions?tab=readme-ov-file#debian-and-ubuntu-based-distributions].

MineFlayer

To simulate a player connecting to the test server, MineFlayer is used.

It can be installed by running

npm install mineflayer

Java

To actually run a minecraft server, a Java 21 JRE needs to be installed and added to the path.

Download it from (here)[https://adoptium.net/temurin/releases/].

Run tests

After installing all of the requirements, the tests can be ran using

python -m pytest