mirror of
https://github.com/MCCTeam/Minecraft-Console-Client
synced 2025-11-07 17:36:07 +00:00
Fix format
This commit is contained in:
BruceChen
parent
27c40f27d2
commit
5624e77125
245 changed files with 307 additions and 167833 deletions
|
|
@ -1,28 +0,0 @@
|
|||
---
|
||||
home: true
|
||||
heroImage: /images/MCC_logo_with_edge.png
|
||||
tagline: 'Minecraft Console Client (MCC) is a lightweight open-source Minecraft Java client implemented in C#'
|
||||
actions:
|
||||
-
|
||||
text: Installation
|
||||
link: ./guide/installation.md
|
||||
type: primary
|
||||
-
|
||||
text: Learn More →
|
||||
link: ./guide/
|
||||
type: secondary
|
||||
actionText:
|
||||
actionLink:
|
||||
features:
|
||||
-
|
||||
title: Chat
|
||||
details: Chat with other people on the server
|
||||
-
|
||||
title: Automation
|
||||
details: Create bots to do automated tasks
|
||||
-
|
||||
title: Supported Versions
|
||||
details: 1.4 - 1.19.2
|
||||
footer: Made by MCC Team with ❤️
|
||||
---
|
||||
|
||||
|
|
@ -1,163 +0,0 @@
|
|||
# Introduction
|
||||
|
||||
- [About](#about)
|
||||
- [Quick Intro (YouTube Videos)](#quick-intro)
|
||||
- [Features](#features)
|
||||
- [Why Minecraft Console Client?](#why-minecraft-console-client)
|
||||
- [Getting Help](#getting-help)
|
||||
- [Submitting a bug report or an idea/feature-request](#bugs-ideas-feature-requests)
|
||||
- [Important notes on some features](#notes-on-some-features)
|
||||
- [Credits](#credits)
|
||||
- [Disclaimer](#disclaimer)
|
||||
- [License](#license)
|
||||
|
||||
## About
|
||||
|
||||
**Minecraft Console Client (MCC)** is a lightweight cross-platform open-source **Minecraft** TUI client for **Java edition** that allows you to connect to any Minecraft Java server, send commands and receive text messages in a fast and easy way without having to open the main Minecraft game.
|
||||
|
||||
It also provides various automations that you can enable for administration and other purposes, as well as extensible C# API for creating Bots.
|
||||
|
||||
It was originally made by [ORelio](https://github.com/ORelio) in 2012 on the [Minecraft Forum](http://www.minecraftforum.net/topic/1314800-/), now it's maintained by him and many other contributors from the community.
|
||||
|
||||
## Features
|
||||
|
||||
- Chat
|
||||
|
||||
- Send and receive chat messages
|
||||
- [Log chat history](chat-bots.md#chat-log)
|
||||
- [Get alerted on certain keywords](chat-bots.md#alerts)
|
||||
- [Auto Respond](chat-bots.md#auto-respond)
|
||||
|
||||
- [Anti AFK](chat-bots.md#anti-afk)
|
||||
- [Auto Relog](chat-bots.md#auto-relog)
|
||||
- [Script Scheduler](chat-bots.md#script-scheduler)
|
||||
- [Remote Control](chat-bots.md#remote-control)
|
||||
- [Auto Respond](chat-bots.md#auto-respond)
|
||||
- [Auto Attack](chat-bots.md#auto-attack)
|
||||
- [Auto Fishing](chat-bots.md#auto-fishing)
|
||||
- [Auto Eat](chat-bots.md#auto-eat)
|
||||
- [Auto Craft](chat-bots.md#auto-craft)
|
||||
- [Mailer Bot](chat-bots.md#mailer)
|
||||
- [Auto Drop](chat-bots.md#auto-drop)
|
||||
- [Replay Mod](chat-bots.md#replay-mod)
|
||||
- [API for creating Bots in C#](creating-bots.md#creating-chat-bots)
|
||||
- [Docker Support](installation.md#using-docker)
|
||||
- [Inventory Handling](usage.md#inventory)
|
||||
- [Terrain Traversing](usage.md#move)
|
||||
- Entity Handling
|
||||
|
||||
_NOTE: Some of mentioned features are disabled by default and you will have to turn them on in the configuration file and some may require additional configuration on your part for your specific usage._
|
||||
|
||||
## Why Minecraft Console Client?
|
||||
|
||||
- Easy to use
|
||||
- Helpful community
|
||||
- Open-Source
|
||||
- Fast performance
|
||||
- Cross-Platform
|
||||
- Docker Support
|
||||
- 10 years of continuous development
|
||||
- Active contributors
|
||||
- Widely used
|
||||
|
||||
## Quick Intro
|
||||
|
||||
Don't have time to read through the documentation, we got you, our community has made some simple introduction videos about the **Minecraft Console Client**.
|
||||
|
||||
### The list of the tutorials:
|
||||
|
||||
Installation:
|
||||
|
||||
- [Installation on Windows by Daenges](https://www.youtube.com/watch?v=BkCqOCa2uQw)
|
||||
- [Installation on Windows + Auto AFK and More by Dexter113](https://www.youtube.com/watch?v=FxJ0KFIHDrY)
|
||||
|
||||
Using Commands, Scripts and other features:
|
||||
|
||||
- [Minecraft Console Client | Tutorial | Commands, Scripts, AppVars, Matches, Tasks and C# Scripts by Daenges](https://youtu.be/JbDpwwETEnU)
|
||||
- [Console Client Tutorial - Scripting by Zixxter](https://www.youtube.com/watch?v=XE7rYBFJxn0)
|
||||
|
||||
## Getting Help
|
||||
|
||||
MCC has a community that is willing to help, we have a Discussions section in out Git Hub repository.
|
||||
|
||||
Click [here](https://github.com/MCCTeam/Minecraft-Console-Client/discussions) to access it.
|
||||
|
||||
### Before getting help
|
||||
|
||||
- **Please use the search option here or in the discussion section and read the documentation so we avoid duplicate questions. Thank you!**
|
||||
- **Please be kind and patient, respect others as they're the ones using their time to help you**
|
||||
|
||||
## Bugs, Ideas, Feature Requests
|
||||
|
||||
Bug reporting, idea submitting or feature requesting are done in the [Issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues) section of our [Github repository]([here](https://github.com/MCCTeam/Minecraft-Console-Client)).
|
||||
|
||||
Navigate to the Issues section, search for a bug, idea or a feature using the search option here in the documentation and in the `Issues` section on Git Hub before making your own.
|
||||
|
||||
If you haven't found anything similar, go ahead and click on the `New issue` button, then choose what you want to do.
|
||||
|
||||
If you're reporting a bug, please be descriptive as much as possible, try to explain how to re-create the bug, attack screenshots and logs, make sure that you have [`debugmessages`](configuration.me#debugmessages) set to `true` before sending a bug report or taking a screenshot.
|
||||
|
||||
### Before submitting
|
||||
|
||||
- **Please use the search option here or in the `Issues` section and read the documentation so we avoid duplicate questions/ideas/reports. Thank you!**
|
||||
- **Please be kind, patient and respect others. Thank you!**
|
||||
|
||||
## Notes on some features
|
||||
|
||||
### Inventory, Terrain and Entity Handling
|
||||
|
||||
Inventory handling is currently not supported in versions: `1.4.6 - 1.9`
|
||||
|
||||
Terrain handling is currently not supported in versions: `1.4.6 - 1.6`
|
||||
|
||||
Entity handling is currently not supported in versions: `1.4.6 - 1.9` (but `1.8` and `1.9` are being worked on, almost at the working state, only `EntityMetadata` packet remains to be fixed)
|
||||
|
||||
There features might not always be implemented in the latest version of the game, since they're often subjected to major changes by Mojang, and we need some time to figure out what has changed and to implement the required changes.
|
||||
|
||||
If there was a major game update, and the MCC hasn't been updated to support these features, if you're a programmer, feel free to contribute to the project.
|
||||
|
||||
## Credits
|
||||
|
||||
_Project initiated by [ORelio](https://github.com/ORelio) in 2012 on the [Minecraft Forum](http://www.minecraftforum.net/topic/1314800-/)._
|
||||
|
||||
Many features would not have been possible without the help of our talented community:
|
||||
|
||||
**Maintainers**
|
||||
|
||||
ORelio, ReinforceZwei, milutinke, BruceChenQAQ, bradbyte
|
||||
|
||||
**Ideas**
|
||||
|
||||
ambysdotnet, Awpocalypse, azoundria, bearbear12345, bSun0000, Cat7373, dagonzaros, Dids, Elvang, fuckofftwice, GeorgH93, initsuj, JamieSinn, joshbean39, LehmusFIN, maski, medxo, mobdon, MousePak, TNT-UP, TorchRJ, yayes2, Yoann166, ZizzyDizzyMC and [many more](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+%5BIdea%5D+is%3Aopen).
|
||||
|
||||
**Bug Hunters**
|
||||
|
||||
1092CQ, ambysdotnet, bearbear12345, c0dei, Cat7373, Chtholly, Darkaegis, dbear20, DigitalSniperz, doranchak, drXor, FantomHD, gerik43, ibspa, iTzMrpitBull, JamieSinn, k3ldon, KenXeiko, link3321, lyze237, mattman00000, Nicconyancat, Pokechu22, ridgewell, Ryan6578, Solethia, TNT-UP, TorchRJ, TRTrident, WeedIsGood, xp9kus, Yoann166 and [many more](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+%5BBUG%5D+is%3Aopen+).
|
||||
|
||||
**Contributors**
|
||||
|
||||
Allyoutoo, Aragas, Bancey, bearbear12345, corbanmailloux, Daenges, dbear20, dogwatch, initsuj, JamieSinn, justcool393, lokulin, maxpowa, medxo, milutinke, Pokechu22, ReinforceZwei, repository, TheMeq, TheSnoozer, vkorn, v1RuX, yunusemregul, ZizzyDizzyMC, BruceChenQAQ, bradbyte _... And all the [GitHub contributors](https://github.com/MCCTeam/Minecraft-Console-Client/graphs/contributors)!_
|
||||
|
||||
**Libraries:**
|
||||
|
||||
Minecraft Console Client also borrows code from the following libraries:
|
||||
|
||||
| Name | Purpose | Author | License |
|
||||
| ----------- | ---------------- | ---------------- | ------- |
|
||||
| Biko | Proxy handling | Benton Stark | MIT |
|
||||
| Heijden.Dns | DNS SRV Lookup | Geoffrey Huntley | MIT |
|
||||
| DotNetZip | Zlib compression | Dino Chiesa | MS-PL |
|
||||
|
||||
## Disclaimer
|
||||
|
||||
Even if everything should work, we are not responsible for any damage this app could cause to your computer or your server. This app does not steal your password. If you don't trust it, don't use it or check & compile from the source code.
|
||||
|
||||
Also, remember that when you connect to a server with this program, you will appear where you left the last time. This means that **you can die if you log in in an unsafe place on a survival server!** Use the script scheduler bot to send a teleport command after logging in.
|
||||
|
||||
We remind you that **you may get banned** by your server for using this program. Use accordingly with server rules.
|
||||
|
||||
## License
|
||||
|
||||
Minecraft Console Client is a totally free of charge, open source project. The source code is available at [Github Repository](https://github.com/MCCTeam/Minecraft-Console-Client)
|
||||
|
||||
Unless specifically stated, source code is from the MCC Team or Contributors, and available under CDDL-1.0. More info about CDDL-1.0: [http://qstuff.blogspot.fr/2007/04/why-cddl.html](http://qstuff.blogspot.fr/2007/04/why-cddl.html) Full license at [http://opensource.org/licenses/CDDL-1.0](http://opensource.org/licenses/CDDL-1.0)
|
||||
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -1,76 +0,0 @@
|
|||
# Contributing
|
||||
|
||||
At this moment this page needs to be created.
|
||||
|
||||
For now you can use our article from the [Git Hub repository Wiki](https://github.com/MCCTeam/Minecraft-Console-Client/wiki/Update-console-client-to-new-version) written by [ReinforceZwei](https://github.com/ReinforceZwei).
|
||||
|
||||
## Translations
|
||||
|
||||
MCC now supports the following languages (Alphabetical order) :
|
||||
* `de.ini` : Deutsch - German
|
||||
* **`en.ini` : English - English**
|
||||
* `fr.ini` : Français (France) - French
|
||||
* `ru.ini` : Русский (Russkiy) - Russian
|
||||
* `vi.ini` : Tiếng Việt (Việt Nam) - Vietnamese
|
||||
* `zh-Hans.ini` : 简体中文 - Chinese Simplified
|
||||
* `zh-Hant.ini` : 繁體中文 - Chinese Traditional
|
||||
|
||||
### Add new translation
|
||||
|
||||
1. First you need to get the name of the translated file.
|
||||
* Visit [this link](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c) and find the first occurrence of the language you need to translate in the table below.
|
||||
* Use the language code of the row in the table as the name of the translation file.
|
||||
* For example:
|
||||
* `English` -> row `English 0x0009` -> `en` -> `en.ini`
|
||||
* `Chinese (Traditional)` -> row `Chinese (Traditional) 0x7C04` -> `zh-Hant` -> `zh-Hant.ini`
|
||||
|
||||
2. Which system languages are recommended to use this translation?
|
||||
* Still check the table in [this link](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c), one language may have multiple rows.
|
||||
* You will need to indicate which language codes this translation applies to.
|
||||
* For example:
|
||||
* Translation `de.ini` applies to `de`, `de-AT`, `de-BE`, `de-DE`, ...
|
||||
* Translation `zh-Hans.ini` applies to `zh-Hans`, `zh`, `zh-CN`, `zh-SG`.
|
||||
|
||||
3. Which game languages are recommended to use this translation?
|
||||
* Check out the table in [this link](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/2239), where the `Locale Code` column indicates the language code in minecraft.
|
||||
* You will need to indicate which locale codes this translation applies to.
|
||||
* For example:
|
||||
* Translation `fr.ini` applies to `fr_ca`, `fr_fr`.
|
||||
* Translation `zh-Hans.ini` applies to `zh_cn`.
|
||||
|
||||
4. Add the new translation to the code. (Optional)
|
||||
* **If you are not familiar with programming, you can skip this step and just write the above information in your PR or issue.**
|
||||
* Add the newly created translation file `xx.ini` to the project `/Resources/lang/xx.ini`.
|
||||
* Open `/DefaultConfigResource.resx`.
|
||||
* Click `Add Resources`.
|
||||
* Choose `/Resources/lang/xx.ini`.
|
||||
* Rename the added resource file in `/DefaultConfigResource.resx` to `Translation_xx`.
|
||||
* Open `/Translations.cs`.
|
||||
* Find `public static Tuple<string, string[]> GetTranslationPriority();`
|
||||
* Update the mapping of system language codes to translation files.
|
||||
* Find `public static string[] GetTranslationPriority(string gameLanguage);`
|
||||
* Update the mapping of game locale code to translation files.
|
||||
|
||||
5. Follow the section "Update existing translation".
|
||||
|
||||
### Update existing translation
|
||||
|
||||
1. Visit [the lang folder](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/Resources/lang), download `en.ini` and the language you want to translate(`xx.ini`).
|
||||
|
||||
2. Compare `en.ini` and `xx.ini` and update outdated or non-existent entries in `xx.ini`.
|
||||
|
||||
3. Once you finished the translation work, submit a pull request or send us the file through an [Issue](https://github.com/MCCTeam/Minecraft-Console-Client/issues) in case you are not familiar with Git.
|
||||
|
||||
### Translate README.md
|
||||
|
||||
1. Get the English version of the README.md from [here](https://raw.githubusercontent.com/MCCTeam/Minecraft-Console-Client/master/README.md).
|
||||
|
||||
2. See `Add new translation -> 1.` for the target language code. Assume it is `xx`.
|
||||
|
||||
3. Complete the translation according to the English README.md and name the translated version as `README-xx.md`.
|
||||
|
||||
4. In the English README, above the "About" section, add the name of the language and a hyperlink to `README-xx.md`.
|
||||
|
||||
## Contributors
|
||||
|
||||
[Check out our contributors on Github](https://github.com/MCCTeam/Minecraft-Console-Client/graphs/contributors).
|
||||
|
|
@ -1,177 +0,0 @@
|
|||
# Creating Chat Bots
|
||||
|
||||
- [Notes](#notes)
|
||||
- [Requirements](#requirements)
|
||||
- [Quick Introduction](#quick-introduction)
|
||||
- [Examples](#examples)
|
||||
- [C# API](#c#-api)
|
||||
|
||||
## Notes
|
||||
|
||||
::: tip
|
||||
**For now this page contains only the bare basics of the Chat Bot API, enough of details to teach you how to make basic Chat Bots. For more details you need to take a look at the [ChatBot.cs](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Scripting/ChatBot.cs) and [Examples](#examples). This page will be improved in the future.**
|
||||
:::
|
||||
|
||||
**Minecraft Console Client** has a rich C# API which allows you to create Chat Bots (effectively plugins) which can help you create complex automations which normal scripts may not be able to do.
|
||||
|
||||
## Requirements
|
||||
|
||||
- A basic knowledge of C# programming language
|
||||
- A text editor
|
||||
|
||||
If you're not familiar with the C# programming language, we suggest taking a look at the following resources:
|
||||
|
||||
Crash courses:
|
||||
|
||||
- [C# Crash Course playlist by Teddy Smit](https://www.youtube.com/watch?v=67oWw9TanOk&list=PL82C6-O4XrHfoN_Y4MwGvJz5BntiL0z0D)
|
||||
|
||||
More in-depth:
|
||||
|
||||
- [Learn C# Youtube Playlist by Microsoft](https://www.youtube.com/playlist?list=PLdo4fOcmZ0oVxKLQCHpiUWun7vlJJvUiN)
|
||||
- [Getting started with C# (An index of tutorials and the documentation) by Microsoft](https://docs.microsoft.com/en-us/dotnet/csharp/)
|
||||
|
||||
## Quick Introduction
|
||||
|
||||
This introduction assumes that you have the basic knowledge of C#.
|
||||
|
||||
::: tip
|
||||
**Here we will use terms Chat Bot and Script interchangeably**
|
||||
:::
|
||||
|
||||
Create a new empty file and name it `ExampleChatBot.cs` in the same folder where you have your MCC installed.
|
||||
|
||||
Paste the following example code:
|
||||
|
||||
```csharp
|
||||
//MCCScript 1.0
|
||||
|
||||
MCC.LoadBot(new ExampleChatBot());
|
||||
|
||||
//MCCScript Extensions
|
||||
|
||||
// The code and comments above are defining a "Script Metadata" section
|
||||
|
||||
// Every single chat bot (script) must be a class which extends the ChatBot class.
|
||||
// Your class must be instantiates in the "Script Metadata" section and passed to MCC.LoadBot function.
|
||||
class ExampleChatBot : ChatBot
|
||||
{
|
||||
// This method will be called when the script has been initialized for the first time, it's called only once
|
||||
// Here you can initialize variables, eg. Dictionaries. etc...
|
||||
public override void Initialize()
|
||||
{
|
||||
LogToConsole("An example Chat Bot has been initialized!");
|
||||
}
|
||||
|
||||
// This is a function that will be run when we get a chat message from a server
|
||||
// In this example it just detects the type of the message and prints it out
|
||||
public override void GetText(string text)
|
||||
{
|
||||
string message = "";
|
||||
string username = "";
|
||||
text = GetVerbatim(text);
|
||||
|
||||
if (IsPrivateMessage(text, ref message, ref username))
|
||||
{
|
||||
LogToConsole(username + " has sent you a private message: " + message);
|
||||
}
|
||||
else if (IsChatMessage(text, ref message, ref username))
|
||||
{
|
||||
LogToConsole(username + " has said: " + message);
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Start MCC, connect to a server and run the following internal command: `/script ExampleChatBot.cs`.
|
||||
|
||||
If you did everything right you should see: `[Example Chat Bot] An example Chat Bot has been initialised!` message appear in your console log.
|
||||
|
||||
### Structure of Chat Bots
|
||||
|
||||
Chat Bot (Script) structure is the following:
|
||||
|
||||
```
|
||||
<script metadata>
|
||||
<chat bot class>
|
||||
```
|
||||
|
||||
**Script Metadata** is a section with a custom format that mixes in C# with our format using comments. Every single Chat Bot (Script) must have this section at the beginning in order to work.
|
||||
|
||||
### Script Metadata Format
|
||||
|
||||
`//MCCScript 1.0` marks the beginning of the **Script Metadata** section, this must always be on the first line or the Chat Bot (Script) will not load and will throw an error.
|
||||
|
||||
`//MCCScript Extensions` marks the end of the **Script Metadata** section, this must be defined before a Chat Bot (Script) class.
|
||||
|
||||
In order for your Chat Bot (Script) to properly load in-between the `//MCCScript 1.0` and the `//MCCScript Extensions` lines you must instantiate your Chat Bot (Script) class and pass it to the `MCC.LoadBot` function.
|
||||
|
||||
Example code:
|
||||
|
||||
```
|
||||
MCC.LoadBot(new YourChatBotClassNameHere());
|
||||
```
|
||||
|
||||
**Script Metadata** section allows for including C# packages and libraries with: `//using <namespace>` and `/dll <dll name>`.
|
||||
|
||||
::: tip
|
||||
**Avoid adding whitespace between `//` and keywords**
|
||||
:::
|
||||
|
||||
By the default the following packages are loaded:
|
||||
|
||||
```csharp
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using System.IO;
|
||||
using System.Net;
|
||||
using System.Threading;
|
||||
using MinecraftClient;
|
||||
using MinecraftClient.Mapping;
|
||||
using MinecraftClient.Inventory;
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```csharp
|
||||
//using System.Collections.Immutable
|
||||
//dll MyDll.dll
|
||||
```
|
||||
|
||||
Full Example:
|
||||
|
||||
```csharp
|
||||
//MCCScript 1.0
|
||||
|
||||
//using System.Collections.Immutable
|
||||
//dll MyDll.dll
|
||||
|
||||
MCC.LoadBot(new ExampleChatBot());
|
||||
|
||||
//MCCScript Extensions
|
||||
```
|
||||
|
||||
### Chat Bot Class
|
||||
|
||||
After the end of the **Script Metadata** section, you basically can define any number of classes you like, the only limitation is that the main class of your Chat Bot (Script) must extend `ChatBot` class.
|
||||
|
||||
There are no required methods, everything is optional.
|
||||
|
||||
When the Chat Bot (Script) has been initialized for the first time the `Initialize` method will be called. In it you can initialize variables, eg. Dictionaries, etc..
|
||||
|
||||
::: tip
|
||||
**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::.
|
||||
|
||||
## Examples
|
||||
|
||||
You can find a lot of examples in our Git Hub Repository at [ChatBots](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/ChatBots) and [config](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config).
|
||||
|
||||
## C# API
|
||||
|
||||
As of the time of writing, the C# API has been changed in forks that are yet to be merged, so for now you can use the [ChatBot.cs](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Scripting/ChatBot.cs) for reference.
|
||||
|
||||
Each method is well documented with standard C# documentation comments.
|
||||
|
||||
In the future we will make a script to auto-generate this section based on the documentation in the code.
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,958 +0,0 @@
|
|||
# Usage
|
||||
|
||||
How to run the program:
|
||||
|
||||
- [Running on Windows](#windows)
|
||||
- [Running on Linux, macOS](#linux-macos)
|
||||
- [Running using Docker](#docker)
|
||||
|
||||
Using the command line parameters:
|
||||
|
||||
- [Examples](#quick-usage-of-mcc-with-examples)
|
||||
- [Command line parameters](#command-line-parameters)
|
||||
- [Internal commands](#internal-commands)
|
||||
|
||||
## Windows
|
||||
|
||||
Simply run `MinecraftClient.exe`
|
||||
|
||||
::: tip
|
||||
**On Windows it's best using [Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/install) for the best experience and looks. Some features like emojis in the [`/chunk`](#chunk) command do not work in CMD or Powershell 5**
|
||||
:::
|
||||
|
||||
## Linux, macOS
|
||||
|
||||
To run the client you need to type the following command in your terminal emulator:
|
||||
|
||||
```bash
|
||||
./MinecraftClient
|
||||
```
|
||||
|
||||
If you want to keep it running in the background you can use `screen` (Linux only) Example:
|
||||
|
||||
```bash
|
||||
# Start the screen
|
||||
screen -S mcc
|
||||
|
||||
# Run it
|
||||
./MinecraftClient
|
||||
|
||||
# Detach from the screen by pressing CTRL + A + D
|
||||
|
||||
# Re-attach if you want to have accces again
|
||||
screen -r mcc
|
||||
```
|
||||
|
||||
_Learn more on how to use the screen command: [YouTube](https://www.youtube.com/watch?v=_ZJiEX4rmN4)_
|
||||
|
||||
## Docker
|
||||
|
||||
See [Run using Docker](./guide/installation.md#using-docker)
|
||||
|
||||
## Command-line usage
|
||||
|
||||
**Minecraft Console Client** has a plethora of useful command line parameters, here you can learn about them.
|
||||
|
||||
### For people not familiar with the command line
|
||||
|
||||
For people who are not familiar with the usage of programs in the command line (terminal emulators), here we will explain what every single thing means, if you're already experienced you can skip this.
|
||||
|
||||
In command line (terminal emulators) you can run programs by specifying their name and hitting enter, usually programs have additional way of being configured, started or provided some additional data in a different manner, this is achieved by using command line parameters.
|
||||
|
||||
Command line parameters are written after the name of the program, they're separated by spaces and they can have a few different formats, examples:
|
||||
|
||||
- `someparameter`
|
||||
- `-some-parameter`
|
||||
- `--some-other-parameter`
|
||||
- `--some-setting="some value"`
|
||||
- `-a=5`
|
||||
|
||||
Parameters with a single dash (`-`) are usually used for a single letter (short-hand) parameters, while the ones with a double dash (`--`) are being used for parameters with a longer/full name.
|
||||
|
||||
When you are reading examples, you will often see something like this: `<something here>`, this means that this is a place holder and it should be changed with some value, excluding the `<` and the `>`.
|
||||
|
||||
For example `<username>` you need to change to an username of your liking, example: `notch` (`<` and `>` should not be included).
|
||||
|
||||
`[` and `]` mean that a parameter is an optional one.
|
||||
|
||||
They also can hold some values, example from the MCC:
|
||||
|
||||
```bash
|
||||
MinecraftClient.exe --debugmessages=false
|
||||
```
|
||||
|
||||
When a parameter has a textual value that includes one more spaces, you will need to wrap it the value in double quotes (`"`), example: `--some-parameter="some text here with spaces in it"`
|
||||
|
||||
Here is an example for using a `--help` command line parameter for MCC that will print out a page on how to use MCC from the command line:
|
||||
|
||||
```bash
|
||||
MinecraftClient.exe --help
|
||||
```
|
||||
|
||||
### Quick usage of MCC with examples
|
||||
|
||||
::: tip
|
||||
**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`**
|
||||
:::
|
||||
|
||||
```bash
|
||||
MinecraftClient.exe --help
|
||||
MinecraftClient.exe <username> <password> <server>
|
||||
MinecraftClient.exe <username> <password> <server> "/mycommand"
|
||||
MinecraftClient.exe --setting=value [--other settings]
|
||||
MinecraftClient.exe --section.setting=value [--other settings]
|
||||
MinecraftClient.exe <settings-file.ini> [--other settings]
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
# Logging in as a user: notch, with a password: password123 onto a server with the ip: mc.someserver.com:25565
|
||||
MinecraftClient.exe notch password123 mc.someserver.com:25565
|
||||
|
||||
# Overriding a setting from MinecraftClient.ini using a command line parameter
|
||||
MinecraftClient.exe --debugmessages=false
|
||||
|
||||
# Providing a custom settings ini file and overriding a language to Chinese
|
||||
MinecraftClient.exe CustomSettingsFile.ini --language=zh
|
||||
```
|
||||
|
||||
### Rules of using the command line parameters
|
||||
|
||||
You can mix and match arguments by following theses rules:
|
||||
|
||||
- First positional argument may be either the login or a settings file
|
||||
- Other positional arguments are read in order: login, password, server, command
|
||||
- Arguments starting with `--` can be in any order and position
|
||||
|
||||
Examples and further explanations:
|
||||
|
||||
```bash
|
||||
MinecraftClient.exe <login> <password> <server>
|
||||
```
|
||||
|
||||
- This will automatically connect you to the chosen server.
|
||||
- You may omit password and/or server to specify e.g. only the login
|
||||
- To specify a server but ask password interactively, use `""` as password.
|
||||
- To specify offline mode with no password, use `-` as password.
|
||||
|
||||
```bash
|
||||
MinecraftClient.exe <login> <password> <server> "/mycommand"
|
||||
```
|
||||
|
||||
- This will automatically send `/mycommand` to the server and close.
|
||||
- To send several commands and/or stay connected, use the 1ScriptScheduler1 bot instead.
|
||||
|
||||
```bash
|
||||
MinecraftClient.exe <myconfig.ini>
|
||||
```
|
||||
|
||||
- This will load the specified configuration file
|
||||
- If the file contains login / password / server ip, it will automatically connect.
|
||||
|
||||
```bash
|
||||
MinecraftClient.exe --setting=value [--other settings]
|
||||
```
|
||||
|
||||
- Specify settings on the command-line, see possible value in the configuration file
|
||||
- Use `--section.setting=value` for settings outside the `[Main]` section
|
||||
- Example: `--antiafk.enabled=true` for enabling the `AntiAFK` bot
|
||||
|
||||
```bash
|
||||
MinecraftClient.exe <myconfig.ini> <login> <password> <server> [--other settings]
|
||||
```
|
||||
|
||||
- Load the specified configuration file and override some settings from the file
|
||||
|
||||
## Internal Commands
|
||||
|
||||
These commands can be performed from the chat prompt, scripts or remote control.
|
||||
|
||||
From chat prompt, commands must by default be prepended with a slash, eg. `/quit`.
|
||||
|
||||
In scripts and remote control, no slash is needed to perform the command, eg. `quit`.
|
||||
|
||||
::: tip
|
||||
**Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.**
|
||||
:::
|
||||
|
||||
### `animation`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Swing your main or off hand.
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/animation <mainhand|offhand>
|
||||
```
|
||||
|
||||
### `bed`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Allows you to make the bot sleep easily, all about sleeping in one command.
|
||||
|
||||
- **Usage:**
|
||||
|
||||
Basic usage: `bed leave|sleep <x> <y> <z>|sleep <radius>`
|
||||
|
||||
- **Examples:**
|
||||
|
||||
Leave a bed:
|
||||
|
||||
```
|
||||
/bed leave
|
||||
```
|
||||
|
||||
Sleep in a bed on 124 84 76:
|
||||
|
||||
```
|
||||
/bed sleep 124 84 76
|
||||
```
|
||||
|
||||
Sleep in a bed using relative coordinates:
|
||||
|
||||
```
|
||||
/bed sleep ~ ~ ~-2
|
||||
```
|
||||
|
||||
Automatically find a bed in radius of 50 blocks and sleep in it:
|
||||
|
||||
```
|
||||
/bed sleep 50
|
||||
```
|
||||
|
||||
### `bots`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Allows you to list and unload a specific bot or all bots. Useful when debugging and developing scripts.
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/bots <list|unload <bot name|all>>
|
||||
```
|
||||
|
||||
- **Examples:**
|
||||
|
||||
Unload a bot called CustomScript
|
||||
|
||||
```
|
||||
/bots unload CustomScript
|
||||
```
|
||||
|
||||
Unload all bots
|
||||
|
||||
```
|
||||
/bots unload all
|
||||
```
|
||||
|
||||
### `changeslot`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Change your selected slot in the hotbar.
|
||||
|
||||
::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/changeslot <1-9>
|
||||
```
|
||||
|
||||
### `chunk`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Displays the chunk loading status in a nice way.
|
||||
|
||||
::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)**
|
||||
:::
|
||||
|
||||
::: tip **You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/chunk status [chunkX chunkZ|locationX locationY locationZ]
|
||||
```
|
||||
|
||||
How it looks:
|
||||
|
||||
|
||||
|
||||
### `dig`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Dig a block on a specific coordinate.
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/dig <x> <y> <z>
|
||||
```
|
||||
|
||||
- **Example:**
|
||||
|
||||
```
|
||||
/dig 127 63 12
|
||||
```
|
||||
|
||||
Using relative coordinates:
|
||||
|
||||
```
|
||||
/dig ~ ~-1 ~2
|
||||
```
|
||||
|
||||
### `dropitem`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Drop all items of a specific type from your inventory.
|
||||
|
||||
::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/dropitem <itemtype>
|
||||
```
|
||||
|
||||
::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).**
|
||||
:::
|
||||
|
||||
- **Example:**
|
||||
|
||||
```
|
||||
/dropitem diamond
|
||||
```
|
||||
|
||||
### `entity`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Attack an entity, use an entity or get a list of entities around you.
|
||||
|
||||
::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
Basic usage:
|
||||
|
||||
```
|
||||
/entity <id|entitytype> <attack|use>
|
||||
```
|
||||
|
||||
Get a list of entities around you:
|
||||
|
||||
```
|
||||
/entity
|
||||
```
|
||||
|
||||
::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).**
|
||||
:::
|
||||
|
||||
- **Examples:**
|
||||
|
||||
Attack a Zombie:
|
||||
|
||||
```
|
||||
/entity Zombie attack
|
||||
```
|
||||
|
||||
### `execif`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Allows you to execute a command if a specific condition is met.
|
||||
|
||||
The condition is a C# expression and the local variables you set using [`set`](#set), [`setrnd`](#setrnd) or the configuration file can be used. The condition is always returned as a boolean, so only comparison can be done, if needed cast the expression result to bool.
|
||||
|
||||
Also the instance of MCC is available with `MCC.`.
|
||||
|
||||
::: tip **All local variables are treated as strings in the app, when comparing their values, you can use `<variable> == "<value>"`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
Basic usage: `/execif <condition (C# expression)> ---> <command>`
|
||||
|
||||
- **Examples:**
|
||||
|
||||
Setting a variable and using it:
|
||||
|
||||
```
|
||||
/set test=Something
|
||||
/execif test == "Something" ---> send Success!
|
||||
```
|
||||
|
||||
```
|
||||
/set test2=1
|
||||
/execif test2 == "1" ---> send Success 2!
|
||||
```
|
||||
|
||||
|
||||
Basic C# expression:
|
||||
|
||||
```
|
||||
/execif 1 + 2 + 3 == 6 ---> send Success!
|
||||
```
|
||||
|
||||
|
||||
Using MCC class:
|
||||
|
||||
```
|
||||
/execif MCC.GetHealth() == 20.0 ---> send Success!
|
||||
```
|
||||
|
||||
|
||||
Using in combination with [`execmulti`](#execmulti):
|
||||
|
||||
```
|
||||
/execif 1 == 1 ---> execmulti send 1 -> send 2 -> send 3
|
||||
```
|
||||
|
||||
### `execmulti`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Allows you to execute multiple commands in succession on a single line, useful for debugging or when using [`execif`](#execif)
|
||||
|
||||
Commands are separated by `->`
|
||||
|
||||
- **Usage:**
|
||||
|
||||
Basic usage: `execmulti <command 1> -> <command 2> -> <command 3> -> ...`
|
||||
|
||||
- **Examples:**
|
||||
|
||||
```
|
||||
/execmulti send 1 -> send 2 -> send 3 -> sneak
|
||||
```
|
||||
|
||||
### `quit`
|
||||
|
||||
- **Alias:** `exit`
|
||||
- **Description:**
|
||||
|
||||
Disconnect from the server and close the application
|
||||
|
||||
### `reco`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Disconnect and reconnect to the server
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/reco [account]
|
||||
```
|
||||
|
||||
::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)**
|
||||
:::
|
||||
|
||||
### `reload`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Reloads settings from MinecraftClient.ini and Chat Bots.
|
||||
|
||||
::: tip **Some settings won't be reloaded since they are used before the client initialization. Also, settings provided by the command line paramteres will be overriden. This also does not reload the ReplayBot due to technical limitations.**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/reload
|
||||
```
|
||||
|
||||
### `connect`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Go to the given server and resume the script
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/connect <server> [account]
|
||||
```
|
||||
|
||||
::: tip **`<server>` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)**
|
||||
:::
|
||||
|
||||
::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)**
|
||||
:::
|
||||
|
||||
### `script`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Run a script containing a list of commands
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/script <script name>
|
||||
```
|
||||
|
||||
### `send`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Send a message or a command to the server
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/send <text>
|
||||
```
|
||||
|
||||
### `respawn`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Use this to respawn if you are dead (like clicking "respawn" in-game)
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/respawn
|
||||
```
|
||||
|
||||
### `log`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Display some text in the console (useful for scripts)
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/log <text>
|
||||
```
|
||||
|
||||
- Example:
|
||||
|
||||
```
|
||||
/log this is some text
|
||||
```
|
||||
|
||||
### `list`
|
||||
|
||||
- **Description:**
|
||||
|
||||
List players logged in to the server (uses tab list info sent by server)
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/list
|
||||
```
|
||||
|
||||
### `set`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Set a value which can be used as `%variable%` in further commands
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/set <variable>=<value>
|
||||
```
|
||||
|
||||
- **Examples:**
|
||||
|
||||
```
|
||||
/set abc=123
|
||||
```
|
||||
|
||||
### `setrnd`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Set a `%variable%` randomly to one of the provided values
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/setrnd <variable> string1 "\"string2\" string3"
|
||||
```
|
||||
|
||||
- **Examples:**
|
||||
|
||||
```
|
||||
/setrnd <variable> -7to10
|
||||
```
|
||||
|
||||
(Set a `%variable%` to a number from -7 to 9)
|
||||
|
||||
### `sneak`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Toggle sneaking.
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/Sneak
|
||||
```
|
||||
|
||||
### `tps`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Get the server TPS (Ticks Per Second).
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/tps
|
||||
```
|
||||
|
||||
### `useitem`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Use item in the hand, this can be used to do a right click on items which open menus on servers.
|
||||
|
||||
::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/useitem
|
||||
```
|
||||
|
||||
### `useblock`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Place a block from a hand on a specific coordinate or open an inventory:
|
||||
|
||||
- chest/trap chest
|
||||
- furnace
|
||||
- brewing stand
|
||||
- dispenser/dropper
|
||||
- hopper
|
||||
- shulker
|
||||
- loom
|
||||
|
||||
::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
::: tip **Not all inventories have a GUI representation in an ASCII art format.**
|
||||
:::
|
||||
|
||||
::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/useblock <x> <y> <z>
|
||||
```
|
||||
|
||||
- **Example:**
|
||||
|
||||
```
|
||||
/useblock 43 72 7
|
||||
```
|
||||
|
||||
### `follow`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Make the bot follow a player.
|
||||
|
||||
::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.**
|
||||
:::
|
||||
|
||||
::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/follow <player name|stop>
|
||||
```
|
||||
|
||||
- **Example:**
|
||||
|
||||
```
|
||||
/follow milutinke
|
||||
```
|
||||
|
||||
### `wait`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Wait X ticks (10 ticks = ~1 second. Only for scripts)
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/wait <time>
|
||||
```
|
||||
|
||||
- **Examples:**
|
||||
|
||||
```
|
||||
/wait 20
|
||||
```
|
||||
|
||||
### `move`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Used for moving when terrain and movements feature is enabled.
|
||||
|
||||
::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.**
|
||||
:::
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/move <on|off|get|up|down|east|west|north|south|center|x y z|gravity [on|off]> [-f]: walk or start walking. "-f": force unsafe movements like falling or touching fire
|
||||
```
|
||||
|
||||
- **Examples:**
|
||||
|
||||
Enable gravity
|
||||
|
||||
```
|
||||
/move gravity on
|
||||
```
|
||||
|
||||
Move to coordinates:
|
||||
|
||||
```
|
||||
/move 125 72 34
|
||||
```
|
||||
|
||||
Move to a center of a block:
|
||||
|
||||
```
|
||||
/move center
|
||||
```
|
||||
|
||||
### `look`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Used for looking at direction when terrain and movements is enabled
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/look <x y z|yaw pitch|up|down|east|west|north|south>
|
||||
```
|
||||
|
||||
- **Examples:**
|
||||
|
||||
```
|
||||
/look up
|
||||
```
|
||||
|
||||
```
|
||||
/look east
|
||||
```
|
||||
|
||||
### `inventory`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Used for inventory manipulation.
|
||||
|
||||
::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.**
|
||||
:::
|
||||
|
||||
::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.**
|
||||
:::
|
||||
|
||||
MCC defines inventories as containers internally, so player's inventory, chests, droppers, dispensers, hoppers, chest minecarts, barrels, furnaces, etc... are all considered a container, and each one of them has it's ID, the words container and inventory can be used interchangeably.
|
||||
|
||||
Inventory has slots and each one of them has an id.
|
||||
|
||||
::: tip **This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.**
|
||||
:::
|
||||
|
||||
An example of player inventory with annotated IDs in ASCII art and a list of items:
|
||||
|
||||
|
||||
|
||||
- **Usage:**
|
||||
|
||||
Basic usage:
|
||||
|
||||
```
|
||||
/inventory <player|container|<id>> <action> [action parameters] | /inventory <inventories/i> | /inventory <search/s> <item type> [amount]
|
||||
```
|
||||
|
||||
::: tip **player and container can be simplified with p and c accordingly**
|
||||
:::
|
||||
|
||||
Actions:
|
||||
|
||||
- `click`
|
||||
- `shiftclick`
|
||||
- `drop`
|
||||
|
||||
Show/Preview items in an inventory:
|
||||
|
||||
```
|
||||
/inventory <player|id>
|
||||
```
|
||||
|
||||
Click/Shift-Click on an item in an inventory:
|
||||
|
||||
```
|
||||
/inventory <player|container|<id>> <click|shiftclick> <slot id> [left|right|middle]
|
||||
```
|
||||
|
||||
::: tip **The default click is left click**
|
||||
:::
|
||||
|
||||
Close an inventory:
|
||||
|
||||
```
|
||||
/inventory <player|container|<id>> close
|
||||
```
|
||||
|
||||
Drop item(s) from an inventory:
|
||||
|
||||
```
|
||||
/inventory <player|id> drop <slot id> <number of items|all>
|
||||
```
|
||||
|
||||
::: tip **To drop all items from a slot, you can use: `all`**
|
||||
:::
|
||||
|
||||
Give an item to the player inventory from a creative menu when in the creative mode:
|
||||
|
||||
```
|
||||
/inventory creativegive <slot id> <item type> <amount>
|
||||
```
|
||||
|
||||
::: tip **To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)**
|
||||
:::
|
||||
|
||||
Delete an item from a player's inventory when in the creative mode:
|
||||
|
||||
```
|
||||
/inventory creativedelete <slot id>
|
||||
```
|
||||
|
||||
Show all available inventories:
|
||||
|
||||
```
|
||||
/inventory inventories
|
||||
```
|
||||
|
||||
Search for an item of specified type in available inventories:
|
||||
|
||||
```
|
||||
/inventory search <item type>
|
||||
```
|
||||
|
||||
- **Examples:**
|
||||
|
||||
Show player's inventory:
|
||||
|
||||
```
|
||||
/inventory player
|
||||
```
|
||||
|
||||
Show/Preview items in an inventory using an id:
|
||||
|
||||
```
|
||||
/inventory 3
|
||||
```
|
||||
|
||||
Click on an item in player's inventory in slot number/id `36`:
|
||||
|
||||
```
|
||||
/inventory player click 36
|
||||
```
|
||||
|
||||
Right-Click on an item in slot number/id `4` in an inventory with an id `2`:
|
||||
|
||||
```
|
||||
/inventory 2 click 4 right
|
||||
```
|
||||
|
||||
Close an inventory with an id `2`:
|
||||
|
||||
```
|
||||
/inventory 2 close
|
||||
```
|
||||
|
||||
Drop a single item from a player's inventory in slot number/id `36`:
|
||||
|
||||
```
|
||||
/inventory player drop 36 1
|
||||
```
|
||||
|
||||
Drop all items from a player's inventory in slot number/id `37`:
|
||||
|
||||
```
|
||||
/inventory player drop 37 all
|
||||
```
|
||||
|
||||
Give an item to the player inventory from a creative menu when in the creative mode:
|
||||
|
||||
```
|
||||
/inventory creativegive 36 diamondblock 64
|
||||
```
|
||||
|
||||
::: tip **To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)**
|
||||
:::
|
||||
|
||||
Delete an item from a player's inventory in slot number/id `36` when in the creative mode:
|
||||
|
||||
```
|
||||
/inventory creativedelete 36
|
||||
```
|
||||
|
||||
Search for 10 Slime Blocks in available inventories:
|
||||
|
||||
```
|
||||
/inventory s SlimeBlock 10
|
||||
```
|
||||
|
||||
### `debug`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Toggle debug messages, useful for chatbot developers.
|
||||
|
||||
### `help`
|
||||
|
||||
- **Description:**
|
||||
|
||||
Show commands help.
|
||||
|
||||
::: tip **Use "/send /help" for server help**
|
||||
:::
|
||||
Loading…
Add table
Add a link
Reference in a new issue