dragonruby-book/README.md

# Building Games with DragonRuby

🚧 A work in progress! Expect typos, issues, and incompleteness. 🚧

An open source book that walks you through how to build games with [DragonRuby Game Toolkit](https://dragonruby.org/toolkit/game).

[Play the game you'll be building, right in the browser.](https://dragonridersunite.itch.io/dragonruby-book)

[Support the creation and expansion of this book.](https://buymeacoffee.com/brettchalupa)

## Developing

The book is authored and published with [mdBook](https://rust-lang.github.io/mdBook/guide/installation.html). Follow the installation instructions to get the `mdbook` binary installed.

Run `mdbook serve` to boot up the web server that handles compiling everything.

When the code is pushed to the `main` branch on GitHub, an action runs that deploys it to the `gh-pages` branch.

## Key Versions

- DragonRuby Game Toolkit: v3.24
- mdbook: v0.4.21

## Running Samples

The repository contains complete games for each separate code sample to ensure the code works and runs.

Code samples live in `src/code` and then are organized by chapter and then sections within a chapter.

Clone this book repository into a DragonRuby GTK engine directory and run the samples with:

``` console
./dragonruby book/src/code/chapter_03/01_input
```

## Publishing

The 3D cover file is generated with https://diybookcovers.com/
feat: flesh out summary 2022-11-23 17:16:21 +01:00			`# Building Games with DragonRuby`
feat: add readme 2022-11-23 16:58:58 +01:00
chore: make clear it's a wip 2022-11-24 03:56:22 +01:00			`🚧 A work in progress! Expect typos, issues, and incompleteness. 🚧`

feat: add readme 2022-11-23 16:58:58 +01:00			`An open source book that walks you through how to build games with [DragonRuby Game Toolkit](https://dragonruby.org/toolkit/game).`

chore: add itch link to README 2022-12-11 17:43:48 +01:00			`[Play the game you'll be building, right in the browser.](https://dragonridersunite.itch.io/dragonruby-book)`

chore: call out funding 2022-12-08 12:58:41 +01:00			`[Support the creation and expansion of this book.](https://buymeacoffee.com/brettchalupa)`

chore: document 3d cover generator 2022-11-24 01:48:21 +01:00			`## Developing`

chore(docs): add info to readme about developing 2022-11-24 03:55:38 +01:00			The book is authored and published with [mdBook](https://rust-lang.github.io/mdBook/guide/installation.html). Follow the installation instructions to get the `mdbook` binary installed.

			Run `mdbook serve` to boot up the web server that handles compiling everything.

			When the code is pushed to the `main` branch on GitHub, an action runs that deploys it to the `gh-pages` branch.

chore(docs): specify dep vers 2022-12-06 13:38:19 +01:00			`## Key Versions`

			`- DragonRuby Game Toolkit: v3.24`
			`- mdbook: v0.4.21`

feat: structure code samples to be runnable DRGTK games This ensures we can easily test the code for a given chapter and verify it does what is expected. 2022-12-03 13:07:33 +01:00			`## Running Samples`

			`The repository contains complete games for each separate code sample to ensure the code works and runs.`

			Code samples live in `src/code` and then are organized by chapter and then sections within a chapter.

			`Clone this book repository into a DragonRuby GTK engine directory and run the samples with:`

			``` console
			`./dragonruby book/src/code/chapter_03/01_input`
			```

chore: document 3d cover generator 2022-11-24 01:48:21 +01:00			`## Publishing`

			`The 3D cover file is generated with https://diybookcovers.com/`