https://github.com/yvanmazy/remotedminecraft

Library to run Minecraft from code and control it remotely.
https://github.com/yvanmazy/remotedminecraft

integration-testing library minecraft remote

Last synced: about 1 year ago
JSON representation

Library to run Minecraft from code and control it remotely.

• Host: GitHub
• URL: https://github.com/yvanmazy/remotedminecraft
• Owner: YvanMazy
• License: mit
• Created: 2024-11-07T17:43:31.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-03-04T15:02:42.000Z (about 1 year ago)
• Last Synced: 2025-03-04T16:20:47.908Z (about 1 year ago)
• Topics: integration-testing, library, minecraft, remote
• Language: Java
• Homepage:
• Size: 176 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: .github/README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🎮 RemotedMinecraft

**RemotedMinecraft** is a **Java** library that allows you to run a Minecraft client and control it remotely.

📄 **Summary:**

- [✨ Features](#-features)

- [🎯 Use cases](#-use-cases)

    - [🧪 Integration Testing](#-integration-testing)

    - [🤖 Automation](#-automation)

- [⚙️ How to use](#-how-to-use)

## ✨ Features

- Use the real Minecraft vanilla client

- Java 17+

- Completely configurable

- Support simultaneous agents

- Permissive license (MIT)

## 🎯 Use cases

There are several ways to use this library. Below you will find examples of common usage. An example module is available

[here](../example).

### 🧪 Integration Testing

Integration tests on Minecraft are **very difficult** to set up, this library aims to facilitate this task by managing

the

installation, preparation and control of a completely vanilla Minecraft client.

This can be used as a component in integration tests for development on server software like Spigot but also for proxies

like BungeeCord. Otherwise, it is also possible to use it in large-scale tests to test several software.

### 🤖 Automation

This library can also be used to automate tasks on servers or single player worlds.

For example, to explore, mine, harvest resources, etc.

**Warning**: Most servers prohibit the use of automated programs, consult the rules before considering this use. You are

also subject to the [Minecraft usage rules](https://www.minecraft.net/en-us/usage-guidelines).

### ⚙️ How to use

  Install Dependency

  **Latest version**: [![Release](https://jitpack.io/v/YvanMazy/RemotedMinecraft.svg)](https://jitpack.io/#YvanMazy/RemotedMinecraft)

  

  **Gradle**:

  ```groovy

  repositories {

      maven { url 'https://jitpack.io' }

  }

  

  dependencies {

      implementation 'com.github.YvanMazy:RemotedMinecraft:VERSION'

  }

  ```

  

  **Maven**:

  ```xml

  

      

          jitpack.io

          https://jitpack.io

      

  

  

      

          com.github.YvanMazy

          RemotedMinecraft

          VERSION

      

  

  ```

**Usage:**

*Documentation for using the code is not yet done and will be in a page in the Wiki section.*

**Examples:**

- [Example module](../example)

- [TransferProxy integration tests](https://github.com/YvanMazy/TransferProxy/tree/master/core/src/integrationTest)