helpy4/Minecraft-Console-Client
1
0
Fork 0
mirror of https://github.com/MCCTeam/Minecraft-Console-Client synced 2026-08-15 13:04:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fix ordered list numbering in docs/guide markdown with mdformat --number

Browse source 
Co-authored-by: milutinke <441903+milutinke@users.noreply.github.com>
Agent-Logs-Url: https://github.com/MCCTeam/Minecraft-Console-Client/sessions/659576c1-9e03-4d03-a9f2-99390ba4f390
This commit is contained in:
copilot-swe-agent[bot] 2026-03-25 17:02:47 +00:00
parent cb4eb15784
commit 3931d15c7d
4 changed files with 64 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/guide/ai-assisted-development.md
View file

@ -615,12 +615,12 @@ The important rule is simple:
The usual order is:
1. `tools/decompile.sh --version <ver>`
1. generate server reports from `server.jar`
1. run `tools/diff_registries.py`
1. regenerate the palettes that actually changed
1. update version routing and packet handling
1. build MCC
1. test against the real target version
2. generate server reports from `server.jar`
3. run `tools/diff_registries.py`
4. regenerate the palettes that actually changed
5. update version routing and packet handling
6. build MCC
7. test against the real target version
That is exactly the sort of work `mcc-version-adaptation` is meant to guide.
@ -663,11 +663,11 @@ Use skills:
Typical flow:
1. Decide whether this should be a standalone `/script` bot or a built-in bot.
1. Use the authoring skill's references and templates.
1. Build MCC.
1. Start a local server and join it.
1. Test the bot behavior through live commands, chat, or event-driven actions.
1. Make sure cleanup paths such as `OnUnload()` are correct.
2. Use the authoring skill's references and templates.
3. Build MCC.
4. Start a local server and join it.
5. Test the bot behavior through live commands, chat, or event-driven actions.
6. Make sure cleanup paths such as `OnUnload()` are correct.
For standalone script work, the skill defaults to `/script` unless built-in repo wiring is explicitly needed.
@ -712,6 +712,6 @@ Use skills:
Typical flow:
1. Re-read the relevant skill files and repo tools.
1. Update the guide so the written process matches the real process.
1. Keep the instructions concrete enough that another contributor can follow them without guessing.
1. If the workflow itself changed, update the relevant skill too instead of leaving the docs ahead of the automation.
2. Update the guide so the written process matches the real process.
3. Keep the instructions concrete enough that another contributor can follow them without guessing.
4. If the workflow itself changed, update the relevant skill too instead of leaving the docs ahead of the automation.

24
docs/guide/chat-bots.md
View file

