Minecraft Terminal

Minecraft Terminal is a lightweight CLI app that allows you to play minecraft in the terminal and configure bots with or without programming knowledge.

• Downloads
  • Install with NPM (Recommended)
  • Clone git repo
• Usage
  • First launch
  • Command-line usage
  • Internal commands
  • Plugins
  • Scripts
  • Hotkeys
  • Shortcuts
  • Remote control (RCON)
  • Configuration
    • Credentials
    • Configuration
    • Physics

Downloads

Install with NPM (Recommended)

$ npm i -g mc-term
$ mc-term

Alternatively you can clone the git repo.

Clone git repo

$ git clone https://github.com/MC-Terminal/minecraft-terminal.git
$ cd minecraft-terminal
$ npm install
$ node .

Usage

First launch

You need to setup the configuration files before actually using the program.

To do this you must specify the configuration directory path:

$ mc-term -scp /path/to/config/dir

Then you must generate the default configuration files in that same directory:

$ mc-term -gc /path/to/config/dir

Finally check if you've set everything correctly:

$ ls /path/to/config/dir
config.json  credentials.json  physics.json

Command-line usage

Usage:
   --no-conf, -nc           Do not use the configuration file.
   --no-cred, -ns           Do not use the credentials file.
   --no-plugins, -np        Do not load plugins specified in plugins file.
   --set-conf-path, -scp    Set the config folder path
   --get-conf-path, -gcp    Get the config folder path
   --gen-conf, -gc          Generate configuration files
   --cred, -c               <Auth> <Username> <Password> <Version> <Server>
   --debug                  Enable debug mode
                            Override credentials from CLI arguments.
   --help, -h               Show this help message.
   --version, -v            Show version information.

You can use '!' in --cred to leave it empty.

Examples and further explanations:

Use the the default settings overriding the username:

$ mc-term -c ! Player456 '' ! !
Password :

• ! will use the login options specified in credentials.json if no options are set it will use defaults
• '' will prompt

Do not use the credentials file credentials.json:

$ mc-term  --no-cred
[WARN] Not using "credentials.json" because of --no-cred
Auth :
Login :
Password :
Server :
Version :

Do not use the configuration file config.json:

$ mc-term --no-conf
[WARN] Not using "config.json" because of --no-conf
Auth :
Login :
Password :
Server :
Version :

Set the configuration files path and exit:

$ mc-term --set-conf-path $HOME/.config/mc-term

Print the configuration files location and exit:

$ mc-term --get-conf-path
Path to config: $HOME/.config/mc-term

Generate default configuration files in the specified location:

$ mc-term --gen-conf $HOME/.config/mc-term

Internal commands

You can use a command by typing . before the command.

Commands are case insensitive, so .exit and .EXIT are the same.

Exit

Disconnect from the server:

>.exit
[INFO] Exiting
$

Reco

Reconnect to server:

>.reco
[INFO] Connected.
>

Move

• Direction: String: Direction to move to
  • north
  • south
  • east
  • west
• Distance? (optional): Number Distance > 0

Move the player in blocks:

>.move
[INFO] Usage: .move <Direction> <distance?>. Direction = <north|south|east|west> distance > 0

Moveto

• X: Number
• Z: Number

Move to specific coordinates (Y is variable)

>.moveto
[INFO] Usage: .moveto <X> <Z>

Forcemove

• Direction: String: Direction to move to
  • up: Will jump
  • forward
  • back
  • left
  • right
• Time: Number: Time in seconds

Move the player in seconds:

>.forcemove
[INFO] Usage: .forcemove <Dircetion:up|forward|back|left|right> <Time:Seconds>

Follow

• Player: String: Player name
• Range: Number: How close you should stay to the player

Follow a player:

>.follow
[INFO] Usage: .follow <Player> <Range>. Range > 1

Unfollow

Stop following a player:

>.unfollow
[INFO] Not following anyone

Attack

• Player: String: Player name
• CPS: Number: Clicks per second

Attack a player:

>.attack
[INFO] Usage: .attack <Player> <CPS> <MaxReach> <MinReach>. MaxReach > MinReach (Duh), CPS > 0

Stopattack

Stop attacking a player:

>.stopattack
[INFO] Not attacking anyone

Send

• Message: String: Message to send

Send a message in chat:

>.send
[INFO] Usage: .send <Message>

• You can also send a message by directly typing it chat. .send is really only meant for scripts

Inventory

• ID: String/Integer: Container to open. 0 = inventory, 1 = container.
  • 0, inventory: Will open the inventory
  • 0, inventory: Will open the currently opened container
• Action? (optional): String: click, move, drop, dropall
• Arg1? (optional): Arguments for Action
• Arg1? (optional): Arguments for Action

Inventory management:

