Skip to content
cyperdark edited this page Sep 28, 2024 · 8 revisions

Welcome to the tosu wiki!

Features

Files api

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

API's

  • /ws - gosu compatible api
  • /websocket/v2 - tosu own api with a huge amount of new data
  • /websocket/v2/precise - api for sensetive data, like keyOverlay and error bar
  • /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

Settings API

A small tutorial link



Socket wrapper

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

Example of usage can be found here



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


Examples of API's

v1 (gosu) example.json

v2 example.json

v2 precise example.json