mirror of
https://github.com/zkldi/Tachi.git
synced 2026-10-04 21:08:09 +03:00
Add GPT documentation
This commit is contained in:
zkldi
+315
-3
@@ -12,20 +12,332 @@ programmatically, you should see [Game Endpoints](./games.md).
|
||||
|
||||
### Parameters
|
||||
|
||||
None.
|
||||
|
||||
### Response
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `config` | GamePTConfig | The configuration file for this game + playtype. |
|
||||
|
||||
!!! warning
|
||||
A GamePTConfig is different to a GameConfig! Read more
|
||||
[here](../../codebase/implementation-details/game-configuration.md).
|
||||
|
||||
### Example
|
||||
|
||||
#### Request
|
||||
```
|
||||
|
||||
GET /api/v1/games/iidx/SP
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
```json
|
||||
{
|
||||
"config": {
|
||||
"idString": "iidx:SP",
|
||||
|
||||
"percentMax": 100,
|
||||
|
||||
"defaultScoreRatingAlg": "ktRating",
|
||||
"defaultSessionRatingAlg": "ktRating",
|
||||
"defaultProfileRatingAlg": "ktRating",
|
||||
|
||||
// ... more props - a lot more props
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
*****
|
||||
|
||||
## Retrieve the player leaderboard.
|
||||
|
||||
`GET /api/v1/leaderboard`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `alg` (Optional) | String | If present, specifies an alternative algorithm to sort players on, instead of the default. |
|
||||
| `start` (Optional) | Integer | If present, specifies a starting point to display the leaderboard from. Essentially pagination. |
|
||||
|
||||
### Response
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `gameStats` | GameStats[] | The sorted statistics for the leaderboards. |
|
||||
| `users` | UserDocument[] | All of the related users for the above statistics. |
|
||||
|
||||
### Example
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET /api/v1/games/iidx/SP/leaderboard
|
||||
```
|
||||
|
||||
#### Response
|
||||
|
||||
```json
|
||||
{
|
||||
"gameStats": [{
|
||||
"userID": 1,
|
||||
"ratings": {
|
||||
"ktRating": 4,
|
||||
// ...
|
||||
}
|
||||
// ...
|
||||
}],
|
||||
"users": [{
|
||||
"id": 1,
|
||||
"username": "zkldi"
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
*****
|
||||
|
||||
## Retrieve a song and its charts.
|
||||
|
||||
`GET /api/v1/games/:game/:playtype/songs/:songID`
|
||||
|
||||
### Parameters
|
||||
|
||||
None.
|
||||
|
||||
### Response
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `song` | SongDocument | The requested song document. |
|
||||
| `charts` | ChartDocument[] | All of the charts that belong to this song for this playtype. |
|
||||
|
||||
### Example
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET /api/v1/games/iidx/SP/songs/1
|
||||
```
|
||||
|
||||
#### Response
|
||||
|
||||
```json
|
||||
{
|
||||
"song": {
|
||||
"id": 1,
|
||||
"title": "5.1.1."
|
||||
},
|
||||
"charts": [{
|
||||
"songID": 1,
|
||||
"playtype": "SP",
|
||||
"difficulty": "HYPER",
|
||||
// ...
|
||||
}, {
|
||||
"songID": 1,
|
||||
"playtype": "SP",
|
||||
"difficulty": "ANOTHER",
|
||||
// ...
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
*****
|
||||
|
||||
## Get popular charts for this game + playtype.
|
||||
|
||||
`GET /api/v1/games/:game/:playtype/charts`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `search` (Optional) | String | A song title to search for. |
|
||||
|
||||
!!! note
|
||||
If no search parameter is set, then the most popular
|
||||
100 charts for this game are returned.
|
||||
|
||||
If a search parameter is set, then the most popular
|
||||
charts that match the search criteria will be returned,
|
||||
in that order.
|
||||
|
||||
### Response
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `charts` | Array<ChartDocument with `__playcount`> | The chart documents that matched this search, or the most popular 100 charts for this game. |
|
||||
| `songs` | Array<SongDocument> | The associated song documents for the charts. |
|
||||
|
||||
!!! info
|
||||
The `__playcount` property is patched onto the chart
|
||||
documents returned. This indicates the amount of unique
|
||||
players that have played this chart.
|
||||
|
||||
### Example
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET /api/v1/games/iidx/SP/charts?search=AA
|
||||
```
|
||||
|
||||
#### Response
|
||||
|
||||
```json
|
||||
{
|
||||
"songs": [{
|
||||
"title": "AA",
|
||||
"id": 3,
|
||||
// ...
|
||||
}, {
|
||||
"title": "AA -rebuild-",
|
||||
"id": 133,
|
||||
// ...
|
||||
}],
|
||||
"charts": [{
|
||||
"songID": 3,
|
||||
"difficulty": "ANOTHER",
|
||||
"__playcount": 1049,
|
||||
// ...
|
||||
}, {
|
||||
"songID": 133,
|
||||
"difficulty": "ANOTHER",
|
||||
"__playcount": 120
|
||||
},
|
||||
//...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*****
|
||||
|
||||
## Retrieve a chart at a specific ID.
|
||||
|
||||
`GET /api/v1/games/:game/:playtype/charts/:chartID`
|
||||
|
||||
### Parameters
|
||||
|
||||
None.
|
||||
|
||||
### Response
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `song` | SongDocument | The parent song for this chart. |
|
||||
| `chart` | ChartDocument | The requested chart document. |
|
||||
|
||||
### Example
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET /api/v1/games/iidx/SP/charts/some_chart_id
|
||||
```
|
||||
|
||||
#### Response
|
||||
|
||||
```json
|
||||
{
|
||||
"song": {
|
||||
"id": 123,
|
||||
"title": "BLOCKS",
|
||||
// ...
|
||||
},
|
||||
"chart": {
|
||||
"chartID": "some_chart_id",
|
||||
"songID": 123,
|
||||
"playtype": "SP",
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
*****
|
||||
|
||||
## Retrieve playcount for this chart.
|
||||
|
||||
`GET /api/v1/games/:game/:playtype/charts/:chartID/playcount`
|
||||
|
||||
### Parameters
|
||||
|
||||
None.
|
||||
|
||||
### Response
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `count` | Integer | The amount of plays on this chart. |
|
||||
|
||||
### Example
|
||||
|
||||
Self-explanatory.
|
||||
|
||||
*****
|
||||
|
||||
## Retrieve leaderboards for this chart.
|
||||
|
||||
`GET /api/v1/games/:game/:playtype/charts/:chartID/pbs`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `startRanking` (Optional) | Specify a start point to return 100 pbs from. Defaults to 1. Inclusive. |
|
||||
|
||||
### Response
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `pbs` | Array<PBDocument> | The array of pbs sorted by ranking. |
|
||||
| `users` | The users these PBs belong to. |
|
||||
|
||||
### Example
|
||||
|
||||
#### Request
|
||||
```
|
||||
GET /api/v1/games/iidx/SP/charts/some_chart/pbs
|
||||
```
|
||||
|
||||
#### Response
|
||||
|
||||
```json
|
||||
{
|
||||
"pbs": [{
|
||||
"chartID": "some_chart",
|
||||
"userID": 1,
|
||||
"rankingData": {
|
||||
"rank": 1,
|
||||
"outOf": 100,
|
||||
},
|
||||
// ...
|
||||
},
|
||||
//...
|
||||
],
|
||||
"users": [{
|
||||
"id": 1,
|
||||
"username": "zkldi",
|
||||
// ...
|
||||
},
|
||||
// ...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*****
|
||||
|
||||
## Search for a user's PB on this chart.
|
||||
|
||||
`GET /api/v1/games/:game/:playtype/charts/:chartID/pbs/search`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Property | Type | Description |
|
||||
| :: | :: | :: |
|
||||
| `search` | String | The user whose PB you're searching for. |
|
||||
|
||||
### Response
|
||||
|
||||
Same as `/api/v1/games/:game/:playtype/charts/:chartID/pbs`.
|
||||
|
||||
### Example
|
||||
|
||||
See Above.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user