Lua Virtual Reality Engine
Go to file
bjorn b04979da8d Update CMakeLists; 2017-05-29 10:31:46 -07:00
src Remove single precision check; 2017-05-25 15:55:16 -07:00
.gitignore No game screen; 2017-04-02 05:55:21 -07:00
CMakeLists.txt Update CMakeLists; 2017-05-29 10:31:46 -07:00
COMPILING.md Update COMPILING.md; 2017-05-20 09:47:19 -06:00
LICENSE 2016 was 30 years ago; 2017-05-17 22:27:38 -06:00
README.md Update README; 2017-05-20 09:45:02 -06:00

README.md

LÖVR

LÖVR is a simple framework for creating virtual reality experiences with Lua.

Features

  • Automatically detects and renders to connected VR headsets (works without a headset too!)
  • Simple 3D graphics API supporting primitives, 3D models, fonts, shaders, skyboxes, framebuffers, etc.
  • Export projects to standalone executables, or export to the web using WebVR.
  • Spatialized audio
  • 3D physics

Getting Started

You can download precompiled binaries from the website. There, you can also find documentation and a set of tutorials and examples. Here is the hello world example for LÖVR:

function lovr.draw()
  lovr.graphics.print('Hello World!', 0, 1, -1)
end

To run it, first create a folder for your project and put the code in a file called main.lua. Then, just drop the project folder onto lovr.exe (or run lovr.exe path/to/project on the command line). Put on your headset and you should see the text at the front of your play area!

Spinning Cube

function lovr.draw()
  lovr.graphics.cube('line', 0, 1, 0, .5, lovr.timer.getTime())
end

3D Models

function lovr.load()
  model = lovr.graphics.newModel('teapot.fbx', 'teapot.png')
end

function lovr.draw()
  model:draw()
end

Audio

function lovr.load()
  local sound = lovr.audio.newSource('darudeSandstorm.ogg')
  sound:play()
end

For more examples, see http://lovr.org/examples.

Documentation

See http://lovr.org/docs for guides and API reference. The documentation is open source and can be found here.

Compiling

To compile from source to create a custom build or contribute to LÖVR, see COMPILING.md.

License

MIT, see LICENSE for details.