Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AkinariHex authored Nov 19, 2020
1 parent 486668f commit 5ea2a51
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,24 @@ The project is currently into its early stage and is not written perfectly. We'l
<tr>
<td align="center"><a href="https://github.com/AkinariHex"><img src="https://avatars.githubusercontent.com/u/28952344?v=3" width="100px;" alt=""/><br /><sub><b>Akinari</b> </sub></a></td>
<td align="center"><a href="https://github.com/xRLPGx"><img src="https://avatars.githubusercontent.com/u/33182302?v=3" width="100px;" alt=""/><br /><sub><b>xRLPGx</b> </sub></a></td>
<td align="center"><a href="https://github.com/nrabulinski"><img src="https://avatars.githubusercontent.com/u/24574288?v=3" width="100px;" alt=""/><br /><sub><b>nrabulinski</b></sub></a></td>
</tr>
</table>

## How to use o!TMD

The current documentation is valid for the `v1.0` of o!TMD. Download the latest version [here](https://github.com/AkinariHex/oTMD/releases/latest)!<br>
The current documentation is valid for the `v1.1` of o!TMD. Download the latest version [here](https://github.com/AkinariHex/oTMD/releases/latest)!<br>
**CURRENTLY WORKS ONLY WITH LOBBIES WITH TEAMVS**

### Installation

Extract the content of the `.zip` file into a folder. Should you have the same files into the folder:

<img src="https://drive.google.com/uc?export=view&id=1TLudygIrCEcOS6xvVq5aXK0W_-PlhP6g">
<img src="https://drive.google.com/uc?export=view&id=1aYWvLCCDcReMPzymVdlCbQAP2BypKbT5">

### Display on OBS

Open ``o!TMD.exe`` from your folder, it should open a console and a page into your browser to change the settings.
Open ``otmd.exe`` from your folder, it should open a console and a page into your browser to change the settings.
At first run it will ask you to allow the ``.exe`` for the firewall, check only for private networks and allow access.

<img src="https://drive.google.com/uc?export=view&id=1npQ2EXYADfIzxlzXMnVn03ZiY8px17U1">
Expand All @@ -44,15 +45,16 @@ Extract the content of the `.zip` file into a folder. Should you have the same f

Change the fields:<br>

- `api key`: put your apikey of osu! | **You can find and request the key at https://osu.ppy.sh/p/api**.
- `match ID`: put the ID of the match you want to display. | **You can find the matchid at the end of an mp link https&#58;://osu.ppy.sh/community/matches/`69509292`**
- `best of`: select the BO of the match.
- `apikey`: put your apikey of osu! | **You can find and request the key at https://osu.ppy.sh/p/api**.
- `matchID`: put the ID of the match you want to display. | **You can find the matchid at the end of an mp link https&#58;://osu.ppy.sh/community/matches/`69509292`**
- `Stage`: select the current stage of the tournament. | **Friendly is meant to be used if you want to display a match that isn't of a tournament**
- `Best of`: select the BO of the match.
- `warmups`: put the number of warmups. In the most of cases it's 2.
- `score reverse`: check it only if the first team of the lobby has the colour red.<br>**For example let's see this lobby: `5WC: (Spain B) vs (South Korea A)`, Spain B should be the blue team as blue teams are always the first team for the api. If a referee make this error you can fix it checking the box of score reverse.**

Click the `save new config file` button, it'll save your settings and automatically start to display your match by opening a new tab with this URL "http://localhost:3000/visualizer".

<img src="https://drive.google.com/uc?export=view&id=1v6XiISX_8WFTw2kbSwTZ2290jaZ26AHf">
<img src="https://drive.google.com/uc?export=view&id=1ovEBGoSM_C_IxngXPjH2DXk7ARWZ8r9v">

Now you can close your browser and open OBS/SLOBS, the displayer will always work until you close the console.<br>**Do not close the console is you want to display it on OBS**<br>
The example I made was made with Streamlabs OBS but it's the same thing for OBS.
Expand Down

0 comments on commit 5ea2a51

Please sign in to comment.