Skip to content

Commit 01c0102

Browse files
WhipstickgostopWhipstickgostop
committed
docs: add separate dir for linux install docs, move bottles installation to separate path
1 parent b48a658 commit 01c0102

File tree

5 files changed

+85
-56
lines changed

5 files changed

+85
-56
lines changed

‎streamerbot/1.get-started/1.installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ description: Download and install the latest version of Streamer.bot
3838

3939
::warning
4040
It is not recommended to run Streamer.bot as administrator. This may cause issues down the line especially when you start it as administrator on first start-up and later change this.
41-
It's also not recommended as it has a C# compiler included to run custom codes.
41+
It's also not recommended as it has a C# compiler included to run custom codes.
4242
::
4343

4444
## Update

‎streamerbot/1.get-started/installation/linux/.navigation.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
title: Linux
2+
icon: i-mdi-linux
3+
navigation.title: Linux
4+
ogImage:
5+
headline: Linux

‎streamerbot/1.get-started/installation/linux/bottles.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Bottles Installation
3+
description: Install Streamer.bot on Linux with Bottles
4+
icon: i-mdi-bottle-wine
5+
navigation: false
6+
ogImage:
7+
props:
8+
title: Bottles
9+
headline: Linux Installation
10+
---
11+
12+
In this guide, we'll walk through the steps to install **Streamer.bot** on Linux using [Bottles](https://usebottles.com/){target=_blank rel=noopener}.
13+
14+
Streamer.bot is preconfigured via Bottles' built-in program installers, making the installation process straightforward.
15+
16+
::callout{icon=i-mdi-github to="https://github.com/bottlesdevs/programs/blob/main/Software/streamerbot.yml"}
17+
You can inspect the preconfigured Bottles installer, `streamerbot.yml`, on GitHub.
18+
::
19+
20+
## Prerequisites
21+
22+
::card{title="Bottles" to="https://usebottles.com/" icon=i-mdi-bottle-wine}
23+
Install [Bottles](https://usebottles.com/){target=_blank rel=noopener} on your Linux distribution if you haven't already.
24+
::
25+
26+
## Installation
27+
28+
::steps{level=3}
29+
### Create a new Bottle
30+
31+
1. Click the `+` icon in the top left corner to create a new Bottle.
32+
2. Enter a name for your Bottle, e.g. `"Streamer.bot"`{lang=cs}
33+
3. Select `Custom` configuration
34+
4. Ensure `soda` is selected as the runner
35+
5. Click `Create` (leave everything else as-is)
36+
37+
![Create and configure a new Bottle for Streamer.bot](../../assets/linux-bottles-new.png){width=500}
38+
39+
### Install Streamer.bot
40+
41+
1. Select your newly created Bottle from the list
42+
2. Click on `Install Programs...`
43+
44+
![Install Programs in Bottles](../../assets/linux-bottles-install-programs.png){width=500}
45+
46+
3. Select `"StreamerBot"`{lang=cs} from the list of available programs
47+
48+
![Streamer.bot in the built-in Bottles installers listing](../../assets/linux-bottles-installers.png){width=500}
49+
50+
It may take some time for the installation to complete.
51+
52+
### Launch Streamer.bot
53+
54+
Click the :icon{name=i-mdi-play} `Run` button to launch Streamer.bot from your Bottle
55+
56+
![Launch Streamer.bot](../../assets/linux-bottles-launch.png){width=500}
57+
::
58+
59+
60+
::success
61+
You now have **Streamer.bot** installed on Linux via Bottles!
62+
::
63+
64+
## Tips & Tricks
65+
66+
#### Improve WebView2 Performance
67+
- You can optionally change the runner to `Proton-GE` or `Proton-CachyOS` to improve the performance of the **Streamer.bot Chat** window, **C# Code editor** and any other **WebView2** content.
68+
- *Note that this may cause some graphical glitches in Streamer.bot*

streamerbot/1.get-started/installation/linux.md renamed to streamerbot/1.get-started/installation/linux/index.md

Lines changed: 9 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
---
2-
title: Linux Support
2+
title: Linux Installation
33
description: Install Streamer.bot on Linux
4-
navigation: false
54
icon: i-mdi-linux
5+
navigation: false
6+
ogImage:
7+
props:
8+
title: Linux
9+
headline: Installation
610
---
711

812
::warning
@@ -29,7 +33,7 @@ Select an installation method below:
2933
::card{title="Install Script" to=#install-script icon=i-mdi-bash}
3034
Install Streamer.bot and its Wine dependencies using a `bash` script
3135
::
32-
::card{title="Bottles" to=#bottles icon=i-mdi-bottle-wine}
36+
::card{title="Bottles" to=/get-started/installation/linux/bottles icon=i-mdi-bottle-wine}
3337
Install Streamer.bot with Bottles
3438
::
3539
::card{title="Lutris" to=#lutris icon=i-simple-icons-lutris}
@@ -106,57 +110,8 @@ View [Streamerbot/sb-linux-installer](https://github.com/Streamerbot/sb-linux-in
106110

107111
### Bottles
108112

109-
::callout{icon=i-mdi-github to="https://github.com/bottlesdevs/programs/blob/main/Software/streamerbot.yml"}
110-
View `streamerbot.yml` on GitHub.
111-
::
112-
113-
::steps{level=4}
114-
115-
#### Install Bottles
116-
117-
Install [Bottles](https://usebottles.com/){target=_blank rel=noopener} on your Linux distribution if you haven't already.
118-
119-
#### Create a new Bottle
120-
121-
1. Click the `+` icon in the top left corner to create a new Bottle.
122-
2. Enter a name for your Bottle, e.g. `"Streamer.bot"`{lang=cs}
123-
3. Select `Custom` configuration
124-
4. Ensure `soda` is selected as the runner
125-
5. Click `Create` (leave everything else as-is)
126-
127-
![Create and configure a new Bottle for Streamer.bot](../assets/linux-bottles-new.png){width=500}
128-
129-
#### Install Streamer.bot
130-
131-
1. Select your newly created Bottle from the list
132-
2. Click on `Install Programs...`
133-
134-
![Install Programs in Bottles](../assets/linux-bottles-install-programs.png){width=500}
135-
136-
3. Select `"StreamerBot"`{lang=cs} from the list of available programs
137-
138-
![Streamer.bot in the built-in Bottles installers listing](../assets/linux-bottles-installers.png){width=500}
139-
140-
It may take some time for the installation to complete.
141-
142-
#### Launch Streamer.bot
143-
144-
Click the :icon{name=i-mdi-play} `Run` button to launch Streamer.bot from your Bottle
145-
146-
![Launch Streamer.bot](../assets/linux-bottles-launch.png){width=500}
147-
148-
::success
149-
You now have **Streamer.bot** installed on Linux via Bottles!
150-
::
151-
152-
::
153-
154-
#### Bottles Tips & Tricks
155-
156-
::note
157-
**Improve WebView2 Performance in Bottles**
158-
- You can optionally change the runner to `Proton-GE` or `Proton-CachyOS` to improve the performance of the Streamer.bot Chat window, C# Code editor and any other WebView2 content.
159-
- *Note that this may cause some graphical glitches in Streamer.bot*
113+
::card{title="Bottles Installation" to="/get-started/installation/linux/bottles" icon=i-mdi-bottle-wine}
114+
Install Streamer.bot on Linux with Bottles
160115
::
161116

162117
### Lutris

‎streamerbot/3.api/2.triggers/.navigation.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ description: Reference of all available triggers in Streamer.bot
33
icon: i-mdi-creation
44
navigation.icon: i-mdi-creation
55
ogImage:
6-
headline: Triggers
6+
props:
7+
headline: Triggers

0 commit comments

Comments
 (0)