Ganymede

https://github.com/zibbp/ganymede
Admin
Ganymede is a Twitch VOD and live stream archiving platform with real-time chat playback and...
Tokens:5,391
Snippets:80
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Folder Template Example with Date, ID, and Type

Source: https://github.com/zibbp/ganymede/wiki/Storage-Templates-and-Migration

Organize folders using the video's date, Twitch ID, and type. The `{{uuid}}` variable is essential for preventing file overwrites.

```js
{{date}}-{{id}}-{{type}}-{{uuid}}
// 2022-01-10-123456789-archive-92e1ab28-912a-11ed-abfa-0242ac110002
```

--------------------------------

### Folder Template Example with ID and UUID

Source: https://github.com/zibbp/ganymede/wiki/Storage-Templates-and-Migration

Use this template to organize folders by Twitch ID and Ganymede UUID. Ensure `{{uuid}}` is included for uniqueness.

```js
{{id}}-{{uuid}}
// 123456789-92e1ab28-912a-11ed-abfa-0242ac110002
```

--------------------------------

### Default VOD File Structure Example

Source: https://github.com/zibbp/ganymede/wiki/File-Structure

Illustrates the default directory and file naming conventions for saved VODs. This structure is designed to be independent of Ganymede and includes chat logs, metadata, and video files.

```text
vods/
├── staysafetv/
│   └── 2022-06-14-1208897020-archive-1c54374c-0836-11ed-b7c5-0242ac140002/
│       ├── 1208897020-chat.json
│       ├── 1208897020-chat.mp4
│       ├── 1208897020-info.json
│       ├── 1208897020-thumbnail.jpg
│       ├── 1208897020-web_thumbnail.jpg
│       └── 1208897020-video.mp4
├── asmongold/
│   └── 2022-06-15-1050818765-archive-284e53e9-0836-11ed-b7c5-0242ac140002/
│       ├── 1050818765-chat.json
│       ├── 1050818765-chat.mp4
│       ├── 1050818765-info.json
│       ├── 1050818765-thumbnail.jpg
│       ├── 1050818765-web_thumbnail.jpg
│       └── 1050818765-video.mp4
├── mizkif
└── zibbp
```

--------------------------------

### Get N number of comments from time

Source: https://github.com/zibbp/ganymede/wiki/Realtime-Chat-Playback

Returns N number of comments before the specified start time. This is used when seeking in a VOD.

```APIDOC
## GET /api/v1/vod/void_id/chat/seek

### Description
Returns N number of comments before the specified start time. This is used when seeking in a VOD.

### Method
GET

### Endpoint
/api/v1/vod/void_id/chat/seek

### Parameters
#### Path Parameters
- **void_id** (string) - Required - The ID of the VOD.
#### Query Parameters
- **start** (integer) - Required - The start time in seconds.
- **count** (integer) - Required - The number of comments to retrieve.

### Response
#### Success Response (200)
- **comments** (array) - An array of chat comment objects preceding the start time.
```

--------------------------------

### Get chat comments

Source: https://github.com/zibbp/ganymede/wiki/Realtime-Chat-Playback

Returns chat comments between a specified start and end time.

```APIDOC
## GET /api/v1/vod/vod_id/chat

### Description
Returns chat comments between a specified start and end time.

### Method
GET

### Endpoint
/api/v1/vod/vod_id/chat

### Parameters
#### Path Parameters
- **vod_id** (string) - Required - The ID of the VOD.
#### Query Parameters
- **start** (integer) - Required - The start time in seconds.
- **end** (integer) - Required - The end time in seconds.

### Response
#### Success Response (200)
- **comments** (array) - An array of chat comment objects.
```

--------------------------------

### Folder Template Example with Date, Title, Type, ID, and UUID

Source: https://github.com/zibbp/ganymede/wiki/Storage-Templates-and-Migration

A comprehensive folder template including date, sanitized title, type, Twitch ID, and Ganymede UUID for detailed organization. The `{{uuid}}` is mandatory.

```js
{{date}}-{{title}}-{{type}}-{{id}}-{{uuid}}
// 2022-01-10-File_Safe_Title-archive-123456789-92e1ab28-912a-11ed-abfa-0242ac110002
```

--------------------------------

### Get Badges

Source: https://github.com/zibbp/ganymede/wiki/Realtime-Chat-Playback

Returns badges for the specified VOD's chat. This endpoint will attempt to locate embedded badges first. If there are no embedded badges, it will fetch both global and channel badges from Twitch.

```APIDOC
## GET /api/v1/vod/vod_id/chat/badges

### Description
Returns badges for the specified VOD's chat. This endpoint will attempt to locate embedded badges first. If there are no embedded badges, it will fetch both global and channel badges from Twitch.

### Method
GET

### Endpoint
/api/v1/vod/vod_id/chat/badges

### Parameters
#### Path Parameters
- **vod_id** (string) - Required - The ID of the VOD.

### Response
#### Success Response (200)
- **badges** (object) - Description of badges returned.
```

--------------------------------

### Get Emotes

Source: https://github.com/zibbp/ganymede/wiki/Realtime-Chat-Playback

Returns emotes for the specified VOD's chat. This endpoint will first look for embedded emotes in the `chat.json` file. If none exist it will fetch both global and channel emotes from Twitch, BTTV, FFZ, and 7TV.

```APIDOC
## GET /api/v1/vod/vod_id/chat/emotes

### Description
Returns emotes for the specified VOD's chat. This endpoint will first look for embedded emotes in the `chat.json` file. If none exist it will fetch both global and channel emotes from Twitch, BTTV, FFZ, and 7TV.

### Method
GET

### Endpoint
/api/v1/vod/vod_id/chat/emotes

### Parameters
#### Path Parameters
- **vod_id** (string) - Required - The ID of the VOD.

### Response
#### Success Response (200)
- **emotes** (object) - Description of emotes returned.
```

--------------------------------

### Streamlink Arguments for Live Archives

Source: https://github.com/zibbp/ganymede/wiki/Application-Settings

Provide comma-separated Streamlink arguments for live archiving. Ensure arguments are correctly formatted, using commas as separators instead of spaces.

```text
--force-progress,--force,--twitch-low-latency,--twitch-disable-hosting
```

--------------------------------

### FFmpeg Parameters for Video Post-processing

Source: https://github.com/zibbp/ganymede/wiki/Application-Settings

Supply optional FFmpeg parameters to post-process downloaded VODs and livestreams. Only include the middle parameters, excluding input and output, and separate them with spaces.

```text
-c:v libx264 -crf 25 -c:a copy
```

--------------------------------

### Obtain Twitch Auth Token

Source: https://github.com/zibbp/ganymede/wiki/Application-Settings

Use this JavaScript snippet in your browser's developer console to extract your Twitch authentication token from cookies. This token is used for downloading subscriber-only videos and ad-free livestreams.

```javascript
document.cookie.split("; ").find(item=>item.startsWith("auth-token="))?.split("=")[1]
```
Tokens:
Raw