statosu_framework v1.1.0

Installation

1, Install prerequisites

Since this framework contains node-canvas, prerequisite installation is required for each OS.

Compiling

If you don't have a supported OS or processor architecture, or you use --build-from-source, the module will be compiled on your system. This requires several dependencies, including Cairo and Pango.

For detailed installation information, see the wiki. One-line installation instructions for common OSes are below. Note that libgif/giflib, librsvg and libjpeg are optional and only required if you need GIF, SVG and JPEG support, respectively. Cairo v1.10.0 or later is required.

Mac OS X v10.11+: If you have recently updated to Mac OS X v10.11+ and are experiencing trouble when compiling, run the following command: xcode-select --install. Read more about the problem on Stack Overflow. If you have xcode 10.0 or higher installed, in order to build from source you need NPM 6.4.1 or higher.

Quote: https://github.com/Automattic/node-canvas#compiling

2, Install modules

Once the prerequisites have been installed, you only need to install the modules.

$ npm install statosu_framework

Usage

const framework = require("statosu_framework");
const fs = require("fs");

const osu_api_key = ""; // osu!api(v1) token
const ripple_api_key = ""; // Ripple API(v1) token

const twitter_data = {
    /* JSON data obtained from Statosu User twitter config database */
    osu_name: "", // osu!(ripple) username
    osu_mode: 3, // 0 => Std, 1 => Taiko, 2 => Ctb, 3 => Mania
    osu_server: 0 // 0 => Official server, 1 => Ripple server
};

const db_data = {
    /* JSON data obtained from Statosu Player data database */
    /* JSON data is obtained from the API in advance at a predetermined time and stored */
    /* Not required, but will not allow comparison with previous data */
};

framework.create_image(twitter_data, db_data, osu_api_key, ripple_api_key)
    .then(buffer => {
        fs.writeFile(__dirname + "/" + `./Test_image.png`, buffer, err => {
                if (err != null) throw new Error(err);
            }
        );
    });

Example of output image

Font in the image uses Torus font.

Licence

Statosu framework is licensed under the MIT License. Please see the license file for more information. Please also note that image fonts and asset/icon/avatar-guest.png are another license. Please see NDISCOVER/Exo-2.0, googlefonts/comfortaa and ppy/osu-resources repository for details.