Installation

Requirements:

• Git
• .NET 10 SDK or Visual Studio configured for C# app development

Cloning using Git

Install Git

1. Make a new folder where you want to keep the source code
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 by running:

git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive

If you cloned the repository without --recursive, run:

git submodule update --init --recursive

5. Once the repository has been cloned, you can close the Git Bash terminal emulator
6. Open up the new cloned folder

Download translation resources (optional)

1. Visit MCC project's homepage on Crowdin.
2. You will need to log in to your Crowdin account in order to download.
3. Click on the language you want to download the translation for.
4. Find MinecraftClient -> Resources -> Translations -> MCC in-app text
5. Click the button ••• at the end of the line.
6. Click Download and save the file to folder /MinecraftClient/Resources/Translations/.
7. Find MinecraftClient -> Resources -> ConfigComments -> Comments in the settings file
8. Click the button ••• at the end of the line.
9. 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
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
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:

winget install Microsoft.DotNet.SDK.10

4. Run the following command for a normal local build:

dotnet build MinecraftClient.sln -c Release

5. If you want a release-like published binary that matches the repo's CI workflow, run:

dotnet publish MinecraftClient.sln -f net10.0 -r win-x64 --self-contained=true -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:EnableCompressionInSingleFile=true -p:DebugType=Embedded

6. Verify the SDK installation if needed:

dotnet --info

If the publish step succeeds, the published binary MinecraftClient.exe will be in MinecraftClient/bin/Release/net10.0/win-x64/publish/.

Requirements:

• Git

  • Linux:

  • Install Git on macOS

• .NET 10 SDK

  • Install .NET on Linux
  • Install .NET on Ubuntu
  • Install .NET on macOS

Cloning using Git

1. Open up a terminal emulator and navigate to the folder where you will store the MCC
2. Recursively clone the GitHub repository by running:

git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive

3. Go to the folder you've cloned (should be Minecraft-Console-Client)

4. Install the .NET 10 SDK.

   • On Ubuntu 24.04 LTS, use the built-in Ubuntu package feeds:

     sudo apt-get update && \
       sudo apt-get install -y dotnet-sdk-10.0

   • On macOS, the normal path is to use the official installer from the .NET download page. Pick Arm64 for Apple Silicon and x64 for Intel Macs.

5. If you want to download translation resources, please check out Download translation resources

6. Run the following command for a normal local build:

   dotnet build MinecraftClient.sln -c Release

7. Run the following command if you want a release-like published binary that matches the repo's CI workflow:

   • On Linux:

     dotnet publish MinecraftClient.sln -f net10.0 -r linux-x64 --self-contained=true -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:EnableCompressionInSingleFile=true -p:DebugType=Embedded

     Tip

     If you are using Linux on ARM, 32-bit, RHEL-based distributions, or Musl, pick the appropriate RID for your platform and replace -r linux-x64 with it, for example -r linux-arm64.

   • On macOS:

     dotnet publish MinecraftClient.sln -f net10.0 -r osx-x64 --self-contained=true -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:EnableCompressionInSingleFile=true -p:DebugType=Embedded

     Tip

     If you are not using an Intel Mac, pick the appropriate RID for your processor and replace -r osx-x64 with it, for example -r osx-arm64.

If the build has succeeded, the compiled binary MinecraftClient will be in:

• Linux: MinecraftClient/bin/Release/net10.0/linux-x64/publish/
• macOS: MinecraftClient/bin/Release/net10.0/osx-x64/publish/

You can verify the SDK installation with:

dotnet --info

Requirements:

• Git
• Docker

1. Clone the GitHub repository by running:

git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive

2. Navigate to Minecraft-Console-Client/Docker
3. Build the image using the following command

docker build -t minecraft-console-client:latest .

Start the container using Docker:

# You can omit -v if you do not want a mounted volume. Keeping the volume makes it much easier to edit the TOML config stored in MinecraftClient.ini from the host.
docker run -it -v <PATH_ON_YOUR_MACHINE_TO_MOUNT>:/opt/data minecraft-console-client:latest

Now you could login and the Client is running.

To detach from the Client but still keep it running in the Background press: CTRL + P and then after CTRL + Q.

