Source

love / readme.md

Full commit

LÖVE is an awesome framework you can use to make 2D games in Lua. It's free, open-source, and works on Windows, Mac OS X and Linux.

Documentation

We use our wiki for documentation. If you need further help, feel free to ask on our forums, and last but not least there's the irc channel #love on OFTC.

Compilation

Windows

Follow the instructions at the megasource repository page.

*nix

Run platform/unix/automagic from the repository root, then run ./configure and make.

$ platform/unix/automagic
$ ./configure
$ make

Mac OS X

Download the required frameworks from here and place them in /Library/Frameworks/.

Then use the Xcode project found at platform/macosx/love.xcodeproj.

Repository information

We use the 'default' branch for development, and therefore it should not be considered stable. Also used is the 'minor' branch, which is used for features in the next minor version and it is not our development target (which would be the next revision). (Version numbers formatted major.minor.revision.)

We tag all our releases (since we started using mercurial), and have binary downloads available for them.

Builds

Releases are found in the 'downloads' section on bitbucket, are linked on the site, and there's a ppa for ubuntu, ppa:bartbes/love-stable.

There are also unstable/nightly builds:

Dependencies

  • SDL2
  • OpenGL
  • OpenAL
  • Lua / LuaJIT / LLVM-lua
  • DevIL with MNG and TIFF
  • FreeType
  • PhysicsFS
  • ModPlug
  • mpg123
  • Vorbisfile