Home

Welcome to the tosu wiki!

settings API ​ ​ socket wrapper ​ ​ api ​ ​ files api ​ ​ fixing issue ​ ​ ingame overlay

Features

Settings API

Since tosu version 2.6.0 we have brand new feature that allow to customize overlays using Settings Api.
Example: KeyOverlay by cyperdark

See A small tutorial on how to add Settings Api to your overlay.

Socket wrapper

Thing to simplify interaction with websocket and settings api (with autocomplete) use this script.js in your pp counter

Example of usage can be found here

Web and Websocket api

• /ws - gosu compatible api
  • /json - for preview or see example here
• /websocket/v2 - tosu own api with a huge amount of new data
  • /json/v2 - for preview or see example here
• /websocket/v2/precise - api for sensetive data, like keyOverlay and error bar
  • /json/v2/precise - for preview or see example here
• /api/calculate/pp - allow to calculate pp/stats for a beatmap with parameters
  • Response example
  • BY DEFAULT IT USES CURRENT BEATMAP (:))
  • All parameters are optional
  • path - Path to .osu file. Example: C:/osu/Songs/beatmap/file.osu
  • mode - Osu = 0, Taiko = 1, Catch = 2, Mania = 3
  • mods - Mods id. Example: 64 - DT
  • acc - Accuracy % from 0 to 100
  • nGeki - Amount of Geki (300g / MAX)
  • nKatu - Amount of Katu (100k / 200)
  • n300 - Amount of 300
  • n100 - Amount of 100
  • n50 - Amount of 50
  • nMisses - Amount of Misses
  • combo - combo
  • passedObjects - Sum of nGeki, nKatu, n300, n100, n50, nMisses
  • clockRate - Map rate number. Example: 1.5 = DT

Files api

• current skin - /files/skin/{filename}
• all beatmaps - /files/beatmap/{path} (or /Songs/{path})

In-game overlay

Enable ENABLE_GOSU_OVERLAY in tosu dashboard or in tosu.env: ENABLE_GOSU_OVERLAY=true.
Quick video tutorial on how to setup it: link

Fixing issues

How to see what issue you have (if tosu instantly closes): read here

1. The specified module could not be found
2. For others join discord and read #faq channel, before asking for help