To reattach use the docker attach command.

Start the container using docker-compose:

By default, the volume of the container gets mapped into a new folder named data in the same folder the docker-compose.yml is stored.

If you don't want to map a volume, you have to comment out or delete the entire volumes section:

#volumes:
#- './data:/opt/data'

Make sure you are in the directory the docker-compose.yml is stored before you attempt to start. If you do so, you can start the container:

docker-compose run MCC

Remember to remove the container after usage:

docker-compose down

If you use MinecraftClient.ini and entered your data there, you can start your container using

docker-compose up
docker-compose up -d # for daemonized background running

Note that you won't be able to interact with the client using docker-compose up. If you want that functionality, please use the first method: docker-compose run MCC.

As above, you can stop and remove the container using

docker-compose down

Termux

F-Droid (recommended): Install the F-Droid app store, search for "Termux", and install it.

GitHub releases: Go to the latest Termux GitHub release, download the APK file whose name contains universal (e.g. termux-app_v...-debug_universal.apk), and install it.

Installing Ubuntu

We use proot-distro, an official Termux utility, to install Ubuntu. It will install the latest Ubuntu LTS release available for your device architecture.

Open Termux and run the following commands one at a time, in order:

1. pkg update
2. pkg upgrade
3. pkg install proot-distro

Now install Ubuntu:

proot-distro install ubuntu

Once the installation finishes, start Ubuntu with:

proot-distro login ubuntu

Installing .NET

First, update the Ubuntu package lists and install a few tools:

apt update -y && apt upgrade -y

apt install wget curl nano -y

Then install .NET 10.0 using Microsoft's official install script:

wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
chmod +x dotnet-install.sh
./dotnet-install.sh --channel 10.0

Now add .NET to your PATH so it works in future sessions. Open .bashrc:

nano ~/.bashrc

Scroll to the bottom of the file using the Page Down key, add a blank line, and paste the following:

export DOTNET_ROOT=$HOME/.dotnet
export PATH=$PATH:$HOME/.dotnet:$HOME/.dotnet/tools

Save the file with CTRL + X, type Y, and press Enter. Then apply the changes:

source ~/.bashrc

Verify the installation by running:

dotnet --version

You should see a version number like 10.0.xxx.

Installing MCC

Finally, we can install MCC.

Let's make a folder where MCC will be stored:

mkdir MinecraftConsoleClient
cd MinecraftConsoleClient

Download the latest MCC binary for ARM64:

wget -O MinecraftClient \
  "$(curl -s https://api.github.com/repos/MCCTeam/Minecraft-Console-Client/releases/latest \
    | grep 'browser_download_url.*linux-arm64"' \
    | cut -d '"' -f 4)"

Make it executable:

chmod +x MinecraftClient

And run it with:

./MinecraftClient

After installation

When you open Termux next time, start Ubuntu with:

proot-distro login ubuntu

Then run MCC with ./MinecraftClient

To stop MCC from running you can press CTRL + C

To edit the configuration/settings, you need a text editor, we recommend Nano, as it's very simple to use, if you have followed the installation steps above, you should be familiar with it, if not, check out this tutorial.

For downloading files, you can use the wget file we have installed, simply run:

wget your_link_here (you have examples above, and a video tutorial down bellow).

Also, here are some linux tutorials for people who are new to it:

• Linux Terminal Introduction by ExplainingComputers
• Linux Crash Course - nano (command-line text editor) by Learn Linux TV
• Linux Crash Course - The wget Command by Learn Linux TV
• Linux Basics: How to Untar and Unzip Files (tar, gzip) by webpwnized

You have 2 options:

• Buying a VPS
• Getting an AWS EC2 VPS for free (12 months free trial)

Buying a VPS

If you do not want to give your info to Amazon or don't have a debit card, you can buy your own VPS.

What hardware requirements I need for running the MCC?

The MCC is not expensive to run, so it can run on basically any hardware, you do not need to spend a lot of money on a VPS if you are going to run just the MCC, go with the cheapest option.

Where to buy a VPS?

Some of the reliable and cheap hosting providers (sorted for price/performance):

