Package Exports

mc-term
mc-term/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mc-term) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Minecraft Terminal

Minecraft Terminal is a lightweight CLI app that allows you to play minecraft in the terminal.

This README is a work in progress:

Downloads
- Install with NPM (Recommended)
- Clone git repo
Usage

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.
   --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>
                            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 cred.json if no options are set it will use defaults
'' will prompt

Do not use the credentials file cred.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

Move the player in blocks:

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

Moveto

Move to specific coordinates

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

Forcemove

Move the player in seconds:

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

Follow

Follow a player:

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

Unfollow

Stop following a player:

>.unfollow
[INFO] Not following anyone

Attack

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

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

Inventory management:

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

Useitem

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

Change the selected hotbar slot:

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

Script

Run a script:

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

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

Lookat

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

Look in a specific direction:

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

Control

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

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

Hotkey	What it does
CTRL-B	Move back one character without deleting
CTRL-F	Move forward one character without deleting
BACKSPACE	Delete one character backwards
DEL	Delete one character forwards
ESC-B, CTRL-LEFT	Move back one word without deleting
ESC-F, CTRL-RIGHT	Move forward one word without deleting
ALT-BACKSPACE	Delete or “kill” one word backwards
ESC-D, ALT-DEL	Delete or “kill” one word forwards
CTRL-A, HOME	Move cursor to the beginning of the line
CTRL-E, END	Move cursor to the end of the line
CTRL-U	Kill forward to the beginning of a line
CTRL-K	Kill forward to the end of a line
CTRL-L	Clears the screen

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:

$ Path to config: /path/to/config/dir
$ cd /path/to/config/dir
$ ls
config.json  credentials.json  physics.json

Edit the files.

Credentials

The 'credentials.json' file.

Auth

microsoft
mojang (deprecated)
cracked

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

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