Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wqferr/slicy
9-slice library for Love2D
https://github.com/wqferr/slicy
Last synced: 6 days ago
JSON representation
9-slice library for Love2D
- Host: GitHub
- URL: https://github.com/wqferr/slicy
- Owner: wqferr
- License: gpl-3.0
- Created: 2022-05-30T00:57:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-30T02:08:28.000Z (over 2 years ago)
- Last Synced: 2024-08-02T06:21:01.218Z (3 months ago)
- Language: Lua
- Size: 33.2 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-love2d - Slicy - A newer 9patch/9slice library fixing some issues with Patchy. (UI)
README
# slicy
9-slice library for Love2D
https://user-images.githubusercontent.com/13891260/170899848-41cef538-efcf-44e2-8dae-637b390b208c.mov
## Installation
The only required file is `slicy.lua`, so simply drop it into the root of your Love2D project. Alternatively, you can also clone the entire repository onto the root directory.
## About
9-slicing is a technique where only specific segments of an image are scaled. This allows for the corners (and even the edges in some cases) to suffer no distortion from resizing.
This library was created as a more modern version of [patchy](https://github.com/excessive/patchy), since it has some issues with its content window algorithm, is 3 years old as of writing this, and, to be quite frank, I just wanted to code this, it was fun.
## Demo
The demo video was recorded using the `main.lua` provided in the directory. Running `love .` should provide you with the exact same demo I used to record.
Use the arrow keys to adjust window size. Press spacebar to toggle debug draw mode.
## File format
The file format (`*.9.png`) is a regular PNG file, with 2 added rows and columns, 1 on each side. These will be called the "metadata" from now on. Here's an example of a `.9.png` file:
The goal is to make this pane be adjustable as in the video demo above. To do this, we need to give slicy 2 bits of information:
- Which parts are safe to scale
- Which parts are safe to display content on (e.g., so we don't place text over the borders)
### The scale part
The scale part is easy: since this is pixel art, we can just grab a 1 pixel slice from the "edges" and call it a day. To do this, we mark the region (in this case, a single pixel on each axis) with black in the left and top metadata. The image outside this range will never be scaled, so the corners are safe.
If this weren't pixel art, instead of a single pixel, we would place black pixels over the range we're ok with stretching and shrinking.
### The content part
The content part is... also easy! Same thing as the scale part, except we set the range with black pixels on the right and bottom metadata. Pixels outside this range will never be included in the content window (technically it only sets a padding, but for 99% of cases it should work fine just thinking of it as an this-is-ok-range).
## Thanks!
To you for reading and/or using slicy, and to [Buch](https://opengameart.org/users/buch) for making the [panel used for the demo](https://opengameart.org/content/sci-fi-user-interface-elements).