https://github.com/bjornbytes/lovr-docs
Documentation for LÖVR
https://github.com/bjornbytes/lovr-docs
lovr
Last synced: 12 months ago
JSON representation
Documentation for LÖVR
- Host: GitHub
- URL: https://github.com/bjornbytes/lovr-docs
- Owner: bjornbytes
- Created: 2018-01-17T02:42:10.000Z (over 8 years ago)
- Default Branch: dev
- Last Pushed: 2024-05-22T22:53:43.000Z (about 2 years ago)
- Last Synced: 2024-05-22T23:46:21.725Z (about 2 years ago)
- Topics: lovr
- Language: Lua
- Size: 27 MB
- Stars: 44
- Watchers: 4
- Forks: 31
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
lovr-docs
===
This repository contains the documentation for [LÖVR](https://github.com/bjornbytes/lovr).
There are four main types of documentation here:
- The **`api`** folder contains a Lua table with metadata for all LÖVR functions and objects.
- This is used to generate documentation, but is also useful for integrating with other tools
(e.g. autocomplete for the LÖVR API in text editors).
- Each function, object, etc. has a Lua file that exports its metadata. These are aggregated
into a single table stored in `init.lua`. The aggregator is a LÖVR script, you can run it by
typing `lovr api` at the root of this repository.
- The **`examples`** folder contains small LÖVR projects demonstrating a specific task/technique.
They aim to be minimal and easy to understand/copy.
- The ones listed in the `init.lua` file are shown on the website.
- The **`showcase`** folder contains full LÖVR projects that implement entire games or demos. The
code is less important for these and it is more about the end result.
- The ones listed in the `init.lua` file are shown on the website.
- Also, each showcase project may contain its own `init.lua` with metadata about the project.
Currently, this can contain an `author` table with `name` and `link` strings.
- The **`guides`** folder contains markdown files that explain LÖVR-related concepts in depth.
- Similarly, `init.lua` contains a manifest used to populate the sidebar on the website.
Note that each release of LÖVR has its own branch. Cherry picks are used to propagate fixes to
relevant branches as needed. Which will totally scale.
All the code in the example/showcase projects is released under CC0. However, the models, textures,
sounds, and other assets used may use different licensing, so be sure to double check those.