• E-Trail

  Minimum price: 2.50 EUR / month

  Tip

  If Ubuntu 24.04 LTS is not in the dropdown when ordering, you may need to reinstall later or ask support to do it.

• OVH Cloud

  Minimum price: 3.57 EUR / month

• Hetzner Cloud

  Minimum price: 4.51 EUR / month

• Digital Ocean

  Minimum price: 4 EUR / month

• Contabo

  Minimum price: 7 EUR / month

  More serious VPS able to host multiple applications, 4 CPU cores and 8 GB of RAM, 200 GB SSD

You also may want to search for better deals.

AWS EC2 VPS

Register on AWS and enter all of your billing info and a phone number.

Once you're done, you can continue to Setting up the Amazon VPS.

When you register and open the AWS Console, click on the Search field on the top of the page and search for: EC2

Click on the Launch instance button.

Fill out the Name field with a name of your preference.

For the Application and OS images select the current Ubuntu Server 24.04 LTS image. The exact AWS label may vary slightly by point release.

For the Instance type select t2.micro.

For the Key pair (login) click on Create new key pair and name it VpsRoot, leave the rest of settings as default and click Create key pair, this will generate a RSA private key that will be automatically downloaded.

For the Network settings check the following checkboxes on:

• Allow SSH traffic from (Anywhere)
• Allow HTTPs traffic from the internet
• Allow HTTP traffic from the internet

For the Storage enter 30.

Finally, review the Summary confirm that everything is as in the tutorial and that you will not be charged and click on the Launch instance. Once you've clicked on the button, it will take a couple of minutes for the instance to be available up and running.

Once the instance is up and running, go to it's details and copy the Public DNS v4 IP.

You now need to login, go to your folder where you keep the private key you've generated and downloaded (make sure you make a new folder for it, do not keep in the downloads folder) and right click on the empty white space (not on files), if you're on Windows click Git Bash here, on mac OS and Linux click on Open Terminal (or whatever it is called).

In order to login with SSH, you are going to use the following command:

ssh -i <name of your private root key here> ubuntu@<your public dns v4 ip here>

Example:

ssh -i VpsRoot.pem ubuntu@ec2-3-71-108-69.eu-central-1.compute.amazonaws.com

If you've provided the right info you should get Welcome to Ubuntu 20.04.5 LTS message.

Now you can continue to Creating a new user

When you order the VPS, most likely you will be asked to provide the root account name and password, if it is the case, name the account as root and give it a password of your choice.

Other option is that you will get your login info in the email once the setup is done.

Once you have the root login account info, you need Git Bash on Windows and ssh on macOS or Linux.

If you're on Windows open Git Bash, on mac OS and Linux open a Terminal and type the following command:

ssh <username>@<ip>

Example:

ssh root@142.26.73.14

Example with port:

ssh -p 2233 root@142.26.73.14

Once you've logged in you should see a Linux prompt and a welcome message if there is one set by your provider.

Once you've logged in to your VPS you need to create a new user and give it SSH access.

In this tutorial we will be using mcc as a name for the user account that will be running the MCC.

To create a new user named mcc execute the following command:

sudo useradd mcc -m

Now we need to give it a password, execute the following command, type the password and confirm it:

sudo passwd mcc

Now we need to give our user account the admin permissions:

sudo usermod -aG sudo mcc

Now we are going to set it's shell to bash:

sudo chsh mcc -s /bin/bash

Now we need to log in as the mcc user:

su mcc

Fill in your password when asked.

Navigate to the mcc user home directory with:

cd ~

Make a new .ssh directory:

mkdir .ssh

Enter it with:

cd .ssh

Make a new empty file named authorized_keys:

touch authorized_keys

Do no close the Git bash/Terminal emulator.

On your PC, make a new folder where you are going to store your SSH keys that you're going to use to log in to the user account.

Open the folder, and right click on the empty white space (not on files), if you're on Windows click Git Bash here, on mac OS and Linux click on Open Terminal (or whatever it is called).

Type the following command:

ssh-keygen -t RSA -b 4096

Enter the name of the key file to be: MCC_Key, press Enter.

When asked for a passphrase, enter a password of your choice and confirm it, make sure it's strong and that you remember it, best if you write it down on a piece of paper.