>.inventory
[INFO] Usage: .inventory <ID: inventory|container|0|1> <Action?: click|move|drop|dropall> <Arg1?> <Arg2?>

Useitem

• Time? (optional): Number: How long you should keep using that item. Defaults to 0.1

Use an item:

>.useitem
[INFO] Used an item for 0.1 seconds

• You can specify for how long you should use an item. By default it's 0.1 seconds

Changeslot

• Slot: Integer: 0 <= Slot <=8. Slot to switch to

Change the selected hotbar slot:

>.changeslot
[INFO] Usage: .changeslot <Slot>. -1 < Slot < 9

Position

Show current position:

>.position
[INFO] Position: -612.09, 4, 1104.99

Distance

• Point1
  • X: Number
  • Y: Number
  • Z: Number
• Point2
  • X: Number
  • Y: Number
  • Z: Number

Show distance between two points:

>.distance
[INFO] Usage: .distance <X1> <Y1> <Z1> <X2> <Y2> <Z2>

Blocks

• Range: Number: Radius for the search
• Count: Number: Filter to closest Count blocks

Show blocks in a specified radius:

>.blocks
[INFO] Usage: .blocks <Range> <Count?>. Range > 0

Dig

• X: Number
• Y: Number
• Z: Number

Dig a breakable block:

>.dig
[INFO] Usage: .dig <X> <Y> <Z>

Dig

• X: Number
• Y: Number
• Z: Number

Place a block if possible:

>.place
[INFO] Usage: .place <X> <Y> <Z>

Stopdig

Stop digging:

>.stopdig
[OK] Stopped digging

Script

• Path: String: Path to the script on your PC
• Condition: Unknown: Not used yet

Run a script:

>.script
[INFO] Usage: .script <Path> <Condition>

• 'Condition' is not used yet. i.e. It's useless

Lookat

• Player: String: Player name
• MaxReach: Number: Maximum distance between you and the player
• MinReach: Number: Minimum distance between you and the player
• Force? (optional): string
  • yes, y: Will snap to the player and keep them at the center of its eyes
  • no, n: Will slowly turn

Look at a player:

>.lookat
[INFO] Usage: .lookat <Player> <MaxReach> <MinReach> <Force?:yes|y|no|n>. MaxReach > MinReach (duh)

Stoplook

Stop looking at a player:

>.stoplook
[INFO] Not looking at anyone

Look

You can only use either Direction or Yaw and Pitch

• Direction? (optional): String
  • north
  • south
  • east
  • west
• Yaw? (optional): Number
• Pitch? (optional): Number

Look in a specific direction:

>.look
[INFO] Usage: .look <Direction?:north|south|east|west> <Yaw?> <Pitch?>

Control

You can also use .control clearall which would clear all states

• Control: String: Which control's state to change
  • forward
  • back
  • left
  • right
  • jump
  • sneak
• State: Boolean

Set the control state of the player:

>.control
[INFO] Usage: .control <Control: forward|back|left|right|jump|sneak> <State: Boolean>

List

Show a list of all connected players on the server (and their ping):

>.list
[INFO] Player list: Player123 [50] AnotherPlayer [121]

Help

Show a list of all commands:

>.help
[INFO] .exit           Exits the program
       .reco           Reconnects to server
       .move           Move in a certain direction in blocks
       .forcemove      Move in a certain direction in seconds
       .control        Set a control state
       .follow         Follows a player
       .unfollow       Stops following
       .attack         Attacks a player
       .stopattack     Stops attacking
       .lookat         Look at a player
       .stoplook       Stops looking
       .look           Look in a certain direction
       .send           Sends a message
       .inventory      Inventory management
       .useitem        Use a held item
       .changeslot     Change held hotbar slot
       .script         Run a script
       .list           List players connected to the server and their ping
       .help           Shows this help message

Plugins

Note: If you do not know how to code you can just use scripts to make powerfull bots

Loading plugins

To load a plugin you must specify the plugin path inside the plugins.json file located in your config directory.

If you don't see you can generate a new default one.

$ mc-term -gc /path/to/config/dir

You can load more than one plugin at once.

[
    "/path/to/pluginONE",
    "/path/to/pluginTWO"
]

Example of a very basic plugin:

const name = 'Test plugin';

let lib;
const load = (LIB) => {
    lib = LIB;
};

const main = () => {
    lib.success('Example success message');
    lib.info('Example info message');
    lib.warn('Example warning');
    lib.error('Example error');

    lib.info('I just added a \'.test\' command!');
    lib.commands.test = () => {
        lib.success('TEST COMMAND WORKS!!!');
    };
};

module.exports = { load, main, name };

