Skip to content

Xarib/OsuMapMatcher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🔴 This service does not work anymore! Please refrain from using it. There have been changes on how osu! saves maps and that broke it. Due to infrequent use, the server has been taken down.

OsuMapMatcher

A API/Programm that finds similarly mapped maps in a easy manner.

First time user?

You can find the installation guide here: https://github.com/Xarib/OsuMapMatcher/wiki/Installation-guide

Known limitations

  • Only Chrome, Firefox and the new Edge browser are supported.
  • It only works with osu!std.
  • When searching, you cany only select maps that are also on the server. There is no local calculation.
  • It currently struggles with techmaps or any other slider heavy maps.
  • Some maps are just to exotic for the API.
  • Old maps don't have a preview because the underlying .osu file is missing necessary data.
  • osu!lazer is not supported

Roadmap / Planned features

  • Improve parser in the slider department to get better results when searching for techmaps.
  • Cleanup the .osu file parser and make it public.
  • Make all osu!std maps selectable
  • Ask peppy for unranked maps
  • Add search history
  • Redesign the programm

API usage

Find similar maps: https://omm.xarib.ch/api/knn/search?id={beatmapId}&count={count}

Parameter Description
beatmapId The id of the beatmap. Do not confuse it with the beatmapsetId
count (optional) The number of maps you want to get. You can get 1-50 maps. The default is 10.

Example: https://omm.xarib.ch/api/knn/search?id=129891&count=5

List of available maps: https://omm.xarib.ch/api/knn/maps

Current rate-limit: 3r/s with a burst capacity of 5. See https://www.nginx.com/blog/rate-limiting-nginx/ on how NGINX handles rate-limiting.

Overusage will be met with a temporary ban. It warns you with a 429 status code when you go over the limit.

Special thanks to

  • Peppy for showing me where to mass download .osu text files
  • xMOINx for feedback

Licenses

The following projects where used in the project.