Add dev Makefile; format all markdown with prettier
Adds a minimal Makefile wrapping the toolchain the way sneak's other repos expose it: - fmt gofmt -w plus prettier (4-space tabs, proseWrap: always) - fmt-check fail if any Go or Markdown file is unformatted - lint golangci-lint run ./... - test go test ./... - check fmt-check + lint + test (the local pre-commit gate) Running make fmt normalizes the four existing Markdown docs to the shared prettier style (80-column proseWrap: always, aligned tables) — a one-time reflow with no content change. The repo remains exempt from the rest of the policy scaffold (no Dockerfile, CI, or REPO_POLICIES).
This commit is contained in:
41
README.md
41
README.md
@@ -2,19 +2,19 @@
|
||||
|
||||
[](LICENSE.TXT)
|
||||
|
||||
**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.
|
||||
**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).
|
||||
**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](ARCHITECTURE.md)
|
||||
documents both the original program structure and the design of this port.
|
||||
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](ARCHITECTURE.md) documents both the
|
||||
original program structure and the design of this port.
|
||||
|
||||
## Building and running
|
||||
|
||||
@@ -40,13 +40,12 @@ go build ./cmd/rogue
|
||||
|
||||
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)
|
||||
- **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
|
||||
- **`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
|
||||
@@ -61,8 +60,8 @@ export ROGUEOPTS="name=YourName,terse,jump,fruit=mango"
|
||||
ROGUE_WIZARD=1 SEED=12345 ./rogue
|
||||
```
|
||||
|
||||
The scoreboard is kept in `~/.rogue.scores`. Save files are Go gob
|
||||
snapshots and, as in the original, are deleted when restored.
|
||||
The scoreboard is kept in `~/.rogue.scores`. Save files are Go gob snapshots
|
||||
and, as in the original, are deleted when restored.
|
||||
|
||||
## Code layout
|
||||
|
||||
@@ -73,13 +72,13 @@ term/ tcell-backed terminal, replacing curses
|
||||
cmd/rogue/ the executable
|
||||
```
|
||||
|
||||
The engine package is fully headless-testable: `go test ./game/` runs
|
||||
scripted game sessions, dungeon-generation golden checks, and an RNG
|
||||
compatibility test against the original C generator.
|
||||
The engine package is fully headless-testable: `go test ./game/` runs scripted
|
||||
game sessions, dungeon-generation golden checks, and an RNG compatibility test
|
||||
against the original C generator.
|
||||
|
||||
## License
|
||||
|
||||
BSD-style; see [LICENSE.TXT](LICENSE.TXT).
|
||||
|
||||
Copyright (C) 1980-1983, 1985, 1999 Michael Toy, Ken Arnold and Glenn
|
||||
Wichman. All rights reserved.
|
||||
Copyright (C) 1980-1983, 1985, 1999 Michael Toy, Ken Arnold and Glenn Wichman.
|
||||
All rights reserved.
|
||||
|
||||
Reference in New Issue
Block a user