Skip to content
This repository was archived by the owner on Jan 9, 2023. It is now read-only.

Commit d8138d7

Browse files
authored
make nicer layout in github
1 parent 520f3ff commit d8138d7

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
# Streamlabs-Rcon-Integration
22

33

4-
A Python exe for integrating Streamlabs and any game supporting Rcon. Its currently being used with Factorio, but should be compatible with any other Rcon interfaced game.
4+
A Python exe for integrating Streamlabs and any game supporting Rcon. Its currently being used with Factorio, but should be compatible with any other Rcon interfaced game.
5+
56
At present only really tested with Twitch, but should work with mixer and youtube based on API spec.
67

78

89
Installation & Usage
910
==========
10-
Get the [latest version zip](https://github.com/muppet9010/Streamlabs-Rcon-Integration).
11-
Create a free account at [Currency Layer website](https://currencylayer.com) and make a note of the API access key as needs to be entered in to the programs config later on.
12-
Unzip the files in to the desired folder.
13-
Open config.json in a text editor and add in your details.
14-
Run the program: Streamlabs Rcon Integration.exe
15-
Select the desired profile from the dropdown and click Start.
16-
The integration is now running between the Streamlabs account and the game using the selected profile.
11+
1. Get the [latest version zip](https://github.com/muppet9010/Streamlabs-Rcon-Integration).
12+
2. Create a free account at [Currency Layer website](https://currencylayer.com) and make a note of the API access key as needs to be entered in to the programs config later on.
13+
3. Unzip the files in to the desired folder.
14+
4. Open config.json in a text editor and add in your details.
15+
5. Run the program: Streamlabs Rcon Integration.exe
16+
6. Select the desired profile from the dropdown and click Start.
17+
7. The integration is now running between the Streamlabs account and the game using the selected profile.
1718

1819
Should a critical error occur the program may fail to load or close. Details can be found in the most recent log file within the Logs folder.
1920

2021

21-
Usage Concepts
22+
Program Execution Concepts
2223
========
2324

2425
The app takes in Streamlabs events and processes them through configurable reactions to trigger a desired action via Rcon in game. These reactions are grouped togeather as savable profiles.

0 commit comments

Comments
 (0)