From 9e2f6d3b57541c797fd950655a46d363b3f99423 Mon Sep 17 00:00:00 2001 From: Milutinke Date: Sun, 28 Aug 2022 13:59:55 +0200 Subject: [PATCH] Updated the README.md and the configs/README.md --- MinecraftClient/config/README.md | 515 +------------------------------ README.md | 58 ++-- 2 files changed, 25 insertions(+), 548 deletions(-) diff --git a/MinecraftClient/config/README.md b/MinecraftClient/config/README.md index 4901a4e8..61a446f6 100644 --- a/MinecraftClient/config/README.md +++ b/MinecraftClient/config/README.md @@ -1,517 +1,4 @@ Minecraft Console Client User Manual ====== -**Thanks for dowloading Minecraft Console Client!** - -Minecraft Console Client is a lightweight app able to connect to any minecraft server, -both offline and online mode. It enables you to send commands and receive text messages -in a fast and easy way without having to open the main Minecraft game. - -How to use ------- - -First, extract the archive if not already extracted. -On Windows, simply open MinecraftClient.exe by double-clicking on it. -On Mac or Linux you need to install the Mono Runtime: - - On Mac: http://www.mono-project.com/download/#download-mac - - On Linux: sudo apt-get install mono-runtime libmono-reflection-cil -Then, open a terminal in this folder and run "mono MinecraftClient.exe". -If you cannot authenticate on Mono because you have TLS/HTTPS/Certificate errors, you'll need to run `mozroots --import --ask-remove` once or install `ca-certificates-mono` (See [#1708](https://github.com/MCCTeam/Minecraft-Console-Client/issues/1708#issuecomment-893768862)). -If Mono crashes, retry with `mono-complete` instead of `mono-runtime`. Use at least Mono v4.0. - -Docker ------- - -Using Docker do the following: - -**Building the Image:** -```bash -# Using HTTPS -git clone https://github.com/MCCTeam/Minecraft-Console-Client.git - -# Using SSH -git clone git@github.com:MCCTeam/Minecraft-Console-Client.git - -cd Minecraft-Console-Client/Docker - -docker build -t minecraft-console-client:latest . -``` - -**Start the container using Docker:** -```bash -# You could also ignore the -v parameter if you dont want to mount the volume that is up to you. If you don't it's harder to edit the .ini file if thats something you want to do -docker run -it -v :/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`, `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: -```yml -#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: -```bash -docker-compose run MCC -``` -Remember to remove the container after usage: -```bash -docker-compose down -``` - -If you use the INI file and entered your data (username, password, server) there, you can start your container using -```bash -docker-compose up -docker-compose up -d #for deamonized running in the background -``` -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 -```bash -docker-compose down -``` - -Using Configuration files & Enabling bots ------- - -Simply open the INI configuration file with a text editor and change the values. -To enable a bot change the `enabled` value in the INI file from `false` to `true`. -You will still be able to send and receive chat messages when a bot is loaded. -You can remove or comment some lines from the INI file to use the default values instead. -You can have several INI files and drag & drop one of them over MinecraftClient.exe - -Command-line usage ------- - -Quick usage: - -``` -MinecraftClient.exe --help -MinecraftClient.exe -MinecraftClient.exe "/mycommand" -MinecraftClient.exe --setting=value [--other settings] -MinecraftClient.exe --section.setting=value [--other settings] -MinecraftClient.exe [--other settings] -``` -You can mix and match arguments by following theses rules: - * First positional argument may be either the login or 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: - -``` -MinecraftClient.exe -``` - -* 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 ScriptScheduler bot instead. - -``` -MinecraftClient.exe -``` - -* 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] -``` - -* 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`. - - - `quit` or `exit`: disconnect from the server and close the application - - `reco [account]`: disconnect and reconnect to the server - - `connect [account]`: go to the given server and resume the script - - `script