https://github.com/thoughtbot/write-yourself-a-roguelike
Write Yourself A Roguelike: Ruby Edition
https://github.com/thoughtbot/write-yourself-a-roguelike
Last synced: 10 months ago
JSON representation
Write Yourself A Roguelike: Ruby Edition
- Host: GitHub
- URL: https://github.com/thoughtbot/write-yourself-a-roguelike
- Owner: thoughtbot
- License: mit
- Created: 2015-02-18T15:26:44.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2021-09-24T16:04:08.000Z (over 4 years ago)
- Last Synced: 2025-04-27T14:39:34.825Z (about 1 year ago)
- Language: Ruby
- Homepage:
- Size: 9.55 MB
- Stars: 156
- Watchers: 101
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Write Yourself a Roguelike
You are about to embark on a journey. This journey will be plagued with orcs,
gnomes, algorithms, data structures, and kittens. You, valiant developer, will
be writing a Roguelike.
## Outline
- [x] Intro
- [x] What is a Roguelike?
- [x] What is NetHack?
- [x] Tooling
- [x] Why Write This Book?
- [x] Creating a Character
- [x] The Title Screen
- [x] Messages
- [x] Roles
- [x] Races
- [x] Genders
- [x] Alignments
- [x] Generating Abilities
- [ ] Creating the Dungeon
- [ ] Generating random rooms
- [ ] Generating Doors and Corridors
- [ ] Moving around
- [ ] Creating Stairwells
- [ ] Vision and Lighting
- [ ] Color
- [ ] Inventory
- [ ] Items
- [ ] Burden
- [ ] Money and Shops
- [ ] Food and Hunger
- [ ] Unidentified Items
- [ ] Combat
- [ ] Random Monsters
- [ ] Combat
- [ ] Magic
- [ ] Wrapping up
- [ ] Saving and Loading
- [ ] Increasing Difficulty
- [ ] What to do next
- [ ] Possible Future Chapters
- [ ] Searching, hidden doors and corridors
- [ ] Questlines
- [ ] Alternate Dungeon types
- [ ] Blessings and Curses
- [ ] Pets
- [ ] Zoos
## Building
There is a build tool included with this project that will allow you to compile the contents of the `book` directory into an EPUB-formatted e-book. First, to ensure that you’ve got the necessary dependencies for the compilation process, change to the project directory and run:
$ bundle install
We then need to have [Pandoc](http://pandoc.org/installing.html) installed.
Now, anytime you’d like to compile the book you can simply run the compile script:
$ exe/compile
Doing so will write a file entitled `write-yourself-a-roguelike.epub` to the `release` directory, overwriting any existing file with the same name.