/Minecraft-Console-Client

Lightweight console for Minecraft chat and automated scripts

Primary LanguageC#

Minecraft Console Client

GitHub Actions build status

Minecraft Console Client (MCC) is a lightweight app allowing you to connect to any Minecraft 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.

Download 🔽

Get binary file from our latest development build. The exe file is a .NET binary which also works on Mac and Linux.

How to use 📚

Check out the sample configuration files which includes the how-to-use README.

Getting Help 🙋

Check out the 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.

Helping Us ❤️

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 :)

How to contribute 📝

If you'd like to contribute to Minecraft Console Client, great, just fork the repository and submit a pull request on the Master branch. MCC is currently distributed as development builds only (which are usually stable) so we no longer use the Indev branch.

Translating Minecraft Console Client 🌍

If you would like to translate Minecraft Console Client to a different language, please download the translation file from the lang folder or just fork the repository. Once you finished the translation work, submit a pull request or send us the file through an Issue in case you are not familiar with Git.

To use the translated language file, place it under lang/mcc/ folder and set your language in .ini config. You may create the directory if does not exist.

For the names of the translation file, please see this comment.

Building from source 🏗️

The recommended development environment is Visual Studio. If you want to build the project without installing a development environment, you may also follow these instructions:

First of all, get a zip of source code, extract it and navigate to the MinecraftClient folder.

Edit MinecraftClient.csproj to set the Build target to Release on line 4:

<Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>

On Windows 🪟

  1. Locate MSBuild.exe for .NET 4 inside C:\Windows\Microsoft.NET\Framework\v4.X.XXXXX
  2. Drag and drop MinecraftClient.csproj over MSBuild.exe to launch the build
  3. If the build succeeds, you can find MinecraftClient.exe under MinecraftClient\bin\Release

On Mac and Linux 🐧

  1. Install the Mono Framework if not already installed
  2. Run msbuild MinecraftClient.csproj in a terminal
  3. If the build succeeds, you can find MinecraftClient.exe under MinecraftClient\bin\Release

License ⚖️

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.

More info at http://qstuff.blogspot.fr/2007/04/why-cddl.html Full license at http://opensource.org/licenses/CDDL-1.0