Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webmatze/sprite_fusion_tilemap
Ruby Tilemap Loader for Sprite Fusion JSON Export
https://github.com/webmatze/sprite_fusion_tilemap
Last synced: 9 days ago
JSON representation
Ruby Tilemap Loader for Sprite Fusion JSON Export
- Host: GitHub
- URL: https://github.com/webmatze/sprite_fusion_tilemap
- Owner: webmatze
- License: mit
- Created: 2024-01-11T08:20:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-18T17:31:55.000Z (6 months ago)
- Last Synced: 2024-11-11T10:51:07.152Z (2 months ago)
- Language: Ruby
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ruby Tilemap Loader for Sprite Fusion JSON Export
## Introduction
This Ruby Tilemap Loader is designed to work with the JSON export format of [Sprite Fusion](https://www.spritefusion.com/), an online Tilemap Generator widely used in game development. This README provides you with all the necessary information to get started with using this loader in your projects.
## Features
- Seamless Integration: Easily load and manage tilemaps exported from Sprite Fusion.
- Optimized for Ruby: Tailored to fit into Ruby-based game development workflows.
- Flexible and Customizable: Easily adaptable to various game development needs.
## Prerequisites
Before you begin, ensure you have the following installed:
- Ruby (Version 3.0 or later)
## Usage
Here's a quick guide on how to use the Ruby Tilemap Loader in your project:
1. Export your tilemap from Sprite Fusion in JSON format.
2. Include the Tilemap Loader in your Ruby project.
3. Load the tilemap using the following code snippet:
```ruby
# Sample code demonstrating how to load a tilemap
path = "#{File.dirname(__FILE__)}/data/tilemap.json"
tilemap_data = JSON.load_file(path)
tilemap = SpriteFusion::Tilemap.load(tilemap_data)
```
## API Reference
[Provide a brief overview of the main classes and methods in your loader, including any important parameters and return types.]
## Examples
Here are some examples of how to use the Tilemap Loader in various scenarios:
```ruby
# get the tile size
size = tilemap.tile_size
# get the map width and height
width = tilemap.map_width
height = tilemap.map_heigt
# iterate over the layers
tilemap.layers.each do |layer|
puts layer.name
puts "is colliding layer: #{layer.collider?}"
puts "number of tiles: #{layer.tiles.size}"
# iterate over the tiles
layer.tiles.each do |tile|
puts "Tile sprite index: #{tile.id}"
puts "Tile position on map: #{tile.x}:#{tile.y}"
end
end
```
## Contributing
Contributions to the Ruby Tilemap Loader are always welcome, whether it's improving documentation, adding new features, or fixing bugs.
## License
This project is licensed under the [MIT] - see the LICENSE file for details.
## Acknowledgments
- Thanks to [Hugo Duprez](https://www.hugoduprez.com/) for his excellent [Sprite Fusion](https://www.spritefusion.com/) Tilemap Generator.