Files

sneak 60442ce103 build: add a make build target, drop README's raw go build (closes #19 )

The executable builds to build/rogue. All generated artifacts go under
build/, which .gitignore covers as a whole; a target writing outside it
can commit its output.

build is in neither check nor test: check stays fmt-check lint test and
still writes nothing into the working tree.

README's "Building and running" block and the run examples use
./build/rogue, and no raw go invocation is left in the file.

Verified: make build writes build/rogue and git status stays clean;
GOFLAGS=-count=1 make check green in 34s with the lint layer executing
(21.9s, "0 issues.", not CACHED) and the suite running for real (cmd/rogue
1.027s, game 3.450s), git status clean afterwards.

2026-08-10 13:48:58 +00:00

3.0 KiB

Raw Blame History

Rogue: Exploring the Dungeons of Doom (Go port)

Rogue is the original dungeon-crawling adventure game that spawned an entire genre. This branch is a faithful Go port of Rogue 5.4.4: explore procedurally generated dungeons, fight monsters, collect treasure, and attempt to retrieve the Amulet of Yendor.

Original authors: Michael Toy, Ken Arnold, and Glenn Wichman (1980–1983, 1985, 1999).

The port is function-by-function faithful to the classic C sources — same dungeon generation (seed-compatible RNG), same combat math, same item tables, same messages. The C reference implementation lives on the master and modern-rogue branches; ARCHITECTURE.md documents both the original program structure and the design of this port.

Building and running

Requires Go 1.25 or later and a terminal at least 80x24.

make build
./build/rogue

# Restore a saved game
./build/rogue ~/rogue.save

# View high scores
./build/rogue -s

# Test the death screen (demo mode)
./build/rogue -d

In-game commands

Press ? in game for the full list.

arrows or h/j/k/l/y/u/b/n — move (shift to run, ctrl to run until adjacent)
. rest, s search for hidden doors and traps
i inventory, , pick up, d drop
q quaff potion, r read scroll, e eat food
w wield weapon, W wear armor, P/R put on / remove ring
t throw, z zap a wand, f/F fight
>/< take the stairs
S save, Q quit

Environment

# Game options, as in the original
export ROGUEOPTS="name=YourName,terse,jump,fruit=mango"

# Wizard (debug) mode, with a reproducible dungeon
ROGUE_WIZARD=1 SEED=12345 ./build/rogue

The scoreboard is kept in ~/.rogue.scores. Save files are Go gob snapshots and, as in the original, are deleted when restored.

Code layout

game/        the game engine: one Go file per original C file,
             function-by-function (see ARCHITECTURE.md for the mapping)
term/        tcell-backed terminal, replacing curses
cmd/rogue/   the executable

The engine package is fully headless-testable: make test runs scripted command sequences, dungeon-generation golden checks, and an RNG compatibility test against the original C generator.

For development, the Makefile wraps the toolchain: make fmt (gofmt + prettier), make lint (script/lint, which runs golangci-lint inside the pinned container built from Dockerfile.lint — it is never installed on the host, so docker is required), make test (the suite, under the race detector with coverage and a timeout), make check (all three), and make build (the executable, into the git-ignored build/). Use the targets rather than the toolchain directly — they carry the flags the project relies on.

License

BSD-style; see LICENSE.TXT.

3.0 KiB Raw Blame History Unescape Escape