Lua Virtual Reality Engine
Go to file
bjornbytes 5c381ead34 Force set vsync in lovrGraphicsCreateWindow;
Headset drivers are allowed to override the vsync setting if vsync
messes up their frame timing.  The vsync property is effectively a
global piece of state in core/os and doesn't change across restarts
because the window is persistent.  This can mean that if you switch
from a headset driver that wants vsync off (anything except desktop)
to a headset driver that doesn't care what the vsync is (desktop),
you could end up with a vsync setting that doesn't match t.window.vsync.
I think this is a symptom of poor design somewhere and the best solution
to this probem is "to just not have it".  Similar issues exist for, e.g.
the window size (but that one is less weird because at least you were
the one who changed it).  For now we are just going to ensure that
lovr.graphics.createWindow always modifies the vsync property.
Untested, may need to adjust this fix later.
2020-11-02 11:57:02 -07:00
config Reorganize Tuprules; 2020-08-30 21:12:39 -06:00
deps Upgrade OpenVR; 2020-09-29 16:34:44 -06:00
src Force set vsync in lovrGraphicsCreateWindow; 2020-11-02 11:57:02 -07:00
.editorconfig Update .editorconfig; 2019-12-31 18:39:29 -08:00
.gitignore tup win32 track pdb files; 2020-10-02 19:50:00 -06:00
.gitmodules Fix OpenXR OpenGL swapchain type; 2020-08-23 16:10:57 -06:00
CMakeLists.txt Always rebuild APK; 2020-11-02 11:47:44 -07:00
LICENSE YEAR; 2020-01-02 18:42:55 -08:00
README.md Update webxr driver; rm webvr; 2020-08-16 00:31:20 -06:00
Tupfile Reorganize Tuprules; 2020-08-30 21:12:39 -06:00
Tuprules.tup tup win32 track pdb files; 2020-10-02 19:50:00 -06:00

README.md

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.

Build status Version Slack

Homepage | Documentation | FAQ

Features

  • Cross-Platform - Runs on Windows, Mac, Linux, Android, and on the web using WebAssembly and WebXR.
  • Cross-Device - Supports Vive/Index, Oculus Rift/Go/Quest, Pico, Windows MR, and has a 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()
  for _, hand in ipairs(lovr.headset.getHands()) do
    lovr.graphics.sphere(vec3(lovr.headset.getPosition(hand)), .1)
  end
end

3D Models

function lovr.load()
  model = lovr.graphics.newModel('model.gltf')
end

function lovr.draw()
  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.