https://github.com/chadowo/aniruby
Create sprite animations on Gosu, simply and easily
https://github.com/chadowo/aniruby
game-development gamedev gamedev-library gosu libgosu ruby
Last synced: 2 months ago
JSON representation
Create sprite animations on Gosu, simply and easily
- Host: GitHub
- URL: https://github.com/chadowo/aniruby
- Owner: Chadowo
- License: mit
- Created: 2023-08-19T22:02:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T13:25:56.000Z (11 months ago)
- Last Synced: 2024-10-30T13:52:58.711Z (8 months ago)
- Topics: game-development, gamedev, gamedev-library, gosu, libgosu, ruby
- Language: Ruby
- Homepage:
- Size: 208 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# AniRuby
  
Create sprite animations on [Gosu](https://www.libgosu.org/), simply and easily.
## Summary
This gem will provide you with a nice n easy interface to do sprite animations
on Gosu, while being as nifty and simple as possible.
The gem is made in pure Ruby with no dependencies at all (except Gosu, of course) so
it's quite lightweight.
## Install
You can install the gem with the following command:
```console
gem install aniruby
```
or use it with a bundle:
```ruby
gem 'aniruby'
```
## Getting Started
The smallest example:
```ruby
require 'gosu'
require 'aniruby'
class MyWindow < Gosu::Window
def initialize
super(800, 600, false)
@animation = AniRuby::Animation.new('my_spritesheet.png', 32, 32,
0.15, retro: false, loop: true)
end
def update
# Remember to update your animation!
@animation.update
end
def draw
@animation.draw(0, 0)
end
end
```
### Explanation
When you create a animation, you'll need to have an *spritesheet*, where you have
each sprite of the animation, that's the first argument to `Animation#new`, then
you'll need the dimensions of each individual sprite on your spritesheet, in the
example provided we assume each sprite in the spritesheet is 32x32. Take for example
the following spritesheet courtesy of penzilla on [Itch.io](https://penzilla.itch.io/hooded-protagonist)
when we load it, it'll be divided into different image based on the individual
dimensions of each sprite, so if we specify 32 as width and 32 as height then the
spritesheet will be divided like this:
That's the bare minimum to get an animation, of course you can enable Gosu's retro
option so pixel animations will still look crisp when scaled, enable looping or specify
the duration of the animation (or for every frame even!).
In the example above we initialize the animation with retro off, looping on and
with a duration of 0.15 (150ms) for every frame. So we'll get something like this:
Ain't that nice?
### Drawing
You can draw an animation like any other `Gosu::Image`! An animation has both
`Animation#draw` and `Animation#draw_rot`, these methods mimic the ones on Gosu, so you don't
have to learn anything new.
### Extras
Each `Animation` has extra helpful methods, like `pause` & `unpause`, `reset`,
`done?`, etc. I recommend you to look on the source, its pretty small and easy to
understand, or build the YARD documentation with:
```console
rake doc
```
## Development
### Setup
First clone this repo locally:
```console
git clone https://github.com/Chadowo/aniruby
```
Next you'll need to install the development dependencies of this gem with
`bundle install`, Then you can use `rake` to build or test the gem.
### Testing
[Minitest](https://github.com/minitest/minitest) is used to unit test this gem.
To run the tests just call `rake`.
## Roadmap
- more fine-grained control of animation
- being able to make an animation stitching `Gosu::Image`'s together
- mirroring
- inverse animation
- multiple animation from a single spritesheet
## License
This gem is licensed under the [MIT license](LICENSE).