Documentation updates;

This commit is contained in:
bjorn 2018-01-01 21:28:53 -08:00
parent 6bd1feea0f
commit d48bd4fa36
2 changed files with 10 additions and 11 deletions

View File

@ -114,9 +114,6 @@ the command:
LD_PRELOAD='/usr/$LIB/libstdc++.so.6 /usr/$LIB/libgcc_s.so.1' ~/.steam/steam/ubuntu12_32/steam-runtime/run.sh lovr
```
Currently, there are performance issues between SteamVR and OpenGL apps. These are being rapidly
resolved with newer versions of graphics drivers and SteamVR.
WebVR
---
@ -128,7 +125,7 @@ Unix:
```sh
mkdir build
cd build
emcmake cmake -DCMAKE_BUILD_TYPE=Release ..
emcmake cmake ..
emmake make -j2
```
@ -141,14 +138,14 @@ emcmake cmake -G "NMake Makefiles" ..
emmake nmake
```
The above commands will output `lovr.html`, `lovr.js`, and `lovr.js.mem`. To package a game, run:
The above commands will output `lovr.js` and `lovr.wasm`. To package a game, run:
```
python /path/to/emscripten/tools/file_packager.py game.data --preload /path/to/game@/ --js-output=game.js
```
Which will output `game.js` and `game.data`. The `lovr.html` file will need to be modified to
include `game.js` in a script tag.
Which will output `game.js` and `game.data`. You can then include `lovr.js` and `game.js` on an
HTML page with a canvas element. Check out [`lovr-webvr-server`](https://github.com/bjornbytes/lovr-webvr-server/blob/master/views/index.ejs) for an example.
Troubleshooting
---

View File

@ -10,8 +10,10 @@ LÖVR is a simple framework for creating virtual reality experiences with Lua, b
Features
---
- Easily create VR using simple Lua scripts
- 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.
- 3D graphics API supporting primitives, fonts, shaders, skyboxes, framebuffers, etc.
- Import 3D models from obj, fbx, collada, or glTF files, including materials and animations.
- Create projects for Windows, macOS, Linux, or WebVR
- Spatialized audio
- 3D physics
@ -28,7 +30,7 @@ Screenshots
Getting Started
---
You can download precompiled binaries from the [website](http://lovr.org). There, you
You can download precompiled binaries from the [website](https://lovr.org). There, you
can also find documentation and a set of tutorials and examples. Here is the hello world example
for LÖVR:
@ -46,7 +48,7 @@ command line). Put on your headset and you should see the text at the front of
```lua
function lovr.draw()
lovr.graphics.cube('line', 0, 1, 0, .5, lovr.timer.getTime())
lovr.graphics.cube('line', 0, 1.7, -1, .5, lovr.timer.getTime())
end
```
@ -74,7 +76,7 @@ end
Documentation
---
Documentation and examples are available on the website [here](http://lovr.org/docs). The website is also [open source](https://github.com/bjornbytes/lovr-docs) if you want to add or edit documentation.
Documentation and examples are available on the website [here](https://lovr.org/docs). The website is also [open source](https://github.com/bjornbytes/lovr-docs) if you want to add or edit documentation.
Community
---