# 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.
[](https://ci.appveyor.com/project/bjornbytes/lovr/branch/master)
[](https://github.com/bjornbytes/lovr/releases)
[](https://lovr.org/slack)
[**Homepage**](https://lovr.org) | [**Documentation**](https://lovr.org/docs) | [**FAQ**](https://lovr.org/docs/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, 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 ,
then write a `main.lua` script and drag its parent folder onto the executable. Here are some example projects to try:
#### Hello World
```lua
function lovr.draw()
lovr.graphics.print('Hello World!', 0, 1.7, -3, .5)
end
```
#### Spinning Cube
```lua
function lovr.draw()
lovr.graphics.cube('line', 0, 1.7, -1, .5, lovr.timer.getTime())
end
```
#### Hand Tracking
```lua
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
```lua
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](https://lovr.org/docs/Hello_World).
Building
---
You can build LÖVR from source using CMake. Here are the steps using the command line:
```console
mkdir build
cd build
cmake ..
cmake --build .
```
See the [Compiling Guide](https://lovr.org/docs/Compiling) for more info.
Resources
---
- [**Documentation**](https://lovr.org/docs): Guides, tutorials, examples, and API documentation.
- [**FAQ**](https://lovr.org/docs/FAQ): Frequently Asked Questions.
- [**Slack Group**](https://lovr.org/slack): For general LÖVR discussion and support.
- [**Nightly Builds**](https://lovr.org/download/nightly): Nightly builds for Windows.
- [**Compiling Guide**](https://lovr.org/docs/Compiling): Information on compiling LÖVR from source.
- [**Contributing**](CONTRIBUTING.md): Guide for helping out with development 💜
- [**LÖVE**](https://love2d.org): LÖVR is heavily inspired by LÖVE, a 2D game framework.
Contributors
---
- [@bjornbytes](https://github.com/bjornbytes)
- [@shakesoda](https://github.com/shakesoda)
- [@bcampbell](https://github.com/bcampbell)
- [@mcclure](https://github.com/mcclure)
License
---
MIT, see [`LICENSE`](LICENSE) for details.