Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commandstring/gtatunes.net
Play all of the radio stations from the GTA 3D Universe in one place!
https://github.com/commandstring/gtatunes.net
gta gta-iii gta-sa gta-vc gta-vice-city gtaiii gtasa nuxt radio san-andreas vice-city vue
Last synced: 1 day ago
JSON representation
Play all of the radio stations from the GTA 3D Universe in one place!
- Host: GitHub
- URL: https://github.com/commandstring/gtatunes.net
- Owner: CommandString
- License: mit
- Created: 2024-06-16T06:08:49.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T00:52:36.000Z (about 2 months ago)
- Last Synced: 2024-09-14T14:29:16.821Z (about 2 months ago)
- Topics: gta, gta-iii, gta-sa, gta-vc, gta-vice-city, gtaiii, gtasa, nuxt, radio, san-andreas, vice-city, vue
- Language: Vue
- Homepage: https://gtatunes.net
- Size: 5.44 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [GTATunes](https://gtatunes.net)
Play all the radio stations from the GTA 3D Universe games in one place!
# API Usage
## Objects
### Station Object
```json5
{
"name": "Station Name",
"icon": "Station Icon URL",
"songs": [
// song objects
]
}
```
### Song Object
```json5
{
"name": "Song Name",
"artist": ["Song Artists"],
"year": "Song Year Released"
}
```
## Get Stations
GET `/api/stations` (source: `/server/api/stations.get.ts`)
```json5
{
"sa": [
// station objects
],
"vc": [
// station objects
],
"iii": [
// station objects
]
}
```
## Get Game Stations
GET `/api/:game/stations` (source: `/server/api/:game/stations.get.ts`)
```json5
[
// station objects
]
```
## Play San Andreas Stations
GET `/api/sa/play` (source: `/server/api/sa/play.get.ts`)
### Query Parameters
- `station` (required): The name of the station to play
- `song` (optional): The name of the song to play. (default: Random song)
- `intro` (optional): Which intro to play, usually 1-3, set 0 for no DJ (default: Random intro)*
- `outro` (optional): Which outro to play, usually 1-3, set 0 for no DJ (default: Random outro)*
- `stream` (optional): Whether to respond with an audio stream or wait until the audio is concatenated.**
- `segment` (optional): Insert a segment before the song starts this parameter can be either `ID`, `Caller`, or `DJ`.***
*Note: SFUR doesn't have audio files without the DJ, so setting `intro` and `outro` to 0 will still play the DJ.
**Note: Using an audio stream gets a faster response but be warned that if you are using the audio stream parameter on mobile devices, there is a high chance the audio will break or restart throughout the song. I'm not entirely sure why, but I believe this is due to mobile browsers closing the stream connection prematurely.
***Note: As of now you can't select a specific segment from the type but I would like to make the API more verbose to allow for this in the future.
# DISCLAIMER
Due to the API eventually needed to support multiple games (SA, VC, III) the API **WILL** change in the near future to support this. I will add versioning to the endpoints to help mitigate breaking changes and give them time to update their applications the utilize the API.