README.md

SteveProxy

Minecraft: Java Edition Proxy

🤔 What's this?

SteveProxy - proxy for Minecraft: Java Edition.
The presence of an intermediary between the client and the server allows you to modify/send new packets.
This makes it possible to change the behavior of the client and create plugins whose capabilities are limited only to Minecraft functions.
The proxy fully implements the ability to create custom plugins, which you can interact with using chat or built-in modules.

📦 Installation

Node.js 17.1+

1. Configure config.json file.
2. Run npm i.
3. Run npm start.
4. Connect to localhost:25565 server.

🔧 Built-in modules

Module	Description
ChatManager	Module for creating dynamic pages with which you can interact in the in-game chat. Includes pagination system and callback buttons.
PacketManager	Allows you to catch and modify any packets sent by the client to the server and vice versa, up to the cancellation of their sending.
PagesBuilder	Create interactive pages based on the Minecraft inventory interface. It includes a pagination system, callback buttons, as well as some built-in components & methods to simplify the building of pages.
QuestionBuilder	Module for creating Q&A constructs with waiting for the user's answer in the chat, as well as intermediate validation of answers.
PluginManager	Registration and interaction with other plugins.
Context	Set of functions to simplify working with node-minecraft-protocol.
API	Set of methods for interacting with some HTTP APIs.
Auth	Module for Minecraft authentication using Xbox Live services.

🔌 Plugins

Plugin	Description
Core	Core plugin.
Chat	Features to improve the chat.
Discord	Discord Rich Presence integration.
VK	VK Integration.
Spotify	Spotify Integration.
Skin	Plugin for changing the skin directly in the game with a list of skins from the Minecarft Launcher library.
Names	Getting the history of nicknames of Minecraft players.

---

SteveProxy is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.