1 line
4.5 KiB
JavaScript
1 line
4.5 KiB
JavaScript
"use strict";(self.webpackChunkstardust_website=self.webpackChunkstardust_website||[]).push([[697],{5238:function(e,t,i){i.r(t),i.d(t,{contentTitle:function(){return d},default:function(){return c},frontMatter:function(){return s},metadata:function(){return o},toc:function(){return u}});var a=i(7462),n=i(3366),l=(i(7294),i(3905)),r=["components"],s={sidebar_position:3},d="Installation",o={unversionedId:"getting-started/install",id:"getting-started/install",isDocsHomePage:!1,title:"Installation",description:"As Stardust is a display server, it is split into multiple parts. Don't be afraid to ask questions in the Matrix or Discord servers!",source:"@site/docs/getting-started/install.md",sourceDirName:"getting-started",slug:"/getting-started/install",permalink:"/docs/getting-started/install",editUrl:"https://github.com/StardustXR/website/edit/main/docs/getting-started/install.md",version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Technical Overview",permalink:"/docs/getting-started/tech-overview"},next:{title:"Starting",permalink:"/docs/getting-started/starting"}},u=[{value:"stardust-xr (reference server)",id:"stardust-xr-reference-server",children:[{value:"Build system",id:"build-system",children:[]},{value:"Build dependencies",id:"build-dependencies",children:[]},{value:"Download",id:"download",children:[]},{value:"Build",id:"build",children:[]},{value:"Install",id:"install",children:[]}]},{value:"Flatland (Simple simula-like panel UI client for 2D app interaction)",id:"flatland-simple-simula-like-panel-ui-client-for-2d-app-interaction",children:[{value:"Build system",id:"build-system-1",children:[]},{value:"Build dependencies",id:"build-dependencies-1",children:[]},{value:"Install",id:"install-1",children:[]}]}],p={toc:u};function c(e){var t=e.components,i=(0,n.Z)(e,r);return(0,l.kt)("wrapper",(0,a.Z)({},p,i,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("h1",{id:"installation"},"Installation"),(0,l.kt)("p",null,"As Stardust is a display server, it is split into multiple parts. Don't be afraid to ask questions in the ",(0,l.kt)("a",{parentName:"p",href:"https://matrix.to/#/#stardustxr:matrix.org"},"Matrix")," or ",(0,l.kt)("a",{parentName:"p",href:"https://discord.gg/A9w7fKE"},"Discord")," servers!"),(0,l.kt)("h2",{id:"stardust-xr-reference-server"},(0,l.kt)("a",{parentName:"h2",href:"https://github.com/StardustXR/stardust-xr-server"},"stardust-xr")," (reference server)"),(0,l.kt)("h3",{id:"build-system"},"Build system"),(0,l.kt)("ol",null,(0,l.kt)("li",{parentName:"ol"},"Cargo")),(0,l.kt)("h3",{id:"build-dependencies"},"Build dependencies"),(0,l.kt)("ol",null,(0,l.kt)("li",{parentName:"ol"},"Flatbuffers >= 2.0.8"),(0,l.kt)("li",{parentName:"ol"},"EGL+GLES 3.2"),(0,l.kt)("li",{parentName:"ol"},"GLX+Xlib"),(0,l.kt)("li",{parentName:"ol"},"fontconfig"),(0,l.kt)("li",{parentName:"ol"},"dlopen"),(0,l.kt)("li",{parentName:"ol"},"libseat (such as ",(0,l.kt)("a",{parentName:"li",href:"https://sr.ht/~kennylevinsen/seatd/"},"seatd"),")"),(0,l.kt)("li",{parentName:"ol"},"wayland"),(0,l.kt)("li",{parentName:"ol"},"OpenXR Loader (required even if run in flatscreen mode, generally just named ",(0,l.kt)("inlineCode",{parentName:"li"},"openxr"),")")),(0,l.kt)("h3",{id:"download"},"Download"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/StardustXR/stardust-xr-server.git\ncd stardust-xr-server\n")),(0,l.kt)("h3",{id:"build"},"Build"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"cargo build\n")),(0,l.kt)("h3",{id:"install"},"Install"),(0,l.kt)("p",null,"(this step isn't required. Using ",(0,l.kt)("inlineCode",{parentName:"p"},"cargo run")," while developing is just fine)"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"cargo install --path .\n")),(0,l.kt)("h2",{id:"flatland-simple-simula-like-panel-ui-client-for-2d-app-interaction"},(0,l.kt)("a",{parentName:"h2",href:"https://github.com/StardustXR/flatland"},"Flatland")," (Simple simula-like panel UI client for 2D app interaction)"),(0,l.kt)("h3",{id:"build-system-1"},"Build system"),(0,l.kt)("ol",null,(0,l.kt)("li",{parentName:"ol"},"Cargo")),(0,l.kt)("h3",{id:"build-dependencies-1"},"Build dependencies"),(0,l.kt)("ol",null,(0,l.kt)("li",{parentName:"ol"},"Flatbuffers >= 2.0.8")),(0,l.kt)("h3",{id:"install-1"},"Install"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"cargo install flatland\n")))}c.isMDXComponent=!0}}]); |