Skip to content

Latest commit

 

History

History
154 lines (132 loc) · 5.86 KB

README.md

File metadata and controls

154 lines (132 loc) · 5.86 KB
Raw

love-release

License LuaRocks Lua

Lua script that makes LÖVE game release easier (previously Bash script).
Automates LÖVE Game Distribution.
LÖVE forum topic.
Available as a LuaRocks 3 package.

Features

love-release makes your LÖVE game release easier. love-release can create from your sources: Windows executables, macOS applications, Debian packages, and simple LÖVE files.

love-release creates only one LÖVE file per release directory and keeps it synced with your sources.

love-release can extract its information from the environment: it guesses your game's title from the directory where it's stored, selects by default the latest LÖVE version from the web or uses its latest bundled LÖVE version, then parses the conf.lua file to extract even more information such as the real LÖVE version your project uses.

Usage

Usage: love-release [-D] [-M] [-a <author>] [-b] [-d <desc>]
       [-e <email>] [-l <love>] [-p <package>] [-t <title>] [-u <url>]
       [--uti <uti>] [-v <v>] [-X <exclude>] [--version] [-h] [<release>] [<source>]
       [-W [32|64]]

Makes LÖVE games releases easier !

Arguments:
   release               Project release directory.
   source                Project source directory.

Options:
   -D                    Debian package.
   -M                    macOS application.
   -W [32|64]            Windows executable.
   -a <author>, --author <author>
                         Author full name. Required for Debian.
   -b                    Compile new or updated files to LuaJIT bytecode.
   -d <desc>, --desc <desc>
                         Project description. Required for Debian.
   -e <email>, --email <email>
                         Author email. Required for Debian.
   -l <love>, --love <love>
                         LÖVE version to use.
   -p <package>, --package <package>
                         Package and command name.
   -t <title>, --title <title>
                         Project title.
   -u <url>, --url <url> Project homepage url. Required for Debian.
   --uti <uti>           Project Uniform Type Identifier. Required for macOS.
   -x <exclude_pattern>, --exclude <exclude_pattern>
                         Exclude file patterns.
   -v <v>                Project version. Required for Debian.
   -h, --help            Show this help message and exit.

For more info, see https://github.com/MisterDA/love-release

Configuration

love-release outputs a Lua table containing the information it uses to generate your project. That information can be stored in your conf.lua file to be used later.

function love.conf(t)
  t.releases = {
    title = nil,              -- The project title (string)
    package = nil,            -- The project command and package name (string)
    loveVersion = nil,        -- The project LÖVE version
    version = nil,            -- The project version
    author = nil,             -- Your name (string)
    email = nil,              -- Your email (string)
    description = nil,        -- The project description (string)
    homepage = nil,           -- The project homepage (string)
    identifier = nil,         -- The project Uniform Type Identifier (string)
    excludeFileList = {},     -- File patterns to exclude. (string list)
    releaseDirectory = nil,   -- Where to store the project releases (string)
  }
end

Installation

Dependencies

love-release is only installable through LuaRocks and highly depends on LuaRocks internal API. love-release is currently built on LuaRocks 3. LuaRocks API is not meant to be stable, and a future update could break love-release.

Required

Optional

  • love can be used to determine your system LÖVE version.
  • fakeroot and dpkg-deb are required to create Debian packages.
  • LuaJIT can be used to compile your sources, either with luarocks-luajit or with luajit if it is installed.

Install

# latest stable version
luarocks install love-release

# development version
luarocks install --server=http://luarocks.org/dev love-release

Remove Bash version

You may have previously installed the Bash version of love-release. You can remove it with the following piece of code. Take the time to assure yourself that the paths are correct and match your installation of love-release.

rm -rf '/usr/bin/love-release'	\
       '/usr/share/love-release'	\
       '/usr/share/man/man1/love-release.1.gz'	\
       '/usr/share/bash-completion/completions/love-release'	\
       '/etc/bash_completion.d/love-release'

Contribute

The documentation of love-release internals is written with LDoc. Generate it by running ldoc ..
I currently do not plan to continue the development of the Bash script, or even to fix it. If there appears to be any need for it, let me know and I might consider doing so.
Every bug report or feature request is gladly welcome !