This is the Ruby 2D gem. Check out the website for all things getting started, documentation, news, and more. The roadmap will show you where we're headed, and if you're interested in getting involved in development, read the contributor's guide. If you encounter any issues, chat with us, send a note to the mailing list, or open an issue. Enjoy!
To work on the gem locally, first clone this repo with the test media Git submodule:
git clone --recursive https://github.com/ruby2d/ruby2d.gitAlong with cloning this repo, the command above will grab the contents of the test_media repo and place it in the tests/media directory. Simply run git submodule update --remote anytime to get the latest changes from test_media (i.e. when there's a new commit available). If you've already cloned this repo without the --recursive flag, make sure to run git submodule init before updating the submodule.
Next, install Bundler and run bundle install to get the required development gems.
Finally, install Simple 2D by following the instructions in its README.
Ruby 2D uses a combination of automated tests via RSpec and manual, interactive tests to verify the correctness of visual, audio, and input functionality. Build the gem and run all automated tests with the rake command. Run other tests using rake <name_of_test>, such as rake testcard. Use rake -T to see a list of all available tests.
- Update the Simple 2D minimum version required in extconf.rb
- Run tests on all supported platforms
- Update the version number in
version.rb, commit changes - Create a new release in GitHub, with tag in the form
v#.#.# - Push to rubygems.org with
gem push ruby2d-#.#.#.gem