Readme¶

Welcome to the Bashcrawl Catacombs — an interactive terminal dungeon where every command is a spell and every directory a new realm to explore. Nine interconnected chambers await, each a side-quest that teaches a core set of Bash skills through gameplay.

This hub is your walkthrough and strategy guide to the game. Play instantly in the browser below, use the nine chamber walkthroughs as your field manual, then graduate to the advanced version — installing Bashcrawl and playing it in a real shell.

🕹️ Play in Your Browser¶

The full game runs right here — no install required. Keep this guide open alongside it.

{% include bashcrawl-terminal.html %}

🗺️ Catacombs Map¶

flowchart TD
    HUB([🏰 Bashcrawl Hub]) --> ENT[🚪 Entrance]
    ENT --> WRK[🔨 Workshop]
    ENT --> CEL[🍷 Cellar]
    WRK --> CEL
    CEL --> ARM[⚔️ Armoury]
    CEL --> CHP[⛪ Hidden Chapel]
    CEL --> VLT[🔒 Vault]
    CEL --> SCR[🗑️ Scrap Heap]
    ARM --> CHM[🐉 Chamber]
    CHM --> RFT[🌀 The Rift]
    CHP --> RFT
    VLT --> RFT
    SCR --> RFT
    RFT --> AGT[🤖 Agent Mode]
    click ENT "/quests/0000/side-quests/entrance/"
    click WRK "/quests/0000/side-quests/workshop/"
    click CEL "/quests/0000/side-quests/cellar/"
    click ARM "/quests/0000/side-quests/armoury/"
    click CHM "/quests/0000/side-quests/chamber/"
    click CHP "/quests/0000/side-quests/hidden-chapel/"
    click VLT "/quests/0000/side-quests/vault/"
    click SCR "/quests/0000/side-quests/scrap/"
    click RFT "/quests/0000/side-quests/rift/"
    click AGT "/quests/0000/side-quests/agent-mode/"

📖 Chapter Guide¶

#	Chamber	Difficulty	Key Commands	Walkthrough
1	🚪 Entrance	🟢 Easy	`pwd` `ls` `cd` `cat`	Start Here
2	🔨 Workshop	🟢 Easy	`mkdir` `touch` `rm` `echo >`	Workshop
3	🍷 Cellar	🟢 Easy	`ls -F` `alias` `file`	Cellar
4	⚔️ Armoury	🟡 Medium	`chmod` `./` permissions	Armoury
5	🐉 Chamber	🟡 Medium	`let` `$(( ))` arithmetic	Chamber
6	⛪ Hidden Chapel	🔴 Hard	`ls -a` `man` hidden dirs	Chapel
7	🔒 Vault	🟡 Medium	`export` `$VAR` `env`	Vault
8	🗑️ Scrap Heap	🟡 Medium	`ln -s` `readlink` symlinks	Scrap
9	🌀 The Rift	🔴 Hard	pipes `\\|` `&&` redirection	Rift
★	🤖 Agent Mode	🔴 Hard	`--agent` `--batch` `--screenshot-dir`	Agent

{% include bashcrawl-play-local.html %}

🧙 In-Game Commands¶

Command	Effect
`quest`	Show current quest objectives
`merlin`	Get a context-aware hint
`status` or `hp`	Show health and progress
`inventory` or `i`	List collected items
`map`	Display the dungeon map
`save`	Save current progress
`load`	Restore last save
`tutorial`	Toggle tutorial mode
`commands`	List all game commands
`help`	Show help screen
`reset`	Reset to a fresh start

⚔️ Combat Commands¶

Script	Chamber	Encounter
`./statue`	Chamber	Solve arithmetic to defeat the stone guardian
`./monster`	Chapel hall	Combat encounter — use weapon from Armoury
`./ghost`	Vault lab	Ghost encounter — environment variable skills required
`./goblet`	Vault stronghold	Solve the goblet puzzle; unlocks the path to the Rift

🔧 Maintenance Commands¶

./setup.sh --verify        # Check installation health
./setup.sh --repair        # Fix common permission/setup issues
./main.sh --status         # Show current game progress
./main.sh --reset          # Reset for a fresh run

🧭 Learning Path Tips¶

Start with Entrance → Workshop → Cellar to build confidence before branching.
Keep a command journal: capture one new command and one mistake after each chamber.
Replay one chamber in a different mode (Web, Classic, or Native) to reinforce transfer skills.

📚 External Resources¶

🗺️ Quest Network¶

Quest Series: Bashcrawl Adventure Path

Prerequisites: None — this hub is a perfect entry point.

Child Quests: All nine chamber walkthroughs above (see Chapter Guide).

Sequel Quest: Bash Run and Beyond — extend the dungeon with custom scripting.

Ready? Run ./bash_crawl.sh or open Bashcrawl Online and type your first command. ⚔️✨