src | ||
.gitignore | ||
CMakeLists.txt | ||
COMPILING.md | ||
LICENSE | ||
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.
- Create projects for Windows, macOS, Linux, or 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.