Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
patreon: brettchalupa
custom: ["https://www.buymeacoffee.com/brettchalupa", "https://paypal.me/brettchalupa"]
custom:
[
"https://www.buymeacoffee.com/brettchalupa",
"https://paypal.me/brettchalupa",
]
4 changes: 2 additions & 2 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: '0.4.22'
mdbook-version: "0.5.2"
# mdbook-version: 'latest'

- run: mdbook build
Expand All @@ -26,7 +26,7 @@ jobs:
- name: Set up Ruby
uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
with:
ruby-version: '3.1'
ruby-version: "3.1"
- name: Install dependencies
run: bundle install

Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
book
high-score.txt
.DS_Store
errors/
52 changes: 27 additions & 25 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,45 @@
# License

_Building Games with DragonRuby_ falls under two licenses for different content within it.
_Building Games with DragonRuby_ falls under two licenses for different content
within it.

## Code Snippets

First off, the code snippets. The code examples and sample projects contained in this book are licensed under The Unlicense. You can do whatever you want with the game code from the book.
First off, the code snippets. The code examples and sample projects contained in
this book are licensed under The Unlicense. You can do whatever you want with
the game code from the book.

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
software, either in source code form or as a compiled binary, for any purpose,
commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this
software dedicate any and all copyright interest in the software to the public
domain. We make this dedication for the benefit of the public at large and to
the detriment of our heirs and successors. We intend this dedication to be an
overt act of relinquishment in perpetuity of all present and future rights to
this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>

## The Written Words

The actual text of the book where the code is described falls under a different license:
The actual text of the book where the code is described falls under a different
license:

<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://book.dragonriders.community">Building Games with DragonRuby</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://www.brettchalupa.com">Brett Chalupa</a> is licensed under <a href="http://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">Attribution-NonCommercial-ShareAlike 4.0 International<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1"></a></p>
<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://book.dragonriders.community">Building Games with DragonRuby</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://www.brettchalupa.com">Brett Chalupa</a> is licensed under <a href="http://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">Attribution-NonCommercial-ShareAlike 4.0 International<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1"></a></p>

Examples of what you can do with the book under this license as long as it maintains the same license and gives proper credit:
Examples of what you can do with the book under this license as long as it
maintains the same license and gives proper credit:

- Translate it
- Reformat it
Expand Down
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,49 @@
# Building Games with DragonRuby

An open-source book by Brett Chalupa and the Dragon Rider Community that walks you through how to build games with [DragonRuby Game Toolkit](https://dragonruby.org/toolkit/game).
An open-source book by Brett Chalupa and the Dragon Rider Community 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.
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.
When the code is pushed to the `main` branch on GitHub, an action runs that
deploys it to the `gh-pages` branch.

Download DragonRuby GTK for your platform, unzip it, and then clone the
repository inside of the new folder:

```
cd dragonruby
git clone git@github.com:DragonRidersUnite/book.git
```

## Key Versions

- DragonRuby Game Toolkit: v3.x, v4.x, v5.x
- mdBook: v0.4.22
- DragonRuby Game Toolkit: v7.x; might work for previous versions
- mdBook: v0.5.x

## Running Samples

The repository contains complete games for each separate code sample to ensure the code works and runs.
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.
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:
Clone this book repository into a DragonRuby GTK engine directory and run the
samples with:

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

Expand Down
3 changes: 1 addition & 2 deletions book.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
[book]
authors = ["Brett Chalupa", "Dragon Rider Community"]
language = "en"
multilingual = false
src = "src"
title = "Building Games with DragonRuby"
description = "A free book about making 2D games with DragonRuby Game Toolkit."
description = "A beginner-friendly guide to programming 2D games with DragonRuby Game Toolkit."

[output.html]
git-repository-url = "https://github.com/DragonRidersUnite/book"
Expand Down
Loading
Loading