https://github.com/deivu/zuikaku
A very lightweight wrapper around osu! api
https://github.com/deivu/zuikaku
osu osu-api osu-libraries osugame
Last synced: 9 months ago
JSON representation
A very lightweight wrapper around osu! api
- Host: GitHub
- URL: https://github.com/deivu/zuikaku
- Owner: Deivu
- License: mit
- Created: 2019-06-07T03:28:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-12-15T08:21:23.000Z (over 5 years ago)
- Last Synced: 2025-08-09T19:49:08.791Z (11 months ago)
- Topics: osu, osu-api, osu-libraries, osugame
- Language: JavaScript
- Homepage: https://deivu.github.io/Zuikaku/
- Size: 83 KB
- Stars: 6
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zuikaku
The ShipGirl Project. Zuikaku. `(c) Kancolle for Zuikaku`.
### A very lightweight wrapper around osu! api.
### Installation
```
npm i zuikaku
```
### Documentation
https://deivu.github.io/Zuikaku/?api
### Example Usage
```js
const { Zuikaku } = require('zuikaku');
const zuikaku = new Zuikaku('your_osu!_token');
async function start() {
const user = await zuikaku.getUser({ u: 'Deivu', m: 0 });
console.log(user[0]);
const userBest = await zuikaku.getUserBest({ u: 'Deivu', m: 0 });
console.log(userBest[0]);
const beatmap = await zuikaku.getBeatmaps({ b: 1619555, m: 0 });
console.log(beatmap[0]);
}
start()
.then(() => console.log('All requests are done'))
.catch(console.error);
```
Or this [`Client.js`](https://github.com/Deivu/Zuikaku/blob/master/test/Client.js)
### osu! API wiki
You can find the wiki in [`HERE`](https://github.com/ppy/osu-api/wiki)