6302efed97
Short options are stored in the OPTIONS variable, and longs in
LONG_OPTIONS. Modules scripts need to add theses to be able to use
options. Theses lines are then parsed by sed at make-time and added to
the corresponding variable in the main script.
init_module now requires a third argument corresponding to the option
that will trigger the execution of the module.
Files can also be passed by argument to zip. They are stored in the
FILES array.
check_deps:
- add dependency check for GNU getopt,
- echo errors to stderr
gen_version now returns 0 on success and 1 on failure.
Add short_help function. Shown if -h options is passed, or on parsing
options failure.
exit_module:
- add 'options' exit value if there is an error while parsing the
options,
- add 'version' exit value if there is an error while generating
LÖVE version from user input.
dump_var shows files to zip.
Script will now exit if it has not been embedded nor installed.
Fix bugs with default module.
NAME
love-release.sh -- Bash script to generate Love 2D game releases
INSTALLATION
First clone the repository, then you have two choices:
- you can build the script and install it on your system, and benefit of command-line completion, man page and extensibility,
- or make an embedded version with every thing you need in one file.
Alternatively, you can change the installation directories by editing the Makefile.
# Install on your system (assumes root rights)
make
make install
# All-in-one
make embedded
To remove love-release, if you haven't changed the default installation directories, run make remove.
SYNOPSIS
love-release.sh [-adlmw] [-n project_name] [-r release_dir] [-v love_version] [FILES...]
DESCRIPTION
love-release.sh can be used to generate Love 2D game applications and get over the fastidious zipping commands you had to do.
The script fully supports Windows, MacOS either on x86 or x64,
Debian and Android packages.
It needs an Internet connection to download Love files,
and relies on curl, zip and unzip commands.
CONFIGURATION
You can install lua and add a conf.lua to your project to get automatic releases.
See the conf.lua file included to see how configuration works.
OPTIONS
-h Print a short help
--help Print this longer help
OPERATING SYSTEMS
-a Create an Android package.
In order to create an Android package, you must have installed the Android SDK.
See Building LÖVE for Android,
but there is no need to install the LÖVE port to Android,
as the script will handle this by itself.
You also might want to provide more informations about it.
See the ANDROID section below.
-d Create a deb package. Aimed at Debian and Ubuntu derivatives.
In order to create a Debian package, you must provide more informations about it.
See the DEBIAN section below.
-l Create a plain Love file. It is just a zip of your sources, renamed in *.love.
Mostly aimed at Linux players or developers and the most common distribution process.
-m Create MacOS application.
Starting with Love 0.9.0, Love no longer supports old x86 Macintosh.
If you are targeting one of these, your project must be developped with Love 0.8.0 or lower.
Depending on the Love version used, the script will choose which one,
between x64 only or Universal Build to create.
-w Create Windows application.
Starting with Love 0.8.0, a release is specially available for Windows x64.
If you are targeting one of these, your project must be developed with Love 0.8.0 or newer.
Remember that x86 is always backwards compatible with x64.
Depending on the Love version used, the script will choose which one,
between x64 and x86 or x86 only to create.
-w32 Create Windows x86 executable only
-w64 Create Windows x64 executable only
PROJECT OPTIONS
-n Set the projects name. By default, the name of the current directory is used.
-r Set the release directory. By default, a subdirectory called releases is created.
-v Love version. Default is 0.9.1.
Starting with Love 0.8.0, a release is specially available for Windows x64.
Starting with Love 0.9.0, Love no longer supports old x86 Macintosh.
-x Exclude file or directory.
--description Set the description of your project.
--homepage Set the homepage of your project.
WINDOWS
You can create an installer. If you don’t, you will have zip of a folder
containing your game executable and its dlls.
Creating installers and using icons require Wine to be installed.
When the script installs Resource Hacker or Inno Setup, an install wizard GUI will appear.
Please let everything as is, do not uncheck checkboxes or replace installation directory.
--win-icon Path to an ico file to use.
--win-installer Create an installer with Inno Setup.
--win-appid Your game ID. You can use a GUID/UUID and generate one with uuidgen.
It should remain the same between updates.
Mandatory if using an installer, not needed for a simple zip.
--win-maintainer-name Set the maintainer’s name.
Mandatory if using an installer, not needed for a simple zip.
--win-package-name Set the name of your package.
Mandatory if using an installer, not needed for a simple zip.
--win-package-version Set the version of your package.
Mandatory if using an installer, not needed for a simple zip.
MAC OS X
--osx-icon Path to an icns file to use.
--osx-maintainer-name Set the maintainer’s name. Provide it for OS X CFBundleIdentifier.
DEBIAN
--deb-icon Path to a single folder where icons are stored.
To be properly recognized, icons filename must contain YYxYY,
where YY is the resolution of the icon.
SVG files are recognized if suffixed with .svg.
Other files will be ignored.
--maintainer-email Set the maintainer’s email.
--deb-maintainer-name Set the maintainer’s name.
--deb-package-name Set the name of the package and the command that will be used to launch your game.
By default, it is the name of your project converted to lowercase,
with eventual spaces replaced by dashes.
--deb-package-version Set the version of your package.
ANDROID
Note that every argument passed to the options should be alphanumerical,
with eventual underscores (i.e. [a-zA-Z0-9_]), otherwise you'll get errors.
--apk-icon Path to a single folder where icons are stored.
The script will first look up for filename that contains
42x42, 72x72, 96x96 or 144x144.
It will then search the icon directory for subdirectories like
drawable-mdpi, drawable-hdpi, drawable-xhdpi and drawable-xxhdpi
to find an ic_launcher.png image.
OUYA icon (size 732x412, or drawable-xhdpi/ouya_icon.png) is supported.
--apk-activity The name of the class that extends GameActivity.
By default it is the name of the project with ‘Activity’ appended,
eventual spaces and dashes replaced by underscores.
--apk-maintainer-name Set the maintainer’s name.
It must be only alphanumerical characters, with eventual underscores.
--apk-package-name Set the name of the package.
By default, it is the name of your project, with eventual spaces replaced by underscores.
--apk-package-version Set the version of your package.
--update-android Update the love-android-sdl2.git repository used in the cache.
OTHERS
--clean Clean the cache located in ~/.cache/love-release.
One can replace the Love files there.
MODULES
The script is modular.
Each different platform is handled by a subscript stored in scripts.
If you’d like to add the support of another platform,
or write your own build script, see scripts/example.sh.
ICONS
The script doesn’t yet handle the process of creating icons, but if provided it can use them.
- if you want to create MacOS icons (.icns), and you are
- if you want to create Windows icons (.ico), you can
- use icoutils to create the icon,
- then Wine and Resource Hacker to set the icon. This last step can be automatically done, assuming Wine is installed.
SEE ALSO
https://www.love2d.org
https://www.love2d.org/wiki/Game_Distribution
https://www.github.com/MisterDA/love-release
THANKS
The work done on Debian packaging is highly inspired by what josefnpat did. Thanks to him !