Scrappy Ferret libraries are all about making things easier for your Solar2D development.
The idea being if they can take care of the busy-work for you – such as data saving, font management, controller input, and other things – then you can focus on the fun stuff.
I use all the libraries myself, both at Scrappy Ferret and over at Glitch Games, so they are in constant development.
There are multiple ways to include one of my libraries in your Solar2D project, the simplest is probably via the plugin, as outlined below, however if you wish you can also access the source code.
To use a library as a plugin simply purchase it the Solar2D Plugins store, then Activate it and then hit the build.settings button to get the required setup info, or download the individual stubs if that’s your jam.
You then just need to require the plugin in main.lua, or where appropriate for your project, like any other plugins.
require( "plugin.pluginName" )
If you wish you to access the source code directly for any of my libraries they are all hosted on GitLab here.
You can then clone or fork them if you wish, or add the libraries as a submodule to your project with this command ( making sure to change ‘name’ to the lowercase part of the library name, i.e. ‘scrappySettings’ becomes ‘settings’ ):
git submodule add https://gitlab.com/scrappyferret-libs/scrappy-name.git name
Then you just need to include it in your project, again making sure to change ‘name’ as above.
require( "name.core" )
API docs and examples are all provided on the individual pages for each library.
All my libraries are free to use however if you find then useful, and are able to, I’d appreciate a coffee, or if it’s easier just purchase the plugin version.
Image by Free-Photos from Pixabay
Write a comment