xurfer/README.md

39 lines
1.5 KiB
Markdown

## Usage
Download/run the binaries for your platform in the releases section.<br>
Developers can run it via [LÖVR](https://lovr.org) or [LÖVE2D](https://love2d.org)
```
-- ./lovr xurfer https://snips.sh/f/_U5-XctEVE?r=1' -- cube, monkey, scene
$ love xurfer <url> # if you have LÖVE2D installed (>v12)
$ lovr xurfer <url> # if you have LÖVR installed
```
**Example**: lovr xurfer <a href="https://snips.sh/f/_U5-XctEVE?r=1">https://snips.sh/f/_U5-XctEVE?r=1</a>
## Multiplatform Multimodal XR Browser
The aim of this project is providing **one [XR Hypermedia browser](https://xrhf.isvery.ninja) codebase** which gracefully degrades to handheld/embedded/braille devices:
* mac/win/linux/android via [LÖVE2D](https://love2d.org)
* mac/win/linux/android via [LÖVR](https://lovr.org)
* Web (2D) via [love.js](https://github.com/Davidobot/love.js)
* Nintendo 3DS, Switch, and Wii via [lovebrew](https://lovebrew.org/)
* Handhelds: Steamdeck, Anbernic, Gameforce, Game Kiddy, Powkiddy (..and more) via [portmaster](https://portmaster.games/supported-devices.html)
* Game emulators via [lutro](https://lutro.libretro.com/)
* Embedded devices via [nelua](https://nelua.io) or straightup [lua](https://lua.org)
## very hackable extensions
* XURFER does everything via browser extensions.<br>
* XURFER is the total sum of browser extensions.<br>
So you can strip/bloat however you want, or build one yourself:
```
$ cp xurfer/ext/skeleton xurfer/ext/myextension
$ sed 's|skeleton|myextension|g' xurfer/ext/myextension/*
$ ./lovr xurfer
[i] loading 'myextension'
...
```