https://github.com/andtechstudios/trophy

Leaderboards API server
https://github.com/andtechstudios/trophy

Last synced: about 1 year ago
JSON representation

Leaderboards API server

• Host: GitHub
• URL: https://github.com/andtechstudios/trophy
• Owner: andtechstudios
• License: bsd-3-clause
• Created: 2022-04-14T17:19:16.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-05-06T18:50:18.000Z (about 4 years ago)
• Last Synced: 2025-02-06T16:58:56.680Z (over 1 year ago)
• Language: C#
• Homepage:
• Size: 66.4 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/andtechstudios/trophy?logo=docker)](https://hub.docker.com/r/andtechstudios/trophy)

[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/andtechstudios/trophy/tree/master)

# Overview

*Trophy* is a simple leaderboard server with profanity filtering.

## Anonymous usernames

The API is designed for leaderboards with anonymous players (i.e. players won't need an account to appear on the leaderboard). In order to mitigate abuse, usernames are processed as follows:

* Usernames are sanitized of profanity (see [PurgoMalum](https://www.purgomalum.com))

* Usernames are removed of whitespace characters

* Usernames are removed of digit characters

# Setup

## Docker

* Choose an `AUTH_KEY` in docker-compose.yml.

# See Also

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/andtechstudios/trophy)