Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Vovkiv/resolution_solution
Yet another scaling library. Currently in maintenance-only mode.
https://github.com/Vovkiv/resolution_solution
documentation game-development library love2d lua pixel-perfect scaling scaling-methods single-file stretch
Last synced: 3 months ago
JSON representation
Yet another scaling library. Currently in maintenance-only mode.
- Host: GitHub
- URL: https://github.com/Vovkiv/resolution_solution
- Owner: Vovkiv
- License: unlicense
- Created: 2022-01-07T19:00:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-15T17:39:09.000Z (6 months ago)
- Last Synced: 2024-01-24T08:06:48.445Z (5 months ago)
- Topics: documentation, game-development, library, love2d, lua, pixel-perfect, scaling, scaling-methods, single-file, stretch
- Language: Lua
- Homepage: https://github.com/Vovkiv/resolution_solution
- Size: 8.05 MB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: history/readme.md
- License: LICENSE
Lists
- awesome-love2d - Resolution Solution - Scale library, that help you add resolution support to your games! (Drawing)
README
# Resolution Solution
Yet another scaling library. Currently in maintenance-only mode.
---
Resolution Solution was inspired by:
* [TLfres](https://love2d.org/wiki/TLfres)
* [PUSH](https://github.com/Ulydev/push)
* [SimpleScale](https://github.com/tomlum/simpleScale)
Other similar scaling libraries:
* [Center](https://github.com/S-Walrus/center)
* [maid64](https://github.com/adekto/maid64)
* [love2d-pixelscale](https://github.com/DimitriBarronmore/love2d-pixelscale)
* [CScreen](https://github.com/CodeNMore/CScreen)
* [terebi](https://github.com/oniietzschan/terebi)
# Video demonstration
[](https://youtu.be/cslfWOpetrc)
# Basic setup
1. Require library:
```lua
local rs = require("resolution_solution")
```
2. Configure library:
```lua
rs.conf({game_width = 640, game_height = 480, scale_mode = 3})
```
3. Make window resizable (optionally, but stongly advised):
```lua
rs.setMode(rs.game_width, rs.game_height, {resizable = true})
```
4. Hook into `love.resize`:
```lua
love.resize = function(w, h)
rs.resize()
end
```
5. Draw something:
(In this example we used scissors, but there [another way](examples/basic_setup_with_canvas) to achieve this. Read [manual](resolution_solution_documentation.pdf) or check [examples](examples) for more info.)
```lua
love.draw = function()
rs.push()
local old_x, old_y, old_w, old_h = love.graphics.getScissor()
love.graphics.setScissor(rs.get_game_zone())
love.graphics.setColor(1, 1, 1)
love.graphics.print("Hello, world!", rs.game_width / 2, rs.game_height / 2)
love.graphics.setScissor(old_x, old_y, old_w, old_h)
rs.pop()
end
```
# Manual, examples, demo
* [.pdf manual](resolution_solution_documentation.pdf).
* [.odt manual](resolution_solution_documentation.odt).
* [.love demo example that you can run](demo.love).
* [examples folder](examples).
# Selling points of this library
* Library have 3 scale modes and you can switch between at any time:
1. Aspect Scaling mode - scaling with preserved aspect.
2. Stretching - stretch game to fill entire window.
3. Pixel Perfect - will scale, using only integer scale factors and adds black bars if it can't. Must-have for pixel-art.
* Library doesn't force you to use any specific way to scale your content, unlike some libraries. You can choose canvas, scissors, draw rectangles on top of game, shader, etc.
* Library written with [kikito's guide](https://web.archive.org/web/20190406163041/http://kiki.to/blog/2014/03/30/a-guide-to-authoring-lua-modules/) in mind, which resulted in very monkey-patchable library! No unreachable locals, no globals, nothing like that! Everything that library produces during calculations can be reached by simple accessing library table: `rs.game_width`, `rs.scale_mode`, `rs.game_zone.x`, etc.
* Library has [.pdf manual](resolution_solution_documentation.pdf), that includes some illustrations, examples, explanations, tips and tricks.
* Written with `snake_case`.
* Library licensed under [`The Unlicense`](LICENSE). Do whatever you want with it.
# Games made using this library
By togfoxy:
* [Autarky2](https://github.com/togfoxy/Autarky2)
* [SpaceFleetBattles](https://github.com/togfoxy/SpaceFleetBattles)
* [FormulaSpeed](https://github.com/togfoxy/FormulaSpeed)
* [Silent strike](https://codeberg.org/togfox/SilentStrike)
By [Gunroar](https://hmmmgames.itch.io/):
* [YOU ARE DRAGON](https://hmmmgames.itch.io/dragon)
* [Rem Psycho](https://hmmmgames.itch.io/rem-psyche)
* [Dust: Battle Beneath](https://hmmmgames.itch.io/dust-bb)
# Announces
I will post announces when new update will be dropped [here](https://love2d.org/forums/viewtopic.php?t=92494).
# Contacts
If you have any questions about this library, have ideas, etc, you can contact me via:
1. [Submit new issue](https://github.com/Vovkiv/resolution_solution/issues/new).
2. [love forum](https://love2d.org/forums/memberlist.php?mode=viewprofile&u=169762).
3. [matrix](https://matrix.to/#/@vovkiv:matrix.org).
4. Email - [email protected]