Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.59 KB

README.md

File metadata and controls

66 lines (44 loc) · 2.59 KB
Raw

Scale

repeating red dragon scale pixel art

Simple DragonRuby Game Toolkit Game Starter Template

Quickly start a new DragonRuby Game Toolkit game with helpful extensions.

Bugs / Features

Last tested against DragonRuby Game Toolkit v3.24.

  • Displays framerate in the upper-right hand corner of the game when running in development mode
  • #debug? helper to easily check if the game is running in development mode; useful for custom commands
  • Reload all sprites in development using the i key, requires use of SPATHS constant
  • Reset the game with r key, calls $gtk.reset
  • Put all debug-only code in #debug_tick
  • #init method that gets run once on game boot
  • CHEATSHEET.md with common APIs from DRGTK and Scale
  • #version to get the version of your game
  • Constants for various values and enums: FPS, BLEND_*, ALIGN_*

Use It

There are two main ways you can use the Scale template for your games.

Download the Zip

The fastest way to get started is to download the template zip file and put it into your unzipped DragonRuby Game Toolkit folder.

  1. Download and unzip the DragonRuby Game Toolkit engine zip
  2. Delete the mygame directory
  3. Download Scale
  4. Unzip the scale-main.zip
  5. Move the scale-main folder into the DRGTK folder
  6. Rename scale-main to mygame
  7. Start DragonRuby, and make an awesome game!

Use GitHub's Template System

If you're going to track your game with Git and use GitHub, the baked-in template system will get you going quickly.

  1. View the project on GitHub: https://github.com/DragonRidersUnite/scale
  2. Click "Use this template"
  3. Click "Create a new repository"
  4. Fill out the details and create the repository
  5. Unzip the DragonRuby Game Toolkit engine zip
  6. Delete the mygame directory
  7. Clone your new repository into the DRGTK engine folder with the folder name mygame, example: git clone git@github.com:USERNAME/REPO.git mygame
  8. Start DragonRuby, and make an awesome game!

Template License

The template source code falls under the Unlicense, meaning it is dedicated to the public domain and you are free to do with it what you want.

Contribute

Conributions are welcome!

Open an issue or submit PRs if you notice something isn't working.

If you find yourself adding the same files, methods, constants, etc. to your DRGTK games, submit a PR to add it to Scale.

[Clear this README out and add your own details!]