$ mc-term -c ! Player ! localhost 1.12
[OK] Connected.
[OK] Successfully loaded the 'Test plugin'
[OK] Example success message
[INFO] Example info message
[WARN] Example warning
[ERR] Example error
[INFO] I just added a '.test' command!
>.test
[OK] TEST COMMAND WORKS!!!
>

Making plugins

Right now the only documentation we have is an example plugin.

More documentation will be added in the future though.

Scripts

A script is a plain text file which contains a series of commands. These commands are the same commands we would normally type in chat (such as move or attack).

Note:

• You don't need to type '.' before a command in a script and you cannot send a message by typing the message directly.
• You can comment out a line by typing '#' at the start of the line.

Example:

# Works
send I just sent a message in chat!

# Doesn't work
.send I just sent a message in chat!

# Doesn't work
I just sent a message in chat!

Script only commands

Wait

Waits for a specific amount of seconds before running the next command:

send First message
# Waits 1 second before running the second command
wait 1
send Second message

Running a script

>.script /path/to the/script

Example:

>.script scripts/HelloWorld
[INFO] Reading script
<Player123> Hello world!
[INFO] Reached end of script

Hotkeys

Shortcuts

Command-line

--conf !

• When using the --conf option you can put ! to skip one prompt:

$ mc-term --conf cracked Player123 ! localhost !

First ! Skips password prompt because this is a cracked account.

Second ! uses default version (1.12.2).

In game

Position ~ ~ ~

• When trying to type your coordinates you can just type ~ ~ ~ and it will auto replace:

<AnotherPlayer> Where are you?
>.send I am at: ~ ~ ~!
<You> I am at: 512.5 76 1535!

This only works with commands:

>~ ~ ~
<You> ~ ~ ~

You can also replace one of the ~

>.send ~ ~ ~
<You> 512.5 76 1535
>.send ~ 420 ~
<You> 512.5 420 1535

Relative position also works

>.send ~ ~ ~
<You> 512.5 76 1535
>.send ~100 ~+100 ~-1005
<You> 612.5 176 530

Remote control

For now you can send a message that starts with '!#' and the bot will repeat everything that comes after '!#'.

[INFO] Connected.
<AnotherPlayer> !#Hello
[RCON] Hello
<Player456> Hello
<AnotherPlayer> !#/gamemode creative
[RCON] /gamemode creative
Set own gamemode to creative.
<AnotherPlayer> !#.exit
[RCON] .exit
$

Configuration

Go to the configuration directory:

$ mc-term -gcp
Path to config: /path/to/config/dir
$ cd /path/to/config/dir
$ ls
config.json  credentials.json  physics.json

Then you should edit the config files as you want.

Credentials

The 'credentials.json' file.

Auth

• microsoft
• mojang (deprecated)
• cracked

The auth to use when logging in (microsoft/mojang).

Login

Your Minecraft or Microsoft username/email.

Password

Your Minecraft or Microsoft password.

Server

The server IP (e.g. localhost:48621, lunar.gg).

Version

The Minecraft version.

Currently only supports [1.8-latest]

Configuration

The 'config.json' file.

canDig

• boolean

Should the player be able to dig or not.

digCost

• Number

How much you should discourage the follow bot to dig blocks

placeCost

• Number

How much you should discourage the follow bot to place blocks

liquidCost

• Number

How much you should discourage the follow bot to go through liquids

entityCost

• Number

How much you should discourage the follow bot to go through entities

bot.physicsEnabled

• Boolean

Should the bot use physics (e.g. knockback, gravity).

Disabling this will get you banned on most servers.

bot.settings

bot.settings.chat

• Enabled
• Disabled
• CommandOnly

bot.settings.colorsEnabled

• Boolean

If set to false the bot tells the server to not send colored messages.

It's up to the server to decide if they should respect this option or not.

bot.settings.viewDistance

• tiny
• short
• normal
• far

The render distance.

bot.settings.mainHand

• left
• right

Specify which hand is the main hand.

bot.settings.enableTextFiltering

• Boolean

bot.settings.enableServerListing

• Boolean

Whether or not the player would show up in server listings.

bot.settings.skinParts

bot.settings.skinParts.showCape

• Boolean

bot.settings.skinParts.showJacket

• Boolean

bot.settings.skinParts.showLeftSleeve

• Boolean

bot.settings.skinParts.showRightSleeve

• Boolean

bot.settings.skinParts.showLeftPants

• Boolean

bot.settings.skinParts.showRightPants

• Boolean

bot.settings.skinParts.showHat

• Boolean

bot.settings.pathfinder

bot.settings.pathfinder.thinkTimeout

• Number

bot.settings.pathfinder.tickTimeout

• Number

bot.settings.pathfinder.searchRadius

• Number

bot.settings.pathfinder.enablePathShortcut

• Boolean

bot.settings.pathfinder.LOSWhenPlacingBlocks

• Boolean

Physics

WIP