Osu! Twitch Commands v1.1.0

Description

This extension integrates commands that you can use during your osu live streaming. Some commands are useful for the viewer to get extra real-time information about your osu instance, while others are useful for not having to leave Twitch to get information from the osu site.

Import File

Installation

In Streamer.bot click the Import button in the top menu. Drag the .sb file into the Import String field.

Click Import to finalize the import.
Remember to enable the commands in the Commands section: right click on the group Osu! Info > Group > Enable All

First Step: get your personal key from osu site

The !best, !recent, !stats, !top commands require the use of an osu key.

  1. Go here to the API section of the osu website
  2. Go to the bottom of the Legacy API section
  3. Click on new Legacy API key
  4. In the application name field enter Streamer.bot
  5. In the application url field enter http://localhost
  6. Click on Create Key

  1. Click on Show Key and copy the key

Second Step: enter the osu key within streamer.bot

  1. Go to the “!best”, “!recent”, “!stats”, “!top” actions and enter in the value field of the argument %osukey% your osu key

  1. Click OK to confirm the entry

Third Step: configuration of the !skin command

  1. Press WIN + R, type %localappdata% and press OK.
  2. Open the osu! folder and create a folder called Links.
  3. Creates text files named exactly like the folders found in the Skins folder

  1. Enter for each text file the link to the corresponding skin. You can upload skins to cloud storage and get the link or use sites like osuck and search for your skin. If you use osuck just search for your skin, click on the download link button and then click on the copy short link button

Fourth Step: install Tosu

The !acc, !np, !pp, !skin commands require the use Tosu.

  1. Download Tosu from here

Commands Description and Usage

For the !acc, !np, !pp, !skin commands to work, you must run Tsou.
In case Tosu is not open when the command is started, no message will be sent. In case the commands should not be used correctly or with invalid data they will not send any chat message.

Command Description Usage Example
!acc current map info based on acc. !acc “n∈[1,100]” !acc 98
!best best statistics !best “playerName” !best dt_gamesplays
!np current map !np !np
!pp ~acc to get the desired pp !pp “n∈{pp with 90 ≤ acc ≤ 100}” !pp 600
!recent the last map played. !recent “playerName” !recent dt_gamesplays
!skin current skin link. !skin !skin
!stats general statistics. !stats “playerName” !stats dt_gamesplays
!top n-th best play. !top “playerName” “n∈[1,100]” !top dt_gamesplays 1

Just FYI, we do recommend before submitting as an actual submission to first put it in the testing forums, so you can share your extension and have it tested, as the testing forum can be viewed by anyone.

Now apart from that, I see that you are commenting your code in italian, which is totally fine as in best case users shouldn’t need to go into your code to change things. However it seems that if users want to change the message structure or something else they will need to go into the code. Best to comment in english in that case or make it so that users will not need to go into the code themselves to change things.

Which brings me to my next point. In the action !stats, you define a timezone in the code itself, however not all users are from that timezone so it would be the wrong time for them. This is also not mentioned anywhere in the documentation. Could probably an argument and use that so users can define the timezone they want. The other way would be to simply use the system timezone instead.

In Your !top action you have two execute code that could probably be put in just one execute code.

Agreed, I will post the new version with the adjustments you suggested in the Test section

1 Like

You should be able to actually move your submission over to the testing forum. Else I can also do it