Skip to content

Latest commit

 

History

History
111 lines (79 loc) · 3.96 KB

readme.md

File metadata and controls

111 lines (79 loc) · 3.96 KB
Raw

Details of Modifications Made

Experiment 1: Implementing the Sample Module

  • Created a new module onto Love2D dubbed sample that is accessed via the love.sample Lua Module.
  • The module has only one function named doSum which sums 2 numbers.
  • The file sample-module-test.lua demonstrates the module in action.

About Love2D

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, Linux, Android, and iOS.

Build Status: Windows

Documentation

We use our wiki for documentation. If you need further help, feel free to ask on our forums, our Discord server, or our 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

When using a source release, automagic has already been run, and the first step can be skipped.

macOS

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

Then use the Xcode project found at platform/xcode/love.xcodeproj to build the love-macosx target.

iOS

Download the ios-libraries zip file corresponding to the LÖVE version being used from here, unzip it, and place the include and libraries subfolders into LÖVE's platform/xcode/ios folder.

Then use the Xcode project found at platform/xcode/love.xcodeproj to build the love-ios target.

See readme-iOS.rtf for more information.

Android

Visit the Android build repository for build instructions.

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 are formatted major.minor.revision.)

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

Experimental changes are developed in the separate love-experiments repository.

Contributing

The best places to contribute are through the Bitbucket issue tracker and the official Discord server or IRC channel. For code contributions, pull requests and patches are welcome. Be sure to read the source code style guide.

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 2.1+ / OpenGL ES 2+
  • OpenAL
  • Lua / LuaJIT / LLVM-lua
  • FreeType
  • ModPlug
  • mpg123
  • Vorbisfile
  • Theora