Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/videah/splashy
LÖVE Splash Screen Library
https://github.com/videah/splashy
Last synced: 2 months ago
JSON representation
LÖVE Splash Screen Library
- Host: GitHub
- URL: https://github.com/videah/splashy
- Owner: videah
- License: other
- Created: 2015-01-18T19:51:15.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-11-04T00:48:51.000Z (about 1 year ago)
- Last Synced: 2024-08-02T06:22:19.356Z (6 months ago)
- Language: Lua
- Homepage:
- Size: 24.4 KB
- Stars: 40
- Watchers: 4
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-love2d - splashy - Splash Screen Library. (Utilities)
README
__splashy__ is a simple and basic library for LÖVE, that allows the easy implementation of splash screens to any project.
# Installation
To install, extract the splashy folder to somewhere in your project (usually a /libs folder)
Then setup your main.lua like this:
```lua
splashy = require 'path/to/splashy/folder'
function love.draw()
splashy.draw()
end
function love.update(dt)
splashy.update(dt)
end
```
Then you'll have a barebones installation complete!
# Demo
You can see the code demo of the library [here.](https://github.com/VideahGams/splashyDemo)
# Interface
## Splash Creation
```lua
splashy.addSplash(image, duration, index, color, scale)
```
* `image` is a drawable (usually an image) to be drawed in a splash.
* `duration` is an optional argument, to set how long the image fade will last. It must be a positive number. (default: 2)
* `index` is an optional argument allowing to set custom splash index number for any reason you would need to do so.
* `color` is an optional argument that will determine the background color of the splash screen
* `scale` is an optional argument that will affect the final size of the splash screen image
## On Complete
```lua
splashy.onComplete(func)
```
* `func` is a callable function to be ran once all the splash screens are finished.
There are 2 main ways of using this:
```lua
splashy.onComplete(function() print("This is ran one time after all splashes are finished.") end)
```
```lua
splashy.onComplete(printFinishText)
function printFinishText()
print("This is ran one time after all splashes are finished.")
end
```
Using this function is useful for switching gamestate.
## Splash Skipping
This function skips the current splash screen onto the next one:
```lua
splashy.skipSplash()
```
Whilst this one skips all splashes, running the onComplete function:
```lua
splashy.skipAll()
```
## Custom Resolutions
Use this function to set the screen resolution that will be used in the internal calculations. This is useful if you use a screen scaling library, like [push](https://github.com/Ulydev/push) or [TLfres](https://love2d.org/wiki/TLfres).
```lua
splashy.setScreenSize (width, height)
```
# Credits
[tween.lua](https://github.com/kikito/tween.lua) is used for the tweening/fading.
Check LICENCE.md for more info.
# Changelog
v1.0:
* First Release.
# Notes
This library has/is a learning experience for me, if theres any problems be sure to raise them in the issues.
Pull requests are welcome :)