{"id":13571589,"url":"https://github.com/DragonRidersUnite/book","last_synced_at":"2025-04-04T08:31:41.468Z","repository":{"id":63688684,"uuid":"569783837","full_name":"DragonRidersUnite/book","owner":"DragonRidersUnite","description":"A comprehensive guide to shipping cross-platform games with ease using DragonRuby Game Toolkit.","archived":false,"fork":false,"pushed_at":"2024-12-04T01:41:49.000Z","size":7239,"stargazers_count":54,"open_issues_count":0,"forks_count":15,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-12-04T02:28:39.949Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://book.dragonriders.community","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DragonRidersUnite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"brettchalupa","custom":["https://www.buymeacoffee.com/brettchalupa","https://paypal.me/brettchalupa"]}},"created_at":"2022-11-23T15:52:03.000Z","updated_at":"2024-12-04T01:35:46.000Z","dependencies_parsed_at":"2024-12-04T02:26:10.789Z","dependency_job_id":"1cb2382b-1bdf-42ed-ac56-275d1e85b8c5","html_url":"https://github.com/DragonRidersUnite/book","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DragonRidersUnite%2Fbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DragonRidersUnite%2Fbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DragonRidersUnite%2Fbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DragonRidersUnite%2Fbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DragonRidersUnite","download_url":"https://codeload.github.com/DragonRidersUnite/book/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247147361,"owners_count":20891680,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T14:01:03.564Z","updated_at":"2025-04-04T08:31:36.459Z","avatar_url":"https://github.com/DragonRidersUnite.png","language":"Ruby","funding_links":["https://patreon.com/brettchalupa","https://www.buymeacoffee.com/brettchalupa","https://paypal.me/brettchalupa","https://buymeacoffee.com/brettchalupa"],"categories":["Ruby"],"sub_categories":[],"readme":"# Building Games with DragonRuby\n\nAn 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).\n\n[Play the game you'll be building, right in the browser.](https://dragonridersunite.itch.io/dragonruby-book)\n\n[Support the creation and expansion of this book.](https://buymeacoffee.com/brettchalupa)\n\n## Developing\n\nThe 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.\n\nRun `mdbook serve` to boot up the web server that handles compiling everything.\n\nWhen the code is pushed to the `main` branch on GitHub, an action runs that deploys it to the `gh-pages` branch.\n\n## Key Versions\n\n- DragonRuby Game Toolkit: v3.x, v4.x, v5.x\n- mdBook: v0.4.22\n\n## Running Samples\n\nThe repository contains complete games for each separate code sample to ensure the code works and runs.\n\nCode samples live in `src/code` and then are organized by chapter and then sections within a chapter.\n\nClone this book repository into a DragonRuby GTK engine directory and run the samples with:\n\n``` console\n./dragonruby book/src/code/chapter_03/01_input\n```\n\n## Publishing\n\nHow to make a release:\n\n1. Merge the `main` branch into `offline`\n2. Generate a new PDF via printing in Firefox, turning off the header and footer\n3. Generate an HTML version of the book and zip it up\n4. Create zips and upload them on itch.io\n5. Create tags and releases for the offline branch and the main branch\n\nThe 3D cover file is generated with https://diybookcovers.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDragonRidersUnite%2Fbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDragonRidersUnite%2Fbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDragonRidersUnite%2Fbook/lists"}