This will generate a private and a public key that you will use to log in to the VPS as a user that you've created.

Now open the MCC_Key.pub file with a text editor of your choice and copy it's contents to the clipboard.

Return to the Git Bash/Terminal emulator and execute the following command:

sudo apt install nano -y

This will install the Nano editor on your VPS.

Now we need to let the SSH service on your VPS know about your newly generated SSH key pair.

Make sure you are in the /home/mcc/.ssh folder, you can confirm this by executing:

pwd

If it does not print /home/mcc/.ssh, navigate to it with:

cd /home/mcc/.ssh

Now you need to open the authorized_keys file with the nano editor:

nano authorized_keys

Now paste the copied contents of the MCC_Key.pub into the nano editor by right clicking on it.

Save the file with CTRL + O, press Enter, and then exit it with CTRL + X.

Now we need to configure the SSHD service to let us login with the SSH key we have generated, for this we need to edit the /etc/ssh/sshd_config file with nano:

sudo nano /etc/ssh/sshd_config

Find the #PubkeyAuthentication yes line and remove the # in front to uncomment the line.

Then find the #AuthorizedKeysFile .ssh/authorized_keys .ssh/authorized_keys2 line and remove the # to uncomment the line.

Additionally for better security you can do the following:

• Set PermitRootLogin to yes
• Change the Port to some number of your choice (22-65000) (Make sure it's at least 2 digits and avoid common ports used by other apps like: 21, 80, 35, 8080, 3000, etc...)
• Uncomment #PasswordAuthentication yes by removing the # in front and set it to yes (This will disable password login, you will be able to login with SSH keys only!)

Save the file with CTRL + O, hit Enter, close it with CTRL + X.

Now we need to restart the SSHD service with:

sudo systemctl restart sshd

Let's check if everything is working correctly:

sudo systemctl status sshd

If everything has been configured as it should be you should see active (running) as a status of the service.

If not, open the config file again and check for mistakes.

Press q to exit the log mode.

Logout from the mcc user with exit command, and then logout from the root ubuntu user by typing exit again.

Now we can login to the user with our private MCC_Key file.

Command:

ssh -i <path to the MCC_Key private key> mcc@<ip here>

Example:

ssh -i MCC_Key mcc@3.71.108.69

If did everything correctly you should see a Linux prompt and a welcome message if there is one on your provider.

You can do whoami to see your username.

Now you can install the .NET 10 SDK and MCC.

Log in as the user you've created.

Update the system packages and package manager repositories:

sudo apt update -y && sudo apt upgrade -y

On Ubuntu 24.04 LTS, the official Microsoft docs say .NET is available directly from the Ubuntu package feeds, so you do not need to add the old Microsoft package repository for .NET 10. Install the SDK with:

sudo apt-get update -y && sudo apt-get install -y dotnet-sdk-10.0

You can verify the installation with:

dotnet --info

Run the following command to check if everything was installed correctly:

dotnet

You should get:

Usage: dotnet [options]
Usage: dotnet [path-to-application]

Options:
  -h|--help         Display help.
  --info            Display .NET information.
  --list-sdks       Display the installed SDKs.
  --list-runtimes   Display the installed runtimes.

path-to-application:
  The path to an application .dll file to execute.

If you do not get this output and the installation was not successful, try other methods.

If it was successful, you can now install MCC.

Now that you have the .NET SDK and a user account, install the screen utility. You will need it if you want MCC to keep running after you close the SSH session.

You can also learn about the screen command from this YouTube tutorial.

To install the screen execute the following command:

sudo apt install screen -y

Now you can install the MCC:

• Download a compiled binary
• Building from the source code
• Run using Docker (Doesn't require the screen command)

How to use the screen command?

To start a screen, type:

screen -S mcc

Now you will be in the screen, now you can start the MCC and detach from the screen.

To detach from the screen press CTRL + A + D.

To re-attach/return to the screen, execute the following command:

screen -r mcc

If you've accidentally closed the SSH session without detaching from the screen it might be still attached, to detach it use:

screen -d mcc

To list out screens you can use:

screen -ls

To stop the MCC, you can hit CTRL + D (hit it few times).