lpnf
/
lovr
mirror of https://github.com/bjornbytes/lovr.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
lovr/CONTRIBUTING.md

2.5 KiB
Raw Blame History

Contributing

You want to contribute to LÖVR? That's awesome!

Submitting Issues

Feel free to file an issue if you notice a bug. Make sure you search before filing an issue, as it may have already been asked.

Issues are okay for feature requests and questions about the development of LÖVR as well, but usually you'll get a better response by asking in Slack. Questions about how to use LÖVR belong in Slack.

Contributing Documentation

If you see any typos or inconsistencies in the docs, submitting an issue or pull request in the lovr-docs repo would be greatly appreciated! The api folder has Lua files for each function, the guides folder contains tutorials in markdown format, and the examples folder has source code for sample projects and other demos.

Contributing Code

To contribute patches, fork LÖVR, commit to a branch, and submit a pull request. Note that contributions to the repository will be released under the terms in LICENSE. For larger changes, it can be a good idea to engage in initial discussion via issues or Slack before submitting. Try to stick to the existing coding style:

  • 2 space indentation.
  • 100 character wrapping (ish, sometimes it's more readable to just have a long line).
  • Use descriptive, camelCased names when possible.

If you modify the embedded boot.lua script, you can compile it into a C header by doing this:

pushd src/resources; xxd -i boot.lua > boot.lua.h; popd

Organization

An overview of the folder structure:

  • deps contains submodules for external dependencies. Some smaller dependencies are also included in the src/lib folder.
  • src/api contains Lua bindings. There's a file for each module and a file for each object.
  • src/core contains shared engine code. It's usually lower-level and not specific to LÖVR.
  • src/lib contains smaller third party libraries.
  • src/modules has a folder for each module in the project. It's good to keep them separated as much as possible, there's inevitably some overlap.
  • src/resources contains embedded files. These are compiled to binary headers using xxd.

Note that currently the internal C API may change at any time. The Lua API will change less frequently but breaking changes will still occur before version 1.0.

Branches other than master will be force-pushed during development to organize commit history.