akatsuki-api

command module
v0.0.0-...-ed857cc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 28, 2024 License: AGPL-3.0 Imports: 12 Imported by: 0

README

Discord

akatsukiapi

This is the source code for Akatsuki's API.

Setting up

go get -u -f -d github.com/osuAkatsuki/akatsuki-api

cd $GOPATH/src/github.com/osuAkatsuki/akatsuki-api

Download all dependencies:

go mod download

Compile:

go build

Run API

  • On Windows:

    akatsuki-api (located in ./akatsuki-api.exe)

  • On Linux:

    ./akatsuki-api

Then configure in api.conf and run the API again.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
app
internals
Package internals has methods that suit none of the API packages.
Package internals has methods that suit none of the API packages.
peppy
Package peppy implements the osu! API as defined on the osu-api repository wiki (https://github.com/ppy/osu-api/wiki).
Package peppy implements the osu! API as defined on the osu-api repository wiki (https://github.com/ppy/osu-api/wiki).
v1
Package v1 implements the first version of the Ripple API.
Package v1 implements the first version of the Ripple API.
websockets
Package websockets implements functionality related to the API websockets.
Package websockets implements functionality related to the API websockets.
Package beatmapget is an helper package to retrieve beatmap information from the osu! API, if the beatmap in the database is too old.
Package beatmapget is an helper package to retrieve beatmap information from the osu! API, if the beatmap in the database is too old.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL