Documentation

How to install

The current documentation is valid for the v1.10.0 of osu! Tourney Match Displayer.
You have two methods to install it, using the installer or just unzipping the .zip file.

Installer

First of all you need to download the installer!
Once downloaded, run the installer and continue installing it!
The installer runs with Administrator Privileges.
If Microsoft Defender SmartScreen alert you, don't worry about it and click Run anyway.
(Make sure you have downloaded it from otmd.app to avoid malicius softwares!).

The default installation folder is C:\Program Files\osu-tourney-match-displayer!

At first run it will ask you to allow the .exe for the firewall, check only for private networks and allow access.

Zip Archive

First of all you need to download the zip archive!
Once downloaded, extract the .zip file wherever you want and you're done!

Now you can open the folder and run osu! Tourney Match Displayer.exe!

Change the fields

Match section

  • APIkey : Put your apikey of osu! | Where can I find the apikey?
  • UserID : Put your userid | Your userid will be used only if you want to display a 1vs1 match but it's required to have it always saved for next times.
    You can find your userid at the end of your profile link https://osu.ppy.sh/users/4001304
  • MatchID : Put the ID of the match you want to display. | You can find the matchid at the end of an mp link
    https://osu.ppy.sh/community/matches/69509292
  • Match Type : Select the type of the match between 1vs1 and TeamVS.
  • Stage : Select the current stage of the tournament. | Friendly is meant to be used if you want to display a match that's not a tournament
  • N. of maps : Put the number of maps of the Qualifiers Pool | You'll see and use this field only if you select Qualifiers as Stage
  • 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. | For example let's see this lobby: 5WC: (Indonesia A) vs (Italy A), Indonesia A should be the blue team as blue teams are always the first team for the api.
    If a referee make this, you can fix it checking the box of score reverse.

Displayer Settings section

  • APIkey : Put your apikey of osu! | Where can I find the apikey?
  • UserID : Put your userid | Your userid will be used only if you want to display a 1vs1 match but it's required to have it always saved for next times.
    You can find your userid at the end of your profile link https://osu.ppy.sh/users/4001304
  • Old Colors : Enable the old colors that matches the old osu! stable colors. | (First team = blue / Second team = red)
  • Small Displayer : Enable the small displayer that have less height.
  • Visualizer Style : You can choose from 4 different styles:
    • Default : No rounded corners
    • Rounded : All 4 corners rounded
    • Top-Rounded : Top 2 corners rounded
    • Bottom-Rounded : Bottom 2 corners rounded
  • Width : Shows the current width of the displayer | This value will be used in OBS
  • Height : Shows the current height of the displayer | This value will be used in OBS

App Settings section

  • User Interface : Enable compact UI
  • System Tray : Enable minimize to system tray

Display on OBS/SLOBS

On SLOBS add a new source > browser source, name it and put these settings:

  • Uncheck 'Local File box'
  • URL : http://localhost:3000/visualizer (the app copy automatically the url when you save the settings so you can just paste it inside obs)
  • Width : 400
  • Height : 130 or 80 (if you're using the small displayer)
  • Check 'Refresh browser when scene becomes active' box