oii - osu! improvement indicator

<p align="center"> <img src="https://github.com/ferryhmm/oii/blob/main/extension/images/oii128.png" /> </p>

A browser extension, that adds ii (improvement indicator, a metric that compares your pp to the average player with your playtime amount) to user profiles on the osu! website.

General

ii is a value describing the relationship between the players playtime and the expected amount of playtime based on pp. Simply put: It describes a players improvement speed compared to the average.

$$ ii = \frac{expected playtime}{actual playtime} $$

The expected playtime describes the playtime the average player would need to reach the given pp. The function for this was modelled off of a trendline showing the relationship between playtime and pp on a dataset with a sample of 10.000 players.

$$ expected playtime = -12 + 0.0781 \cdot pp + 6.01 \times 10^{-6} \cdot pp^2 $$

Thus the formula for calculating the ii value is as follows:

$$ ii = \frac{-12 + 0.0781 \cdot pp + 6.01 \times 10^{-6} \cdot pp^2}{playtime_{hours}} $$

For more information, you can watch this video. The raw data used to create the function can be found here, while the google sheet containing the processed data can be found here.

If you have any questions or want to contribute, feel free to join my discord server.

How to install

This extension is currently available for Chrome and Firefox with each having two ways to install it:

Chrome

Via Chrome Webstore

For the latest stable release and automatic updates, it is recommended to install the extension here.

Via GitHub

Alternatively, to get the latest (though not necessarily stable) build, install the extension through these steps. Keep in mind, that the extension will not update automatically this way:

1. Download and unzip the repository
2. Navigate to chrome://extensions/ in your Chrome browser
3. Enable developer mode (top right)
4. Click "Load unpacked" and select the extension folder from this repository

For a more detailed explanation check out this video tutorial.

Firefox

Via Firefox Addons

For the latest stable release and automatic updates, it is recommended to install the extension here.

Via GitHub

Alternatively, to get the latest (though not necessarily stable) build, install the extension through these steps. Keep in mind, that the extension will not update automatically this way and will only stay installed until the next time you restart firefox:

1. Download and unzip the repository
2. Navigate to about:debugging in your Firefox browser
3. Click on "Load Temporary Add-on", then select the manifest.json within the extension folder

Alternatively, you can use web-ext to run the extension from the command line (useful for debugging).