readme.md
1LÖ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, Linux, Android, and iOS.
2
3[](https://ci.appveyor.com/project/AlexSzpakowski/love)
4
5Documentation
6-------------
7
8We use our [wiki][wiki] for documentation.
9If you need further help, feel free to ask on our [forums][forums], our [Discord server][discord], or our IRC channel [#love on OFTC][irc].
10
11Compilation
12-----------
13
14### Windows
15Follow the instructions at the [megasource][megasource] repository page.
16
17### *nix
18Run `platform/unix/automagic` from the repository root, then run ./configure and make.
19
20 $ platform/unix/automagic
21 $ ./configure
22 $ make
23
24When using a source release, automagic has already been run, and the first step can be skipped.
25
26### macOS
27Download the required frameworks from [here][dependencies] and place them in `/Library/Frameworks/`.
28
29Then use the Xcode project found at `platform/xcode/love.xcodeproj` to build the `love-macosx` target.
30
31### iOS
32Download the `ios-libraries` zip file corresponding to the LÖVE version being used from [here][dependencies-ios],
33unzip it, and place the `include` and `libraries` subfolders into LÖVE's `platform/xcode/ios` folder.
34
35Then use the Xcode project found at `platform/xcode/love.xcodeproj` to build the `love-ios` target.
36
37See `readme-iOS.rtf` for more information.
38
39### Android
40Visit the [Android build repository][android-repository] for build instructions.
41
42Repository information
43----------------------
44
45We use the 'default' branch for development, and therefore it should not be considered stable.
46Also used is the 'minor' branch, which is used for features in the next minor version and it is
47not our development target (which would be the next revision - version numbers are formatted major.minor.revision.)
48
49We tag all our releases (since we started using mercurial), and have binary downloads available for them.
50
51Experimental changes are developed in the separate [love-experiments][love-experiments] repository.
52
53Contributing
54------------
55
56The best places to contribute are through the Bitbucket issue tracker and the official Discord server or IRC channel.
57For code contributions, pull requests and patches are welcome. Be sure to read the [source code style guide][codestyle].
58
59Builds
60------
61
62Releases are found in the 'downloads' section on bitbucket, are linked on [the site][site],
63and there's a ppa for ubuntu, [ppa:bartbes/love-stable][stableppa].
64
65There are also unstable/nightly builds:
66
67- Most can be found [here][builds].
68- For ubuntu linux they are in [ppa:bartbes/love-unstable][unstableppa]
69- For arch linux there's [love-hg][aur] in the AUR.
70
71Dependencies
72------------
73
74- SDL2
75- OpenGL 2.1+ / OpenGL ES 2+
76- OpenAL
77- Lua / LuaJIT / LLVM-lua
78- FreeType
79- ModPlug
80- mpg123
81- Vorbisfile
82- Theora
83
84[site]: http://love2d.org
85[wiki]: http://love2d.org/wiki
86[forums]: http://love2d.org/forums
87[discord]: https://discord.gg/rhUets9
88[irc]: irc://irc.oftc.net/love
89[dependencies]: http://love2d.org/sdk
90[dependencies-ios]: https://bitbucket.org/rude/love/downloads/
91[megasource]: https://bitbucket.org/rude/megasource
92[builds]: http://love2d.org/builds
93[stableppa]: https://launchpad.net/~bartbes/+archive/love-stable
94[unstableppa]: https://launchpad.net/~bartbes/+archive/love-unstable
95[aur]: http://aur.archlinux.org/packages/love-hg
96[love-experiments]: https://bitbucket.org/bartbes/love-experiments
97[codestyle]: https://love2d.org/wiki/Code_Style
98[android-repository]: https://bitbucket.org/MartinFelis/love-android-sdl2
99