- # Usage
- # Docker
- # Command-line usage
- # For people not familiar with the command line
- # Quick usage of MCC with examples
- # Rules of using the command line parameters
- # Internal Commands
- # animation
- # bed
- # blockinfo
- # bots
- Saved searches
- Use saved searches to filter your results more quickly
- License
- MCCTeam/Minecraft-Console-Client
- Name already in use
- Sign In Required
- Launching GitHub Desktop
- Launching GitHub Desktop
- Launching Xcode
- Launching Visual Studio Code
- Latest commit
- Git stats
- Files
- README.md
- About
# Usage
To run the client you need to type the following command in your terminal emulator:
If you want to keep it running in the background you can use screen (Linux only)
# 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
# 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: , this means that this is a place holder and it should be changed with some value, excluding the < and the >.
For example 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:
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:
# Quick usage of MCC with examples
On Linux and macOS, you need to type: ./MinecraftClient instead of MinecraftClient.exe
MinecraftClient.exe --help MinecraftClient.exe MinecraftClient.exe --setting=value [--other settings] MinecraftClient.exe --section.setting=value [--other settings] MinecraftClient.exe [--other settings]
# 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:
- 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.
MinecraftClient.exe "/mycommand"
- This will automatically send /mycommand to the server and close.
- To send several commands and/or stay connected, use the 1ScriptScheduler1 bot instead.
- This will load the specified configuration file
- If the file contains login / password / server ip, it will automatically connect.
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
MinecraftClient.exe [--other settings]
# 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 .
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
# bed
- Description: Allows you to make the bot sleep easily, all about sleeping in one command.
- Usage: Basic usage: bed leave|sleep |sleep
- Examples: Leave a bed:
# blockinfo
You need to have Terrain And Movements enabled in order for this to work.
- Description: Reports the block type at the given position. If you use the -s option it will report the types of blocks around the targeted blokcs.
- Usage: Basic usage:
# bots
- Description: Allows you to list and unload a specific bot or all bots. Useful when debugging and developing scripts.
- Usage:
Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
Lightweight console for Minecraft chat and automated scripts
License
MCCTeam/Minecraft-Console-Client
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
…rn/docs/semver-7.5.3 Bump semver from 7.3.8 to 7.5.3 in /docs
Git stats
Files
Failed to load latest commit information.
README.md
Minecraft Console Client (MCC)
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.
Get development builds from the Releases section
Check out the Website, README and existing Discussions: Maybe your question is answered there. If not, please open a New Discussion and ask your question. If you find a bug, please report it in the Issues section.
We now have a Discord server, click here to join.
We are a small community so we need help to implement upgrades for new Minecraft versions, fixing bugs and expanding the project. We are always looking for motivated people to contribute. If you feel like it could be you, please have a look at the issues section 🙂
If you’d like to contribute to Minecraft Console Client, great, just fork the repository and submit a pull request on the Master branch. To contribute to the website / online documentation see also the Website repository.
Translating Minecraft Console Client 🌍
To improve translations for MCC, please visit: Crowdin — Minecraft Console Client.
Building from the source 🏗️
This section has been moved to our new Documentation website.
Unless specifically stated, the code is from the MCC Team or Contributors, and available under CDDL-1.0. Else, the license and original author are mentioned in source file headers. The main terms of the CDDL-1.0 license are basically the following:
- You may use the licensed code in whole or in part in any program you desire, regardless of the license of the program as a whole (or rather, as excluding the code you are borrowing). The program itself may be open or closed source, free or commercial.
- However, in all cases, any modifications, improvements, or additions to the CDDL code (any code that is referenced in direct modifications to the CDDL code is considered an addition to the CDDL code, and so is bound by this requirement; e.g. a modification of a math function to use a fast lookup table makes that table itself an addition to the CDDL code, regardless of whether it’s in a source code file of its own) must be made publicly and freely available in source, under the CDDL license itself.
- In any program (source or binary) that uses CDDL code, recognition must be given to the source (either project or author) of the CDDL code. As well, modifications to the CDDL code (which must be distributed as source) may not remove notices indicating the ancestry of the code.
About
Lightweight console for Minecraft chat and automated scripts