@ -955,9 +955,9 @@ redirectFrom:
**Steps for using this bot (with the default setting)**
1. Hold a fishing rod and aim towards the sea before login with MCC
1. Make sure `AutoFish` is `enabled` in config file
1. Login with MCC
1. You will be able to see the log "Fishing will start in 3.0 second(s).".
2. Make sure `AutoFish` is `enabled` in config file
3. Login with MCC
4. You will be able to see the log "Fishing will start in 3.0 second(s).".
- **Settings:**
@ -1628,13 +1628,13 @@ redirectFrom:
1. Go to the [Discord Developer Portal](https://discord.com/developers/applications/) and click **New Application**.
1. Give it a name (this is what shows up in your Discord status, e.g. "Minecraft Console Client"), accept the terms, and click **Create**.
2. Give it a name (this is what shows up in your Discord status, e.g. "Minecraft Console Client"), accept the terms, and click **Create**.
1. On the **General Information** page, copy the **Application ID** and paste it into the `ApplicationId` field in your MCC configuration.
3. On the **General Information** page, copy the **Application ID** and paste it into the `ApplicationId` field in your MCC configuration.
1. *(Optional)* If you want a custom image in your status, go to the **Rich Presence** tab and click **Art Assets**. Upload an image and give it a name (the **key**). Use that key in the `LargeImageKey` or `SmallImageKey` settings. The default value `mcc_icon` references a built-in MCC icon already registered on the application -- no upload needed if you are happy with that.
4. *(Optional)* If you want a custom image in your status, go to the **Rich Presence** tab and click **Art Assets**. Upload an image and give it a name (the **key**). Use that key in the `LargeImageKey` or `SmallImageKey` settings. The default value `mcc_icon` references a built-in MCC icon already registered on the application -- no upload needed if you are happy with that.
1. Enable the bot by setting `Enabled` to `true` in your MCC configuration and start MCC with Discord already running.
5. Enable the bot by setting `Enabled` to `true` in your MCC configuration and start MCC with Discord already running.
Discord updates Rich Presence at most once every 15 seconds regardless of how often MCC sends updates, so you may notice a short delay before your status reflects changes.
@ -2711,11 +2711,11 @@ redirectFrom:
- **Setup:**
1. First you need to create a Telegram bot and obtain an API key, to do so, go to Telegram and find @botfather
1. Click on `Start` button and read the bot reply, then type `/newbot`, the Botfather will guide you through the bot creation.
1. Once you create the bot, copy the **API key** that you have gotten, and put it into the `Token` field of `ChatBot.TelegramBridge` section (this section).
1. Then launch the client and go to Telegram, find your newly created bot by searching for it with its username, and open a DM with it.
1. Click on `Start` button and type and send the following command `.chatid` to obtain the chat id.
1. Copy the chat id number (eg. `2627844670`) and paste it in the `ChannelId` field and add it to the `Authorized_Chat_Ids` field (in this section) (an id in "Authorized_Chat_Ids" field is a number/long, not a string!), then save the file.
2. Click on `Start` button and read the bot reply, then type `/newbot`, the Botfather will guide you through the bot creation.
3. Once you create the bot, copy the **API key** that you have gotten, and put it into the `Token` field of `ChatBot.TelegramBridge` section (this section).
4. Then launch the client and go to Telegram, find your newly created bot by searching for it with its username, and open a DM with it.
5. Click on `Start` button and type and send the following command `.chatid` to obtain the chat id.
6. Copy the chat id number (eg. `2627844670`) and paste it in the `ChannelId` field and add it to the `Authorized_Chat_Ids` field (in this section) (an id in "Authorized_Chat_Ids" field is a number/long, not a string!), then save the file.
Now you can use the bot using it's DM.
<div class="custom-container danger"><p class="custom-container-title">Danger</p>

70
docs/guide/installation.md
View file

@ -47,9 +47,9 @@ If you want to modify the code and you are new to C# or programming in general,
Install [Git](https://www.git-scm.com/)
1. Make a new folder where you want to keep the source code
1. Then open it up, hold `SHIFT` and do a `right-click` on the empty white space in the folder
1. Click on `Git Bash Here` in the context menu
1. Clone the [GitHub repository](https://github.com/MCCTeam/Minecraft-Console-Client) by running:
2. Then open it up, hold `SHIFT` and do a `right-click` on the empty white space in the folder
3. Click on `Git Bash Here` in the context menu
4. Clone the [GitHub repository](https://github.com/MCCTeam/Minecraft-Console-Client) by running:
```bash
git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive
@ -62,41 +62,41 @@ git submodule update --init --recursive
```
5. Once the repository has been cloned, you can close the `Git Bash` terminal emulator
1. Open up the new cloned folder
6. Open up the new cloned folder
#### Download translation resources (optional)
1. Visit [MCC project's homepage on Crowdin](https://crowdin.com/project/minecraft-console-client).
1. You will need to log in to your Crowdin account in order to download.
1. Click on the language you want to download the translation for.
1. Find `MinecraftClient` -> `Resources` -> `Translations` -> `MCC in-app text`
1. Click the button `•••` at the end of the line.
1. Click Download and save the file to folder `/MinecraftClient/Resources/Translations/`.
1. Find `MinecraftClient` -> `Resources` -> `ConfigComments` -> `Comments in the settings file`
1. Click the button `•••` at the end of the line.
1. Click Download and save the file to folder `/MinecraftClient/Resources/ConfigComments/`.
1. Find `MinecraftClient` -> `Resources` -> `AsciiArt` -> `ASCII Arts (Please use fixed-width fonts for editing)`
1. Click the button `•••` at the end of the line.
1. Click Download and save the file to folder `/MinecraftClient/Resources/AsciiArt/`.
1. If you need to download a translation in another language, go to step 3 to continue.
01. Visit [MCC project's homepage on Crowdin](https://crowdin.com/project/minecraft-console-client).
02. You will need to log in to your Crowdin account in order to download.
03. Click on the language you want to download the translation for.
04. Find `MinecraftClient` -> `Resources` -> `Translations` -> `MCC in-app text`
05. Click the button `•••` at the end of the line.
06. Click Download and save the file to folder `/MinecraftClient/Resources/Translations/`.
07. Find `MinecraftClient` -> `Resources` -> `ConfigComments` -> `Comments in the settings file`
08. Click the button `•••` at the end of the line.
09. Click Download and save the file to folder `/MinecraftClient/Resources/ConfigComments/`.
10. Find `MinecraftClient` -> `Resources` -> `AsciiArt` -> `ASCII Arts (Please use fixed-width fonts for editing)`
11. Click the button `•••` at the end of the line.
12. Click Download and save the file to folder `/MinecraftClient/Resources/AsciiArt/`.
13. If you need to download a translation in another language, go to step 3 to continue.
#### Building using the Visual Studio
1. Open up the `MinecraftClient.sln` via Visual Studio
1. Right click on `MinecraftClient` solution in the `Solution Explorer`
1. Click on `Properties`
1. Open up the `Build` tab and select configuration `Release`
1. Press `CTRL + S` and close the file
1. Right click on `MinecraftClient` solution in the `Solution Explorer`
1. Click `Build`
2. Right click on `MinecraftClient` solution in the `Solution Explorer`
3. Click on `Properties`
4. Open up the `Build` tab and select configuration `Release`
5. Press `CTRL + S` and close the file
6. Right click on `MinecraftClient` solution in the `Solution Explorer`
7. Click `Build`
If the build succeeds, the published binary `MinecraftClient.exe` will be in `MinecraftClient/bin/Release/net10.0/win-x64/publish/`.
#### Building using .NET manually without Visual Studio
1. Open the `Minecraft-Console-Client` folder you've cloned or downloaded
1. Open the PowerShell (`Right-Click` on the whitespace and click `Open PowerShell`, or in Windows Explorer: `File -> Open PowerShell`)
1. Install the .NET 10 SDK if you do not already have it. The easiest current option on Windows is:
2. Open the PowerShell (`Right-Click` on the whitespace and click `Open PowerShell`, or in Windows Explorer: `File -> Open PowerShell`)
3. Install the .NET 10 SDK if you do not already have it. The easiest current option on Windows is:
```powershell
winget install Microsoft.DotNet.SDK.10
@ -152,7 +152,7 @@ Requirements:
#### Cloning using Git
1. Open up a terminal emulator and navigate to the folder where you will store the MCC
1. Recursively clone the [GitHub repository](https://github.com/MCCTeam/Minecraft-Console-Client) by running:
2. Recursively clone the [GitHub repository](https://github.com/MCCTeam/Minecraft-Console-Client) by running:
```bash
git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive
@ -160,7 +160,7 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive
3. Go to the folder you've cloned (should be `Minecraft-Console-Client`)
1. Install the .NET 10 SDK.
4. Install the .NET 10 SDK.
- On Ubuntu 24.04 LTS, use the built-in Ubuntu package feeds:
@ -171,15 +171,15 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive
- On macOS, the normal path is to use the official installer from the [.NET download page](https://dotnet.microsoft.com/en-us/download). Pick `Arm64` for Apple Silicon and `x64` for Intel Macs.
1. If you want to download translation resources, please check out [Download translation resources](#download-translation-resources-optional)
5. If you want to download translation resources, please check out [Download translation resources](#download-translation-resources-optional)
1. Run the following command for a normal local build:
6. Run the following command for a normal local build:
```bash
dotnet build MinecraftClient.sln -c Release
```
1. Run the following command if you want a release-like published binary that matches the repo's CI workflow:
7. Run the following command if you want a release-like published binary that matches the repo's CI workflow:
- On Linux:
@ -247,7 +247,7 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive
```
2. Navigate to `Minecraft-Console-Client/Docker`
1. Build the image using the following command
3. Build the image using the following command
```bash
docker build -t minecraft-console-client:latest .
@ -370,8 +370,8 @@ We use `proot-distro`, an official Termux utility, to install Ubuntu. It will in
Open Termux and run the following commands one at a time, in order:
1. `pkg update`
1. `pkg upgrade`
1. `pkg install proot-distro`
2. `pkg upgrade`
3. `pkg install proot-distro`
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
@ -554,9 +554,9 @@ Here is a [YouTube video](https://youtu.be/42fwh_1KP_o) that explains it in more
</div>
1. `ssh` and `ssh-keygen` commands (on Windows they are available with Git Bash; on macOS and Linux they should be available by default. If not, install them first.)
2. `ssh` and `ssh-keygen` commands (on Windows they are available with Git Bash; on macOS and Linux they should be available by default. If not, install them first.)
1. Basic knowledge of Linux shell commands, terminal emulator usage, SSH and Nano editor.
3. Basic knowledge of Linux shell commands, terminal emulator usage, SSH and Nano editor.
If you already know this, feel free to skip.

6
docs/guide/websocket/README.md
View file

@ -11,18 +11,18 @@ You load it as a standalone script with `/script ChatBots/WebSocketBot.cs`.
## Quick Start
1. Copy `config/ChatBots/WebSocketBot.cs` into your MCC `config/ChatBots/` folder (it ships in the repo under that path).
1. Open the file and edit the line near the top:
2. Open the file and edit the line near the top:
```csharp
MCC.LoadBot(new WebSocketBot("127.0.0.1", 8043, "CHANGE_THIS_PASSWORD"));
```
- Replace `127.0.0.1` with the IP to bind (use `+` or `*` for all interfaces).
- Replace `8043` with your preferred port.
- Replace `CHANGE_THIS_PASSWORD` with a strong, unique password.
1. Optionally enable debug logging:
3. Optionally enable debug logging:
```csharp
MCC.LoadBot(new WebSocketBot("127.0.0.1", 8043, "mypassword", debugMode: true));
```
1. In MCC, run: `/script ChatBots/WebSocketBot.cs`
4. In MCC, run: `/script ChatBots/WebSocketBot.cs`
The bot starts a WebSocket server. Connect to `ws://127.0.0.1:8043/` with any WebSocket client.