mirror of
https://github.com/bjornbytes/lovr.git
synced 2024-07-04 13:33:34 +00:00
de6d3dab5b
It's still a rough draft and likely only works on my machine, but can be improved over time. Rough explanation: - tup.config contains high-level build configuration defaults. - Tuprules.tup contains mostly compiler flags (generated from the tup.config) and declares some macros used to compile code. - Tupfile takes all generated object files and links them into the lovr executable. - src/Tupdefault defines the default build steps for src and all subdirectories, which is to compile all .c files to .o files and put them in the <objects> bucket for linking by the toplevel Tupfile. It's possible to have multiple configs active at once for different platforms, projects, etc. To do this, create a folder for each build variant you want, and place a tup.config in each folder (it can be a symlink, which is helpful). Then, invoking `tup` will build all your variants, or you can build a specific one by doing `tup <foldername>`. |
||
|---|---|---|
| deps | ||
| src | ||
| .appveyor.yml | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| tup.config | ||
| Tupfile | ||
| Tuprules.tup | ||
LÖVR
A simple Lua framework for rapidly building VR experiences.
You can use LÖVR to easily create VR experiences without much setup or programming experience. The framework is tiny, fast, open source, and supports lots of different platforms and devices.
Homepage | Documentation | FAQ
Features
- Cross-Platform - Runs on Windows, Mac, Linux, Android, and even on the web using WebAssembly and WebVR.
- Cross-Device - Supports HTC Vive, Oculus Touch/Go/Quest, Windows MR, and includes a keyboard/mouse VR simulator.
- Beginner-friendly - Simple VR scenes can be created in just a few lines of Lua.
- Fast - Writen in C99 and scripted with LuaJIT, includes optimized single-pass stereo rendering.
- Asset Import - Supports 3D models (glTF, OBJ), skeletal animation, HDR textures, cubemaps, fonts, etc.
- Spatialized Audio - Audio is automatically spatialized using HRTFs.
- Vector Library - Efficient first-class support for 3D vectors, quaternions, and matrices.
- 3D Rigid Body Physics - Including 4 collider shapes and 4 joint types.
- Compute Shaders - For high performance GPU tasks, like particles.
- Multiplayer - Includes enet for multi-user VR experiences.
Getting Started
It's really easy to get started making things with LÖVR. Grab a copy of the executable from https://lovr.org/download,
then write a main.lua script and drag its parent folder onto the executable. Here are some example projects to try:
Hello World
function lovr.draw()
lovr.graphics.print('Hello World!', 0, 1.7, -3, .5)
end
Spinning Cube
function lovr.draw()
lovr.graphics.cube('line', 0, 1.7, -1, .5, lovr.timer.getTime())
end
Hand Tracking
function lovr.draw()
controllers = lovr.headset.getControllers()
for _, controller in ipairs(controllers) do
x, y, z = controller:getPosition()
lovr.graphics.sphere(x, y, z, .1)
end
end
3D Models
function lovr.load()
model = lovr.graphics.newModel('teapot.fbx', 'teapot.png')
end
function lovr.draw()
local x, y, z = 0, 0, 0
model:draw(x, y, z)
end
You can try more examples in your browser on the docs page.
Building
You can build LÖVR from source using CMake. Here are the steps using the command line:
mkdir build
cd build
cmake ..
cmake --build .
See the Compiling Guide for more info.
Resources
- Documentation: Guides, tutorials, examples, and API documentation.
- FAQ: Frequently Asked Questions.
- Slack Group: For general LÖVR discussion and support.
- matrix.org: Decentralized alternative to Slack.
- Nightly Builds: Nightly builds for Windows.
- Compiling Guide: Information on compiling LÖVR from source.
- Contributing: Guide for helping out with development 💜
- LÖVE: LÖVR is heavily inspired by LÖVE, a 2D game framework.
Contributors
License
MIT, see LICENSE for details.