ngscheurich / loverboy

💘 Adds libraries to a LÖVE project

💘 Löverboy

I learned my passion in the good old-fashioned school of lover boys

Löverboy makes it easy to add Lua libraries to your LÖVE project with a simple set of commands. Library files are added directly to your project directory so distributing your game is a snap.

Table of contents

• Loverboy
  • Table of Contents
  • Installation
  • Usage
  • Roadmap
  • Contributing
  • License

Installation

The easiest way to install Löverboy is using LuaRocks:

$ luarocks install loverboy

You’ll also need the metafiles that describe the libraries available to Löverboy:

$ git clone https://github.com/ngscheurich/loverboy-mfiles.git ~/.local/share/loverboy

Usage

Usage: loverboy [OPTIONS]

COMMANDS:
  add           Add a library to the current project
  info          Display information about a library
  search        Search available libraries
  update        Update local metafiles cache

OPTIONS:
  -v, --version Prints the program's version

Roadmap

• Install multi-file libraries, e.g., hump, to their own subdirectory
• Consolidate installation of Löverboy and metafiles
• Let user select a subset of files from a multi-file library

Contributing

PRs are welcome—just be sure and adhere to the code of conduct.

Is your favorite library not available? You’ll want to have a look at the Löverboy Metafiles repo.

License

Löverboy is released under the MIT license.