LinuxCommandLibrary
GitHubF-DroidGoogle Play Store

termcraft

Side-view block world in the terminal, solo or with other players

TLDR

Play a solo world
$ termcraft
copy
Lantern Run, the scripted trial
$ termcraft trial
copy
Host a game on every interface
$ termcraft host
copy
Join a server on this machine
$ termcraft client [127.0.0.1:25565]
copy
List saved worlds
$ termcraft world list
copy
Play one saved world
$ termcraft world play [harbor]
copy

SYNOPSIS

termcraft [command] [arguments]

DESCRIPTION

termcraft is an unofficial terminal fan game in the style of Minecraft. With no arguments it creates a save directory and starts a solo world. trial runs Lantern Run (traverse, fight, rebuild). host listens on every interface. server listens on loopback unless you pass an address. client (alias connect) joins a server. join reaches a host over SSH, then the game port.director schema prints the game-master schema. mcp speaks the Model Context Protocol on standard input and output, and mcp config prints a client config for this binary. Help lists those commands, and turns on in-game game-master controls, when this variable is set:

$ TERMCRAFT_EXPERIMENTAL_GAME_MASTER=1 termcraft --help
copy

PREVIEW

   *
 ######
 #.@.#
 ######

COMMANDS

trial [ID]

Play Lantern Run. The default id is lantern-run. trial create [ID] writes that trial and does not launch it.
host [ADDRESS] [--player PROFILE]
Listen for players. The default address is 0.0.0.0:25565 and the default profile is host.
server [ADDRESS]
Run a headless server. The default address is 127.0.0.1:25565.
client [ADDRESS] [--player PROFILE]
Connect to a server. Alias connect. The default address is 127.0.0.1:25565 and the default profile is player.
join USER@HOST [--player PROFILE] [--ssh-port PORT] [--game-port PORT]
Open an SSH session to the host, then attach to the game. The default profile is player, the SSH port is 22, and the game port is 25565.
world list
Print saved worlds.
world play ID
Play a saved world.
world serve ID [ADDRESS]
Serve a saved world. The default address is 127.0.0.1:25565.
world create ID RECIPE.json [PROMPT]
Build a world from a recipe file (at most 256 KiB) and an optional prompt.
world generate ID PROMPT [--generator PROGRAM]
Ask an external generator to build a world. The program is --generator or the environment variable below, and it must be a trusted executable.
$ TERMCRAFT_WORLD_GENERATOR=/usr/local/bin/generator termcraft world generate harbor "a coastal village"
copy
world schema
Print the world schema.
director schema
Print the game-master schema and an example.
mcp
Serve the Model Context Protocol on standard input and output.
mcp config [--format json|toml]
Print an MCP client snippet that runs this binary with argument mcp. The default format is json.
-h, --help, help
Print help. -V and --version print the version.

CONTROLS

A / D

Walk. Double-tap and hold to sprint.
Space
Jump.
E
Inventory and crafting.
V / Shift+V
Drop one item, or the whole stack.
T
Player chat in co-op, or solo commands. Enter sends. Esc closes the line.
+ / -
Zoom.
F4
Cycle views.
O
Settings.
Q / Esc
Save and quit.

INSTALL

yay -S termcraft
copy

CAVEATS

This is a fan project, unaffiliated with Minecraft. host binds 0.0.0.0:25565 unless you pass another address. server and world serve bind 127.0.0.1:25565 unless you pass another address. world generate runs whatever program you name, so point it only at a generator you trust. mcp waits on standard input; solo and hosted play do not start it.

HISTORY

termcraft is written in Rust by pagel-s. It is licensed under AGPL-3.0-only.

SEE ALSO

RESOURCES

Copied to clipboard
Kai