Skip to content

Commit d5cded2

Browse files
authored
Merge pull request #7 from cnlohr/cnlohr_add_notes
Add some notes that I needed when I was getting going.
2 parents 6b34a3a + f4f12a5 commit d5cded2

1 file changed

Lines changed: 42 additions & 8 deletions

File tree

docs/server-setup.mdx

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,27 +70,49 @@ you first start the client.
7070

7171
### Compile and Run on Linux
7272

73-
Assuming Ubuntu 22.04
73+
#### Prerequisits Assuming Debian/Ubuntu
7474

75+
For Ubuntu 22.04,
7576
`sudo add-apt-repository ppa:dotnet/backports`
7677

78+
For Debian or other qurirky setups:
79+
80+
```
81+
wget https://packages.microsoft.com/config/debian/12/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
82+
sudo dpkg -i packages-microsoft-prod.deb
83+
rm packages-microsoft-prod.deb
84+
```
85+
86+
Then continue installation:
87+
7788
`sudo apt-get update && sudo apt-get install -y dotnet-sdk-9.0`
7889

79-
`git clone`
90+
#### Get Basis
8091

81-
Open a new terminal and cd /to/directory/with/Basis Server/
92+
Change to the folder you wish to download Basis to, and execute the following command:
93+
94+
`git clone https://github.com/BasisVR/Basis`
95+
96+
#### Build Basis Server
97+
98+
Open a new terminal and cd /to/directory/with/Basis Server/, i.e. `cd Basis/Basis\ Server`
8299

83100
`dotnet restore`
84101

85-
`dotnet build`
102+
Then build, with either:
86103

104+
`dotnet build` (for debug)
87105

88-
Navigate to the BasisServerConsole directory (Something like `/BasisServerConsole/bin/Debug/net9.0/BasisNetworkConsole`)
89-
and run:
106+
or
90107

91-
`dotnet .\BasisNetworkConsole.dll`
108+
`dotnet build --configuration Release` (For release)
109+
110+
#### Executing
92111

112+
Navigate to the BasisServerConsole directory (Something like `/BasisServerConsole/bin/Debug/net9.0/BasisNetworkConsole`)
113+
and run:
93114

115+
`dotnet .\BasisNetworkConsole.dll`
94116

95117
:::tip For More Targeted Linux Release
96118

@@ -100,12 +122,20 @@ You may compile with the following:
100122

101123
The `--self-contained` switch is added to allow running on a OS without dotnet installed.
102124

103-
If you compile via this method you should be able to run
125+
If you compile via this method (Or your build targeted the system) are on a you should be able to run
104126

105127
`./BasisNetworkConsole`
106128

129+
from `BasisServerConsole/bin/Debug/net9.0/BasisNetworkConsole`.
130+
107131
:::
108132

133+
## Firewall
134+
135+
You may want to open ports:
136+
* 1234/tcp
137+
* 10666/tcp
138+
* 4296/udp
109139

110140
<br />
111141
<br />
@@ -270,6 +300,10 @@ Note that the remote urls you use must be served from a proper server that suppo
270300
Any modern server should do this but simple local dev servers may not.
271301
:::
272302

303+
:::tip To upload something
304+
One avenue you can use to test out a new scene is to create a scene in Unity, export the scene as a BEE file. Upload that BEE file to a server that supports HTTP, then, place the URL in `CombinedURL`, and get the password from `dontuploadmepassword.txt` and place it in `UnlockPassword`.
305+
:::
306+
273307
| Variable | Definition |
274308
|------------------|------------|
275309
| `Mode` | Mode of the configuration: `0` = Game object, `1` = Scene. |

0 commit comments

Comments
 (0)