Richard ZinkandClaude Opus 5.5
b3583f5e7e
- README: logo, badges (Rust, WebAssembly, Claude Code, MIT), intro addressed to the master, features with screenshots, the household, how to play, licences and credits - INSTALL.md: server, PWA, building, tests, savegame service and API, languages, how to refresh generated files - BESTIARY.md generated from the game's data (tools/make_bestiary.py) with exported sprites and icons (docs/img, test export_doc_images) - play/DungeonCraft.html: the whole game in one file to download and play offline Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
170 lines
9.5 KiB
Markdown
170 lines
9.5 KiB
Markdown
<p align="center">
|
|
<img src="docs/img/logo.png" width="128" alt="DungeonCraft - the soul core">
|
|
</p>
|
|
|
|
<h1 align="center">DungeonCraft</h1>
|
|
|
|
<p align="center"><b>Dig. Build. Defend. Conquer.</b><br>
|
|
An evil little dungeon game for the browser - in glorious pixels, in 3D, for free.</p>
|
|
|
|
<p align="center">
|
|
<img src="https://img.shields.io/badge/Rust-macroquad-b7410e?logo=rust&logoColor=white" alt="Rust">
|
|
<img src="https://img.shields.io/badge/WebAssembly-runs%20in%20the%20browser-654ff0?logo=webassembly&logoColor=white" alt="WebAssembly">
|
|
<img src="https://img.shields.io/badge/made%20with-Claude%20Code-d97757?logo=anthropic&logoColor=white" alt="Made with Claude Code">
|
|
<img src="https://img.shields.io/badge/license-MIT-2ea44f" alt="MIT License">
|
|
<img src="https://img.shields.io/badge/languages-EN%20%7C%20DE-555" alt="English and German">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="play/DungeonCraft.html"><b>▶ Play now - download one HTML file, open it, done</b></a><br>
|
|
<a href="BESTIARY.md">Bestiary</a> · <a href="INSTALL.md">Run your own server</a> · <a href="DESIGN.md">Design notes</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="docs/screenshots/title-battle.png" width="820" alt="The title screen with the endless bridge battle">
|
|
</p>
|
|
|
|
---
|
|
|
|
## Wake up, master.
|
|
|
|
Yes, you. Don't look around, there's nobody else down here - just you, four imps and me, old **Crookfinger**.
|
|
|
|
A hundred years ago the Order of the Lightwatch smashed your soul core into shards and carried them off like trophies.
|
|
They polished their boots, sang songs about the sun and forgot about you. **Big mistake.**
|
|
|
|
Your heart still beats. Hear that? *Lub-dub. Lub-dub.* That's the sound of a grudge.
|
|
|
|
So pick up the pickaxe - well, point at the rock, the imps carry the pickaxes - and let's dig ourselves a realm.
|
|
Gold is in the walls, creatures are waiting behind the portal, and the knights... the knights are about to have
|
|
a very bad century.
|
|
|
|
<p align="center">
|
|
<img src="docs/screenshots/dungeon-heart.png" width="820" alt="The beating crystal heart, the demon gate and the dark towers">
|
|
<br><i>Your heart, master, held in chains on its obsidian throne. And the demon gate. I polished it myself.</i>
|
|
</p>
|
|
|
|
## What awaits you down here
|
|
|
|
**🕳 Dig your realm.** Mark the rock and your imps dig, claim the ground, carry gold, gems and diamonds to the
|
|
treasury and hang torches on the walls. Up to five imps help each other with one job. Every tile you claim is *yours*.
|
|
|
|
**🏰 Build rooms that bring the right guests.** A lair and a mushroom garden open the portal. A library brings
|
|
shadow mages, a training hall stone ogres, a temple the flame priestess, an aerie giant bats, gargoyles, arcane
|
|
owls - and maybe, one day, an **ember wyrm**. Fourteen rooms in total, from the forge to the sacrifice altar.
|
|
|
|
**👹 Keep them happy, or they leave.** Every creature wants a bed, food and its wage on payday - and it walks to the
|
|
treasury to fetch it. Each has a favourite room, and some of them simply cannot stand each other.
|
|
Put a mage next to an ogre and watch the fur fly. (Nobody dies. Probably.)
|
|
|
|
**⚔ Train them into legends.** Ten ranks from Recruit to Warlord, with chevrons, bars and stars - and gear that grows
|
|
with them, up to golden armour, a crown and a halo. With the level come abilities: the ogre learns to *stomp*, the mage
|
|
to *step through shadows*, the chainbreaker to spin like a *whirlwind*.
|
|
|
|
<p align="center">
|
|
<img src="docs/screenshots/bridge-battle.png" width="820" alt="A battle at a bridge over an underground river">
|
|
<br><i>The knights brought a bridge. How thoughtful. Now they're bringing it back, one piece at a time.</i>
|
|
</p>
|
|
|
|
**🔥 Defend with towers, traps and doors.** Arrow spires, hellmouth cannons and dark spires on the walls. In the
|
|
**forge** your creatures build spike pits, poison vents, fire jets, stone rollers, alarm bells, rune mines and
|
|
frost glows - and doors of wood, iron and magic. Lock them, and nobody gets through. Not even the giant. Well. Not for a while.
|
|
|
|
**✨ Cast nasty spells.** Lightning, healing, seer's eye, cave-in, haste, stoneskin, gold rain, invisibility,
|
|
plague and quake. Your scholars **research** them in the library - one discovery after another.
|
|
|
|
**🌫 Explore the dark.** Everything beyond your walls is black until your creatures go there.
|
|
Somewhere out there: a cave of neutral **dwarves** guarding gold and gems - and sometimes a chest with the plans
|
|
of a dwarven **rune forge tower**. Islands in lava rivers. Mana springs. Creatures in chains, waiting to be freed.
|
|
|
|
<p align="center">
|
|
<img src="docs/screenshots/forge-and-traps.png" width="400" alt="The forge with coglings and every kind of trap and door">
|
|
<img src="docs/screenshots/dark-rooms.png" width="400" alt="Prison, graveyard, arena, altar and guard posts">
|
|
<br><i>Left: the forge and its little coglings. Right: prison, graveyard, arena, guard posts and the altar. Cosy.</i>
|
|
</p>
|
|
|
|
**👑 Other masters want your realm, too.** Mossgrim the Mouldy (green, smells like a wet cellar) and Lady Nightwell
|
|
(blue, writes threatening letters on scented paper) dig their own dungeons in free play and in the campaign.
|
|
And the humans attack *everybody*. Let them bite each other first.
|
|
|
|
**📜 A campaign of thirty missions.** Take back the shards of your soul core - from the first little outpost by the
|
|
border brook to the citadel of Grand Master Valerian Brightshield. Rivers, fortresses, treasure islands, sealed
|
|
caves, rival masters, and me, telling you the story. With tea.
|
|
|
|
<p align="center">
|
|
<img src="docs/screenshots/dwarf-cave.png" width="400" alt="A dwarf cave with a rune chest">
|
|
<img src="docs/screenshots/fog-of-war.png" width="400" alt="The start of a game in the fog of war">
|
|
<br><i>A dwarf cave, master. Nice dwarves. Don't go too close. - And this is where every game begins: in the dark.</i>
|
|
</p>
|
|
|
|
## Meet the household
|
|
|
|
<p align="center">
|
|
<img src="docs/img/units/worker_5.png" width="56" alt="Pit imp">
|
|
<img src="docs/img/units/kobold_5.png" width="56" alt="Kobold">
|
|
<img src="docs/img/units/spider_5.png" width="56" alt="Cave spider">
|
|
<img src="docs/img/units/mage_5.png" width="56" alt="Shadow mage">
|
|
<img src="docs/img/units/ogre_5.png" width="56" alt="Stone ogre">
|
|
<img src="docs/img/units/jailer_5.png" width="56" alt="Jailer">
|
|
<img src="docs/img/units/priestess_5.png" width="56" alt="Flame priestess">
|
|
<img src="docs/img/units/cogling_5.png" width="56" alt="Cogling">
|
|
<img src="docs/img/units/revenant_5.png" width="56" alt="Revenant">
|
|
<img src="docs/img/units/bat_5.png" width="56" alt="Giant bat">
|
|
<img src="docs/img/units/gargoyle_5.png" width="56" alt="Chain gargoyle">
|
|
<img src="docs/img/units/owl_5.png" width="56" alt="Arcane owl">
|
|
<img src="docs/img/units/wyrm_5.png" width="56" alt="Ember wyrm">
|
|
<img src="docs/img/units/chainbreaker_5.png" width="56" alt="Chainbreaker">
|
|
</p>
|
|
|
|
> *Fourteen kinds of wonderful creatures, master, and eight kinds of humans in shiny tin. I wrote everything down for
|
|
> you - who loves what, who hates whom, who learns what - in* **[Crookfinger's Bestiary](BESTIARY.md)**.
|
|
> *The same book is in the game, by the way - on the title screen and in the pause menu.*
|
|
|
|
## How to play
|
|
|
|
1. **Download [`play/DungeonCraft.html`](play/DungeonCraft.html)** and open it in your browser. That's all.
|
|
It runs offline, on desktop and on phones (touch controls switch on by themselves).
|
|
2. Or **run your own server** with Docker - with user accounts, savegames on the server and the game as an
|
|
installable app: see **[INSTALL.md](INSTALL.md)**.
|
|
|
|
**The basics, master:**
|
|
|
|
| | |
|
|
|---|---|
|
|
| Left click / drag | use the tool - dig, build rooms (drag a rectangle), cast, place towers and traps |
|
|
| Right click | drop what your hand holds (creatures, prisoners - or a sacrifice on the altar) |
|
|
| Shift + click | slap your own creatures (faster for a while) or punch a hero |
|
|
| Right drag, WASD, screen edge | move the camera · middle drag, Q/E, R/F: rotate and tilt · wheel: zoom |
|
|
| Esc | pause menu: save, load, settings, bestiary |
|
|
|
|
On phones: tap to use a tool, drag to mark or move, two fingers to zoom and turn, long press for information.
|
|
|
|
## Under the hood
|
|
|
|
- **Rust**, compiled to **WebAssembly**, with [macroquad](https://github.com/not-fl3/macroquad) - one small module, no engine, no plugins.
|
|
- A real 3D isometric world in pixel art: chunked meshes, flickering point lights, a glow pass, particles,
|
|
billboard sprites with eight viewing directions, every frame of it drawn by code - **no image files** except the font.
|
|
- Procedural chiptune soundtrack as FastTracker 2 modules with its own XM replayer and synthesised sound effects.
|
|
- A tiny Rust savegame server (axum, Argon2 passwords) - optional; without it the game uses savegame files.
|
|
- English and German, more languages are one text file away.
|
|
|
|
## Made with Claude Code
|
|
|
|
<p><img src="docs/img/claude-mark.png" width="72" alt="Claude Code mark" align="left"> DungeonCraft was developed with the help of
|
|
<a href="https://claude.com/claude-code"><b>Claude Code</b></a>, Anthropic's AI coding assistant - the code, the graphics,
|
|
the music, the texts and this page. Claude, Claude Code and Anthropic are trademarks of Anthropic; the pixel mark only
|
|
credits the tool.</p>
|
|
<br clear="left">
|
|
|
|
## License
|
|
|
|
DungeonCraft is released under the **[MIT License](LICENSE)** - © 2026 Richard Zink. It covers the code, the generated
|
|
music in `assets/music/` and the procedural graphics.
|
|
|
|
The **DINOBYTE** font (`assets/dbyte_1x.png`) by [mby](https://mby.itch.io/dinobyte) is licensed separately under
|
|
**CC BY 4.0**. Details in [CREDITS.md](CREDITS.md).
|
|
|
|
---
|
|
|
|
<p align="center"><i>"The underworld is yours, master. Now - tea?"</i><br>- Crookfinger</p>
|