StardustXR/website
1
0
Fork 0
Code Issues 3 Pull Requests 4 Actions Packages Projects Releases Wiki Activity

Update for rust

Browse Source
This commit is contained in:
Nova
2022-09-30 14:05:12 -04:00
parent 52e61bb163
commit 41218d6804
33 changed files with 53 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

127
docs/getting-started/install.md
View File

@@ -4,104 +4,51 @@ sidebar_position: 2
# Installation
As Stardust is a display server, it is split into multiple parts. Make sure to install the parts in order to avoid issues, and don't be afraid to ask questions in the Matrix or Discord servers!
As Stardust is a display server, it is split into multiple parts. Don't be afraid to ask questions in the [Matrix](https://matrix.to/#/#stardustxr:matrix.org) or [Discord](https://discord.gg/A9w7fKE) servers!
1. [libstardustxr client/server/fusion](#libstardustxr-server-client-and-fusion)
2. [stardust-xr](#stardust-xr-reference-server)
3. Other clients (such as the [tests](#stardust-client-tests))
## [stardust-xr](https://github.com/StardustXR/stardust-xr-server) (reference server)
## [libstardustxr](https://github.com/StardustXR/libstardustxr) (server, client, and fusion)
### Packages
AUR: `libstardustxr-git` and `libstardustxr-fusion-git`
<!-- ### Packages -->
<!-- AUR: `stardust-xr-git` -->
### Build system
1. Meson >= 0.55.0
2. Ninja (tested on 1.10.2)
1. Cargo
### Build dependencies
1. Flatbuffers >= 2.0.8
2. EGL+GLES 3.2
3. GLX+Xlib
4. fontconfig
5. dlopen
6. libseat (such as [seatd](https://sr.ht/~kennylevinsen/seatd/))
7. wayland
8. OpenXR Loader (required even if run in flatscreen mode, generally just named `openxr`)
### Download
```bash
git clone https://github.com/StardustXR/stardust-xr-server.git
cd stardust-xr-server
```
### Build
```bash
cargo build
```
### Install
```bash
cargo install
```
## [Flatland](https://github.com/StardustXR/flatland) (Simple simula-like panel UI client for 2D app interaction)
### Build system
1. Cargo
### Build dependencies
1. Flatbuffers >= 1.12.0
### Download
```bash
git clone https://github.com/StardustXR/libstardustxr.git
cd libstardustxr
```
### Build
```bash
meson build --prefix=/usr
cd build
ninja
```
### Install
```bash
ninja install
```
## [stardust-xr](https://github.com/StardustXR/stardust-xr) (reference server)
### Packages
AUR: `stardust-xr-git`
### Build system
1. Meson >= 0.55.0
2. Ninja (tested on 1.10.2)
3. CMake (tested on 3.21.1)
### Build dependencies
1. [libstardustxr](#libstardustxr-server-client-and-fusion)
2. Flatbuffers >= 1.12.0
3. EGL+GLES 3.2
4. GLX+Xlib
5. fontconfig
6. dlopen
7. libseat (such as [seatd](https://sr.ht/~kennylevinsen/seatd/))
8. wayland
9. xwayland
10. OpenXR Loader (required even if run in flatscreen mode, generally just named `openxr`)
11. libxkbcommon-x11
### Download
```bash
git clone https://github.com/StardustXR/stardust-xr.git
cd stardust-xr
```
### Build
```bash
meson build --prefix=/usr
cd build
ninja
```
### Install
```bash
meson install --skip-subprojects
```
## [Stardust Client Tests](https://github.com/StardustXR/stardust-client-tests)
### Build system
1. Meson >= 0.55.0
2. Ninja (tested on 1.10.2)
### Build dependencies
1. [libstardustxr](#libstardustxr-server-client-and-fusion)
2. Flatbuffers >= 1.12.0
3. sdbus-cpp
### Download
```bash
git clone https://github.com/StardustXR/stardust-client-tests.git
cd stardust-client-tests
```
### Build
```bash
meson build --prefix=/usr
cd build
ninja
cargo install flatland
```