Skip to content

EmilienLeroy/HighScore

Repository files navigation

highscore

release GitHub package.json version GitHub

An open-source leaderboard api for your games !


Introduction

Highscore is an open source leaderboard api. It allow you to store easly your scores from your games. You can also get a leaderboard from highscore to display it into your games.

Feature

  • โœจ Simple api to manage leaderboards of your games.
  • ๐Ÿš€ Default website to share your score with everyone.
  • ๐Ÿ“ Fully documented with open spec (swagger).
  • ๐Ÿ”ง Fully configurable using environnement variable.
  • ๐Ÿ“ฑ Add a download link which redirect user depending on his platform.
  • ๐Ÿšซ Prevent bad words into leaderboards scores.
  • ๐Ÿ“ฆ๏ธ Easy to set up and integrate.

Documentation

See the documentation to get more information about how to install and configure a highscore instance.

Contribute

We would love you for the contribution to HighScore project, check the CONTRIBUTING file for more info.

License

MIT License ยฉ 2022 Emilien Leroy