MC Remote Control

MC Remote Control

<div align="center"> <a href="https://discord.gg/2b2tism"> <img src="https://img.shields.io/discord/1340108466370641960?logo=discord" alt="Discord"/> </a> <a href="https://github.com/Cypphi/mc-remote-control"> <img src="https://tokei.rs/b1/github/Cypphi/mc-remote-control?category=code" alt="Total lines of code"/> </a> </div>

Control and view your Minecraft client directly through Discord.

Curious what it can do? Peek at FEATURE_LIST.md for a feature rundown.

Discord

- Join our Discord here for: - Suggestions, support & discussion regarding the mod. - Other Minecraft (or 2b2t) related projects.

Supported versions

Feel free to request additional versions to be supported :) (Join my support Discord.)

| MCRC Version | Minecraft version | |-------------------------------------------------------------------------|-------------------| | 1.1.3 | 1.21.4 & 1.21.10 |

Usage

Here's a quick guide to get started.

1. Installing FabricMC & required mods

- This mod is Fabric-only. Install FabricMC here. - Download the following dependencies: - YetAnotherConfigLib - Fabric API - Mod Menu - Grab the latest release (or the version you need) of MCRC here.

2. Initial launch & configuration

- Launch the client and open the Start on launch menu on the title screen. - Find the MC Remote Control entry and click its icon. - In the config screen, enable Start on launch (startup logic is not implemented yet). - Configure the remaining settings using the next step.

3. Setting up your Discord bot

- Create an application at the OAuth2. - Open the new application and switch to the OAuth2 tab. - Click OAuth2, store the token securely, and paste it into the mod’s third settings tab under “Discord Bot Token.” - In the OAuth2 tab, open the URL generator, enable the bot scope, copy the generated link, and invite the bot to your server. - Enable Developer Mode in Discord (%%MD1%%). - Fill out the remaining three ID fields. To copy an ID, right-click the user/role/channel/server and choose “Copy X ID.” - Discord Channel ID: The channel the bot should monitor. It only responds here. - Allowed Discord User ID: Used only when “Allow Public Commands” is disabled; recommended to keep public commands off. - Discord Guild ID: The server hosting the bot.

4. Relaunch

- Relaunch the client and have fun :) - Run `/help` via the Discord bot to view the available commands. - For more information about the current feature set, check FEATURE_LIST.md.

Controlling the bot in-game

- Run `/mcrc start` from the Minecraft client to manually launch the Discord bot when auto-start is disabled. - Use `/mcrc stop` to shut the bot down without closing your game.

Contributing

- Contributions are welcome! - Follow the existing code style and clearly describe what you changed or added. - Limit each pull request to a single feature; avoid bundling multiple unrelated changes together.

Licensing Notice

- This project uses JDA (Java Discord API) licensed under the Apache License 2.0 - All bundled third-party components are documented in THIRD_PARTY_NOTICES.md.