https://github.com/Leinnan/rpack
Create tilemaps in seconds!
https://github.com/Leinnan/rpack
egui game-development tool
Last synced: 4 months ago
JSON representation
Create tilemaps in seconds!
- Host: GitHub
- URL: https://github.com/Leinnan/rpack
- Owner: Leinnan
- Created: 2023-12-07T06:52:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-27T18:03:44.000Z (5 months ago)
- Last Synced: 2025-02-09T14:01:46.351Z (5 months ago)
- Topics: egui, game-development, tool
- Language: Rust
- Homepage: http://rpack.mevlyshkin.com/
- Size: 2.74 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-bevy - `bevy_rpack`
- awesome-bevy - `bevy_rpack`
README
# rpack [](https://github.com/Leinnan/rpack/actions?workflow=CI)
Create tilemaps in seconds!
This repository contains few projects that together make a fully functional solution for generating tilemaps alongside integration to the Bevy game engine.
## Bevy rPack
[](https://crates.io/crates/bevy_rpack)
[](https://docs.rs/bevy_rpack)
A Bevy plugin with support for the `rpack.json` atlases.
More info available at [crates/bevy_rpack](https://github.com/Leinnan/rpack/tree/master/crates/bevy_rpack).
Repository contains example how to use plugin in Bevy.
## rPack CLI
[](https://crates.io/crates/rpack_cli)
[](https://docs.rs/rpack_cli)
Command line interface for generating tilemaps.
```sh
Build rpack tilemaps with ease
Usage: rpack_cli
Commands:
generate Generates a tilemap
config-create Creates a tilemap generation config
generate-from-config Generates a tilemap from config
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```
Available at [crates/rpack_cli](https://github.com/Leinnan/rpack/tree/master/crates/rpack_cli).
### Installation
Only with Cargo (Rust package manager) at the moment:
```sh
cargo install rpack_cli
```
## rPack egui
[](https://crates.io/crates/rpack_egui)
A both desktop and web frontend for generating tilemaps. Just drag and drop images into the program and generate tilemaps.
To open it in browser click one of the icons below:
[](https://mevlyshkin.itch.io/rpack)
[](http://rpack.mevlyshkin.com/)
Available at [crates/rpack_egui](https://github.com/Leinnan/rpack/tree/master/crates/rpack_egui).
## Used formats
rpack tools provides and work with two json based files.
### Atlas files
Tilemaps are using `.rpack.json` extension.
Fields:
- `size`: two element array- width and height of the tilemap
- `filename`: string- path to the atlas image file, relative to the config file
- `frames`: array- contain info about each frame in tilemap, contains `key` string field and `frame` field that is made up from fields:
- `h`- image height
- `w`- image width
- `x`- x start pos of the image in the tilemap
- `y`- y start pos of the image in the tilemap
Example:
```json
{
"filename": "tilemap.png",
"frames": [
{
"frame": {
"h": 42,
"w": 42,
"x": 418,
"y": 66
},
"key": "tiles/ship/spaceBuilding_001"
},
{
"frame": {
"h": 44,
"w": 34,
"x": 2,
"y": 2
},
"key": "tiles/agents/spaceAstronauts_004"
},
],
"size": [
512,
512
]
}
```
### Generation config files
Config files are using `.rpack_gen.json` extension.
Fields:
- `output_path`: string- path relative to the config, without extension, this is where tilemap image and `.rpack.json` config file are going to be saved
- `asset_patterns`: array of strings- search patterns for images to be included, relative paths to the config
- `format`: optional(defaults to `Png`), format of the tilemap image, currently supported values: `Png`, `Dds`
- `size`: optional(defaults to `2048`), size of the tilemap image
- `texture_padding`: optional(defaults to `2`), size of the padding between frames in pixel
- `border_padding`: optional(defaults to `0`), size of the padding on the outer edge of the packed image in pixel
Example:
```json
{
"asset_patterns": [
"tiles/agents/*",
"tiles/effects/*",
"tiles/missiles/*",
"tiles/ship/spaceBuilding_00*",
"tiles/ship/spaceBuilding_01*"
],
"output_path": "assets/tilemap",
"format": "Png",
"size": 512,
"texture_padding": 2,
"border_padding": 2
}
```