An open API service indexing awesome lists of open source software.

https://github.com/tmpim/osusig

osu!next Signature Generator
https://github.com/tmpim/osusig

Last synced: 5 months ago
JSON representation

osu!next Signature Generator

Awesome Lists containing this project

README

          

# Note
This project is unmaintained. It *should* still run fine if someone chooses to host it, but as for the time being there is no live instance of it. You are welcome to host your own!

# osu!next Signature Generator v3
This is a signature generator written in PHP for osu!next style signatures. The design is based on flyte's design. Live version with the generator can be found [here](http://lemmmy.pw/osusig).

_Relatively_ up-to-date documentation can be found [at my site here](http://lemmmy.pw/osusig/docs).

## Usage
The generator itself is in `sig.php`. All templates accepts the following parameters:
* `uname` - **required** The username of the user you want to generate a signature for
* `colour` - The background and stroke colour of the signature. Valid values are any 6 digit hex value prepended by `hex` or `%23`, or:

| Colour name | Hex colour |
| ----------- | ---------- |
| red | `#ee3333` |
| orange | `#ee8833` |
| yellow | `#ffcc22` |
| green | `#aadd00` |
| blue | `#66ccff` |
| purple | `#8866ee` |
| bpink | `#ff66aa` |
| darkblue | `#2255ee` |
| pink | `#bb1177` |
| black | `#000000` |

* `mode` - The gamemode you wish to view stats for. `0` is osu!standard, `1` is osu!taiko, `2` is osu!catch and `3` is osu!mania.

TemplateNormal accepts the following:

* `pp` - Where you want the pp to be displayed. Undefined does not show at all, `0` shows in place of the level, `1` shows next to the accuracy and `2` shows above the rank.
* `removeavmargin` - If specified (no value required), there will not be a 3px margin between the card's stroke and the profile picture.
* `flagshadow` - Adds a shadow to the flag
* `flagstroke` - Adds a stroke to the flag
* `countryrank` - Shows your country rank (experimental)
* `darkheader` - Darkens the text in the header
* `darktriangles` - Darkens the triangles
* `opaqueavatar` - Adds a white background behind the avatar
* `avatarrounding` - Sets a custom rounding for the avatar - must be a numeric value
* `rankedscore` - Whether to show the ranked score in place of the Play Count or not

## Examples

| `colour` | `uname` | `mode` | Image |
| -------- | -------- | ----------- |:-----:|
| `green` | `Lemmmy` | unspecified | ![](http://lemmmy.pw/osusig/sig.php?colour=green&uname=Lemmmy) |
| `pink` | `sobatsuyu` | `1` | ![](http://lemmmy.pw/osusig/sig.php?colour=pink&uname=sobatsuyu&mode=1) |
| `hexFFAA00`| `hvick225` | `0` | ![](http://lemmmy.pw/osusig/sig.php?colour=hexFFAA00&uname=hvick225&mode=0) |

_Note:_ `hex` is a workaround for osu!'s gocamo server

### Live examples

| URL | `Image` |
| -------- | :--------: |
| `http://lemmmy.pw/osusig/sig.php?colour=purple&uname=Lemmmy` | ![](http://lemmmy.pw/osusig/sig.php?colour=purple&uname=Lemmmy) |
| `http://lemmmy.pw/osusig/sig.php?colour=blue&uname=rrtyui&pp=2` | ![](http://lemmmy.pw/osusig/sig.php?colour=blue&uname=rrtyui&pp=2)|
| `http://lemmmy.pw/osusig/sig.php?colour=yellow&uname=jhlee0133&mode=3&pp=1` |![](http://lemmmy.pw/osusig/sig.php?colour=yellow&uname=jhlee0133&mode=3&pp=1) |

## Requirements
The generator requires ImageMagick and memcached.
You will need a file in `p/` called `.priv.php` with contents like such: