Miroirs/dragonruby-book
1
0
Fork 0
mirror of https://github.com/DragonRidersUnite/book synced 2024-12-24 09:58:48 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
Mirror of https://github.com/DragonRidersUnite/book
202 commits 4 branches 6 tags 8 MiB
Cython 97.7%
Ruby 2.3%
Find a file
Brett Chalupa 18fc658db6
Some checks failed
github pages / deploy (push) Has been cancelled
Details
Merge pull request #36 from DragonRidersUnite/fix-broken-links 
Fix broken Code the Classics link
2024-12-03 20:35:41 -05:00
.github chore: add CODEOWNERS 2023-07-30 06:36:47 -04:00
bin fix(sitemap): remove duplicate index 2022-12-11 19:58:42 -05:00
design chore: check in design files 2022-12-11 18:31:25 -05:00
src Fix broken Code the Classics link 2024-12-03 20:32:40 -05:00
theme chore: social metadata & revised desc 2022-12-11 13:26:18 -05:00
.gitignore Ignore .DS_Store on macOS 2023-05-14 09:47:36 +03:00
book.toml chore: simplify header features 2022-12-12 18:16:41 -05:00
CNAME feat: init book 2022-11-23 10:51:09 -05:00
Gemfile feat: sitemap generation 2022-12-11 19:56:14 -05:00
Gemfile.lock feat: sitemap generation 2022-12-11 19:56:14 -05:00
LICENSE.md fix: typo in license 2022-12-07 09:20:39 -05:00
README.md chore: fix README typo 2023-07-30 06:41:55 -04:00

README.md

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.

Play the game you'll be building, right in the browser.

Support the creation and expansion of this book.

Developing

The book is authored and published with mdBook. 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.x, v4.x, v5.x
  • mdBook: v0.4.22

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:

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

Publishing

How to make a release:

  1. Merge the main branch into offline
  2. Generate a new PDF via printing in Firefox, turning off the header and footer
  3. Generate an HTML version of the book and zip it up
  4. Create zips and upload them on itch.io
  5. Create tags and releases for the offline branch and the main branch

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