Skip to content

Commit 4012155

Browse files
committed
Fix typo in SSSVR interface, update README.
1 parent 0490a7d commit 4012155

3 files changed

Lines changed: 16 additions & 21 deletions

File tree

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The bot is meant to be a nexus for your stream interactions, it can connect to a
1717
* Comes with a lot of support functions like name cleanup, text cleanup, custom nicks, word to audio replacement, a dictionary for word replacement.
1818
5. Connect to a range of accessory tools: to change SteamVR settings, capture SteamVR screenshots, detect running SteamVR games, send overlays into SteamVR, and more.
1919
6. Connect to OBS Studio using the 4.x Websocket plugin, to show/hide sources and filters, trigger screenshot capture.
20-
7. Write text labels to disk, as well as a range of settings for various functions.
20+
7. Write text labels to disk, as well modify a range of settings for various functions in the system.
2121
8. Send key presses to arbitrary applications using PHP to execute an AutoIT v3 component.
2222
9. Can pipe screenshots from both SteamVR and OBS to overlays and/or Discord.
2323
10. Can trigger custom URIs for applications, or load a URL in the background to trigger standard webhooks.
@@ -34,11 +34,10 @@ This section will explain how to get started with the bot, how to install it, ho
3434
<details>
3535

3636
#### Mandatory things
37-
1. You need to have at least one user account on [Twitch][twitch] as that is needed to get through the setup.
38-
2. A webserver with PHP 8.1 or higher, an easy ready-made solution is [XAMPP][xampp].
37+
1. You need to have at least one user account on [Twitch][twitch] as that is needed to get through the setup, two is recommended though to avoid complications.
38+
2. A webserver with PHP 8.2 or higher, an easy ready-made solution is [XAMPP][xampp].
3939
* Inside `php.ini` in `xampp/php` uncomment this line: `extension=sqlite3` by removing the leading `;` to enable the SQLite3 plugin. Then restart Apache.
4040
3. To compile TypeScript you need [Node.JS][nodejs].
41-
* With Node installed, install the TypeScript compiler with `npm install -g tsc` in the terminal.
4241

4342
#### Good to Have things
4443
1. A secondary [Twitch][twitch] account to use as a bot in chat, so it doesn't look like you are writing all automated messages yourself.
@@ -48,31 +47,29 @@ This section will explain how to get started with the bot, how to install it, ho
4847

4948
#### Get the bot
5049
1. Clone this repository to a folder in the document root of your webserver, go to it in the terminal and run `git clone https://github.com/BOLL7708/desbot.git`. If you are using `XAMPP` the root is `xampp/htdocs`.
51-
2. Run `tsc` in the terminal to compile the project, it should return empty if there are no issues.
50+
2. Navigate into the `./scripts` folder and run `1_install.cmd`, this will install dependencies and compile the project.
5251
3. Open the URL to the bot in your browser and go through the setup, see the next section for configuration, the URL should look something like this if you used the defaults: `http://localhost/desbot/`
5352

5453
</details>
5554

5655
### Configuration
5756
<details>
5857

59-
1. The first time you run the main page it will create a new database. Click the link at the bottom to continue to the editor.
60-
2. You are now in the initial setup, which includes signing in with Twitch for both your channel and an second account to act as a bot in chat, which can be your main account or a secondary account specifically made for this.
61-
3. After the setup you have access to the main interface, here it is recommended to go to the `🍰 Defaults` section to import default presets and events, this will help you get a very solid base setup and includes things are not well documented so hard to get any other way.
62-
4. Go to `🎨 Config > Speech > Google Api Key`, and insert your API key if you have one, this to get TTS throughout.
63-
5. Use the `🧰 Tools` section of the editor to perform things like importing existing Twitch rewards, load data for Twitch users, load data for Steam games, connect to a Philips Hue hub, and more.
64-
* If you have existing rewards on Twitch, it is a good idea to use the import tools in here. Keep in mind that if you want the bot to be able to update and toggle your reward, they need to be created by the bot. You can still import existing rewards, delete them, and then have this bot create them from the imported presets.
58+
1. You should be seeing the initial setup, which includes signing in with Twitch for both your channel and a second account to act as a bot in chat.
59+
2. After the setup you have access to the main interface, here it is recommended to go to the `🍰 Defaults` section to import default presets and events, this will help you get a very solid base setup and includes things that are not documented yet.
60+
3. Go to `🎨 Config > Speech > Google Api Key`, and insert your API key if you have one, this to get TTS throughout.
61+
4. Use the `🧰 Tools` section of the editor to perform things like importing existing Twitch rewards, load data for Twitch users, load data for Steam games, connect to a Philips Hue hub, and more.
62+
* If you have existing rewards on Twitch, it is a good idea to use the import tools in here. Keep in mind that if you want the bot to be able to update and toggle your rewards, they need to be created by the bot. You can still import existing rewards, delete them on Twitch, and then have this bot recreate them from the imported presets.
6563
</details>
6664

6765
### Updating
6866
<details>
6967

70-
To update the project you should pull down the latest changes and then recompile the project, follow these steps:
71-
1. Go to the project root in the terminal, this will be in `xampp/htdocs/desbot` if you used the defaults.
72-
2. Use Git to pull the latest changes from the `master` branch, if you haven't checked out a different branch you can run this in the terminal to get the update: `git pull`
73-
3. Still in the same terminal, run `tsc` to recompile the project, it should return empty if there are no issues.
68+
Updating is simple now, just open a terminal in the project and:
69+
1. Navigate to the `./scripts` folder.
70+
2. Run the `2_update.cmd` script.
7471

75-
That should be it. Go to the path of the bot in your browser and check the version number in the top left corner under the logo, it should be the latest version as seen on GitHub or the website.
72+
This should pull down updates using git and rebuild the project. Reloading the editor should show a new version number under the logo in the top left corner.
7673
</details>
7774

7875
---
@@ -101,9 +98,7 @@ Links to various tools and resources.
10198

10299
* [Website][website] - The official website for the bot, contains a lot of information as well as this very ReadMe.
103100
* [Discord][discord] - The official Discord server for the bot, where you can get support and chat with other users.
104-
* [Reddit][reddit] - The official subreddit for the bot.
105-
* [Bluesky][bluesky] - The official Bluesky page for the bot.
106-
* [Twitter][twitter] - The official Twitter account for the bot.
101+
* [Trello][trello] - The official Trello working board.
107102
</details>
108103

109104
---

app/src/Shared/Bot/Callbacks.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ export default class Callbacks {
303303
configClone.customProperties.durationMs = screenshotsConfig.callback.pipePreset_forMs
304304
const tas = configClone.customProperties.textAreas
305305
if(tas && tas.length > 0) {
306-
tas[0].text = `${responseData.width}x${responseData.weight}`
306+
tas[0].text = `${responseData.width}x${responseData.height}`
307307
}
308308
if(requestData != null && tas && tas.length > 1) {
309309
const userData = await TwitchHelixHelper.getUserById(requestData.userId)

app/src/Shared/Classes/SuperScreenShotterVR.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export interface ISSSVRResponse {
7373
nonce: string
7474
image: string
7575
width: number
76-
weight: number
76+
height: number
7777
message: string
7878
error: string
7979
}

0 commit comments

Comments
 (0)