termcraft README

The project's README from github.com/pagel-s/termcraft. As one markdown file: README.md.

termcraft

Survive, build and explore a block world in your terminal. Bring friends over SSH.

Docs Beta release 0.2.0 Rust

Play · Controls · Co-op · Release notes

Unofficial fan project. Not affiliated with Mojang or Microsoft.

Termcraft 0.2.0 — the beta release. Download the game from Releases.

Termcraft beta gameplay: co-op exploration, crafting, the Nether and the Ender Dragon

Watch the full video · Music and media credits

A survival world, adapted to 2D

Gather wood, craft tools, build a shelter and survive the night. Explore caves and villages, smelt better equipment, cross the Nether, find the stronghold and face the Ender Dragon. Termcraft adapts that survival progression to a side-on terminal world, with shaped terrain, room cutaways and distinct creature silhouettes.

Play the beta

Without Rust: download your platform's 0.2.0 archive from Releases. Extract the game archive, keeping all files together. Open a terminal in the extracted folder.

Platform Download 0.2.0 Start Lantern Run
Linux, Intel/AMD 64-bit Linux archive ./play.sh
Windows, Intel/AMD 64-bit Windows archive .\PLAY.cmd in Windows Terminal
macOS, Apple silicon Apple silicon archive ./PLAY.command
macOS, Intel Intel Mac archive ./PLAY.command

For classic survival run ./termcraft on Linux/macOS or .\termcraft.exe on Windows. The launchers in the table start Lantern Run, a separate short combat, traversal and building route. macOS archives are unsigned; see installation for platform details.

Package managers: on macOS run brew install pagel-s/termcraft/termcraft. Rust users can run cargo install termcraft --locked (Rust 1.88+). For Debian/Ubuntu, follow the signed APT setup. WinGet is pending Microsoft's review; use the Windows archive above meanwhile. See package-manager channels for details.

To build it yourself, follow building from source.

Controls

Start with a true-color terminal, a monospace font and a window around 120×40 or larger. Mouse support is recommended.

Action Control
Walk Hold A / D or left/right arrow
Sprint Tap, release, then quickly hold the same direction
Jump / swim up W, Up or Space
Mine / attack Left mouse button
Place / interact Right mouse button; F uses the hovered block
Inventory / crafting E
Hotbar 1–9
Drop one / stack V / Shift+V
Zoom in / out = or + / -
Close UI / save and quit Q or Esc

O opens settings, F3 diagnostics and F4 cycles views. Saved view choices are respected. See all controls and gameplay for sprint input support, crafting, furnaces and portals.

Play with friends

Use matching beta builds. Start hosting and playing in one terminal:

./termcraft host

The host starts the server and joins automatically. Press T to see the join address; friends on the same network run ./termcraft client ADDRESS --player bob. Use a different --player profile for each terminal. T also opens player chat. For package-manager installs, omit ./; on Windows use .\termcraft.exe. Quitting the host ends the shared session.

Follow the multiplayer setup guide for one computer, one network or separate networks, with connection checks and troubleshooting. For remote access, follow safe hosting or SSH joining.

Saves and current limits

The game autosaves in your user data directory. Back up the whole save directory, including hidden files, before upgrading; older builds cannot open newer saves. See save locations and recovery.

The game is in beta. See supported content and release notes for current capabilities and limits.

Feedback

Report bugs through GitHub issues or [email protected]. Include build, OS, terminal and reproduction steps.

Supported content · Media credits

termcraft (pagel-s/termcraft)

Searching Database…

What is this?Termcraft is a terminal-based 2D sandbox survival game inspired by Minecraft: you mine, craft, farm and build across a procedural Overworld, Nether and End, fight through dungeons and fortresses, and can take on the Ender Dragon.
How do I get it running?Download the 0.2.0 archive for your OS from Releases, extract it, and run ./play.sh (Linux/macOS) or .\PLAY.cmd (Windows) to start the default Lantern Run mode, or run ./termcraft for classic survival. It's also available via brew install pagel-s/termcraft/termcraft or cargo install termcraft --locked.
Do I need Rust installed to play?No — pre-built archives cover Linux, Windows and macOS (Intel and Apple Silicon), so Rust is only needed if you install via cargo or build from source (Rust 1.88+). You do need a true-color terminal with a monospace font, a window of at least 120x40, and ideally mouse support.
Any pitfalls before I dive in?It's still a beta (0.2.0), macOS archives are unsigned, and saves aren't forward-compatible — older builds can't open saves from newer versions, so back up your save directory before upgrading.
Can I play with friends over the network or SSH?Yes, up to eight players can join one world. The host starts a server and joins automatically, friends on the same network connect with './termcraft client ADDRESS --player name', and remote players can join over SSH or by following the safe-hosting guide.
What is Lantern Run?Lantern Run is the mode the play scripts launch by default — a shorter, separate combat, traversal and building route, distinct from the open-ended classic survival mode you get by running ./termcraft directly.
Is this an official Minecraft game?No, it's explicitly an unofficial fan project and is not affiliated with Mojang or Microsoft, even though its progression closely mirrors Minecraft's survival loop.
Which topics is it in?rust
Creator
pagel-s
Size
197.7 MB
Stars
255
Age
7mo
Commits · 90 Days