https://github.com/gnat/super-score
:dart: Game leaderboards, currency log, and player data storage. REST API server in PHP 7.
https://github.com/gnat/super-score
Last synced: 2 months ago
JSON representation
:dart: Game leaderboards, currency log, and player data storage. REST API server in PHP 7.
- Host: GitHub
- URL: https://github.com/gnat/super-score
- Owner: gnat
- Created: 2016-08-26T02:28:26.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-09-14T06:54:13.000Z (almost 9 years ago)
- Last Synced: 2025-03-28T20:37:25.628Z (3 months ago)
- Language: PHP
- Homepage:
- Size: 36.1 KB
- Stars: 6
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/gnat/super-score)
Game leaderboards, in-game currency logging, and player data storage.
Written by Nathaniel Sabanski.
### Features
* Unlimited score leaderboards with offset querying.
* In-game currency transaction logging with secure hash system.
* Storage of miscellaneous User data.
* Tiny codebase which can be easily added to and security audited.
* Test suite.
### Requirements
* PHP 7+ or 5.3+.
* Apache 2+ (mod_rewrite enabled) or nginx.
### Optional
* Redis and APCu may be installed for a high performance tiered cache.
* PHPUnit may be installed to run the tests.
### Installation Notes
1. Development and production configurations can be set in `src/config/Config.php`
2. Set up your database tables using `install.sql`. You can use `mysql -uUser -pPassword -e "create database superscore; use superscore; source install.sql;"` or by importing the SQL file manually using any database management software.
3. If using nginx, enable routing by using a server rule to route to `index.php`. This is achieved in Apache using `mod_rewrite` and the `.htaccess` file.
4. Remember to switch your `Config()` from 'development' to 'production' in `index.php` before going live!
### REST API Usage
**Any error will contain the following JSON response.**
`{ "Error" : "Reason for failure." }`
**Current Time**
Retrieve the current unix timestamp on this server.
| Endpoint | http://{hostname}/timestamp |
| --- | --- |
| Input | None |
| Output | `{ "Timestamp" : }` |
| File | `src/Controller/Timestamp.php` |
**Leaderboard Score Recording**
Accepts and records scores posted for a User and calculates their current rank in the specified Leaderboard. Returns the User and Leaderboard passed in with the Users highest score for the given Leaderboard.
| Endpoint | http://{hostname}/score/save |
| --- | --- |
| Input | `{ "UserId" : , "LeaderboardId" : , "Score" : }` |
| Output | `{ "UserId" : , "LeaderboardId" : , "Score" : , "Rank" : }` |
| File | `src/Controller/Score.php` |
**Leaderboard Score Query**
Returns a range of entries from the specified Leaderboard in order of rank, along with the score and rank of the specified User. Higher score is better, ranks start at 1.
| Endpoint | http://{hostname}/score/load |
| --- | --- |
| Input | `{ "UserId" : , "LeaderboardId" : , "Offset" : , "Limit" : }` |
| Output | `{ "UserId" : , "LeaderboardId" : , "Score" : , "Rank" : , "Entries" : [ {"UserID" : , "Score" : , "Rank" : }, ... ] }` |
| File | `src/Controller/Score.php` |
**Game Currency Transaction Recording**
Record simple user transactions involving game currency with hash verification. Duplicate transactions will respond with an error.
The Verifier parameter is a SHA-1 hash of the following values concatenated together:
`SecretKey+TransactionId+UserId+CurrencyAmount`
| Endpoint | http://{hostname}/transaction/save |
| --- | --- |
| Input | `{ "TransactionId" : , "UserId" : , "CurrencyAmount" : , "Verifier" : }` |
| Output | `{ "Success" : true }` |
| File | `src/Controller/Transaction.php` |
**Game Currency Transaction Query**
Returns basic details of transactions recorded for the User specified.
| Endpoint | http://{hostname}/transaction/load |
| --- | --- |
| Input | `{ "UserId" : }` |
| Output | `{ "UserId" : , "TransactionCount" : , "CurrencySum" : }` |
| File | `src/Controller/Transaction.php` |
**User Data Save**
Storage for arbitrary JSON data for User. If any key inside storage already exists for the User, the value will be overridden by the passed up value; otherwise the data will be assumed to be unchanged.
| Endpoint | http://{hostname}/user/save |
| --- | --- |
| Input | `{ "UserId" : , "Data" : { } }` |
| Output | `{ "Success" : true }` |
| File | `src/Controller/User.php` |
**User Data Load**
Returns an aggregation of all previous data stored for User.
| Endpoint | http://{hostname}/user/load |
| --- | --- |
| Input | `{ "UserId" : }` |
| Output | `{ }` |
| File | `src/Controller/User.php` |
### Using Composer
Install [Composer](https://getcomposer.org/) and use:
```composer create-project -s dev --prefer-dist gnat/super-score .```
### License
This project is licensed under the MIT License. This means you can use and modify it for free in private or commercial projects.