Skip to content

Commit 8578c6c

Browse files
docs: update linux install options, add bottles installation image steps
1 parent 7e25a4f commit 8578c6c

File tree

5 files changed

+100
-73
lines changed

5 files changed

+100
-73
lines changed
43.4 KB
Loading
33.2 KB
Loading
22.1 KB
Loading
56.8 KB
Loading

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

Lines changed: 100 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ Select an installation method below:
2929
::card{title="Install Script" to=#install-script icon=i-mdi-bash}
3030
Install Streamer.bot and its Wine dependencies using a `bash` script
3131
::
32-
::card{title="Lutris" to=#lutris icon=i-simple-icons-lutris}
33-
Install Streamer.bot with Lutris
34-
::
3532
::card{title="Bottles" to=#bottles icon=i-mdi-bottle-wine}
3633
Install Streamer.bot with Bottles
3734
::
35+
::card{title="Lutris" to=#lutris icon=i-simple-icons-lutris}
36+
Install Streamer.bot with Lutris
37+
::
3838
::
3939

4040
### Install Script
@@ -43,82 +43,121 @@ Select an installation method below:
4343
View [Streamerbot/sb-linux-installer](https://github.com/Streamerbot/sb-linux-installer) on GitHub
4444
::
4545

46-
#### Prerequisites
4746

48-
::tabs
49-
::div
50-
---
51-
label: Ubuntu
52-
icon: i-simple-icons-ubuntu
53-
---
54-
1. Install `wine`
47+
::steps{level=4}
48+
#### Prerequisites
49+
Install the required dependencies for your Linux distribution
5550

56-
::read-more{to="https://wiki.winehq.org/Ubuntu"}
57-
Follow the instructions [here](https://wiki.winehq.org/Ubuntu) to install Wine on your version of Ubuntu
51+
::tabs
52+
53+
::tabs-item{label=Ubuntu icon=i-simple-icons-ubuntu}
54+
1. Install `wine`
55+
::read-more{to="https://wiki.winehq.org/Ubuntu"}
56+
Follow the instructions [here](https://wiki.winehq.org/Ubuntu) to install Wine on your version of Ubuntu
57+
::
58+
59+
2. Install `winetricks`
60+
```bash [Terminal]
61+
sudo apt install winetricks
62+
sudo winetricks --self-update
63+
```
64+
65+
3. Install remaining dependencies
66+
```bash [Terminal]
67+
sudo apt install git curl
68+
```
5869
::
5970

60-
2. Install `winetricks`
61-
```bash
62-
sudo apt install winetricks
63-
sudo winetricks --self-update
64-
```
71+
::tabs-item{label=Arch icon=i-simple-icons-archlinux}
72+
73+
```bash [Terminal]
74+
# Install wine
75+
sudo pacman -S wine
76+
77+
# Install winetricks
78+
sudo pacman -S winetricks
79+
80+
# Install remaining dependencies
81+
sudo pacman -S git curl
82+
```
83+
::
6584

66-
3. Install remaining dependencies
67-
```bash
68-
sudo apt install git curl
69-
```
7085
::
7186

72-
::div
73-
---
74-
label: Arch
75-
icon: i-simple-icons-archlinux
76-
---
77-
1. Install `Wine`
78-
```bash
79-
sudo pacman -S wine
80-
```
81-
82-
2. Install `winetricks`
83-
```bash
84-
sudo pacman -S winetricks
85-
```
86-
87-
3. Install remaining dependencies
88-
```bash
89-
sudo pacman -S git
90-
```
87+
#### Install Streamer.bot
88+
89+
```bash [Terminal]
90+
# Clone the repository
91+
git clone https://github.com/Streamerbot/sb-linux-installer
92+
93+
# Change directory
94+
cd ./sb-linux-installer
95+
96+
# Execute the installer
97+
./install.sh
98+
```
99+
100+
#### Launch Streamer.bot
101+
102+
::success
103+
You can now launch **Streamer.bot** using the created desktop shortcut!
91104
::
92105
::
93106

94-
#### Install
107+
### Bottles
108+
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}
95135

96-
```bash [sb-linux-installer]
97-
# Clone the repository
98-
git clone https://github.com/Streamerbot/sb-linux-installer
136+
3. Select `"StreamerBot"`{lang=cs} from the list of available programs
99137

100-
# Change directory
101-
cd ./sb-linux-installer
138+
![Streamer.bot in the built-in Bottles installers listing](../assets/linux-bottles-installers.png){width=500}
102139

103-
# Execute the installer
104-
./install.sh
105-
```
140+
It may take some time for the installation to complete.
106141

107-
#### Update
108-
Streamer.bot [Automatic Updates](/get-started/installation#automatic-updates) should work as usual.
142+
#### Launch Streamer.bot
109143

110-
You can manually update your Streamer.bot installation using the installation script with `UPDATE=1`{lang=bash}
144+
Click the :icon{name=i-mdi-play} `Run` button to launch Streamer.bot from your Bottle
111145

112-
```bash [sb-linux-installer]
113-
UPDATE=1 ./install.sh
114-
```
146+
![Launch Streamer.bot](../assets/linux-bottles-launch.png){width=500}
115147

116-
#### Uninstall
117-
You can remove the Streamer.bot installation by executing the script with `UNINSTALL=1`{lang=bash}
148+
::success
149+
You now have **Streamer.bot** installed on Linux via Bottles!
150+
::
151+
152+
::
118153

119-
```bash [sb-linux-installer]
120-
UNINSTALL=1 ./install.sh
121-
```
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*
160+
::
122161

123162
### Lutris
124163
::callout{icon=i-mdi-github to="https://raw.githubusercontent.com/Streamerbot/sb-linux-installer/main/lutris/streamerbot.yaml"}
@@ -133,18 +172,6 @@ Download `lutris/streamerbot.yaml` from GitHub
133172
3. Follow the installer steps to install Streamer.bot to your location of choice.
134173
4. Launch Streamer.bot from Lutris!
135174

136-
### Bottles
137-
::callout{icon=i-mdi-github to="https://github.com/bottlesdevs/programs/blob/main/Software/streamerbot.yml"}
138-
View `streamerbot.yml` on GitHub.
139-
::
140-
141-
1. Click the `+` in the top left corner.
142-
2. Select `Custom` configuration and `soda` as the runner, fill the name of your new bottle, leave everything else as it is.
143-
3. Click on the new bottle and on `Install Programs`.
144-
4. Select `StreamerBot` on the list of programs and start the installation.
145-
5. (Optional: might cause graphical glitches) Change the Runner to `Proton-GE` or `Proton-CachyOS` to fix the C# editor and `WebView2` performance.
146-
6. Launch Streamer.bot from the list of installed programs!
147-
148175
## Known Issues
149176

150177
### Groups

0 commit comments

Comments
 (0)