Lightweight static profile and playlist hosting for virtual creators.
Homepage · Registry · Dreamail Guide
This repository powers suki.live, a static site hosted with GitHub Pages and routed by Cloudflare.
Each creator gets a subdomain such as:
https://your-id.suki.live
Most pages use the shared template in u/index.html. A creator only needs to provide content files such as info.json, playlist.json, and optional assets.
- Subdomain-based creator pages
- Shared playlist/profile template
- Optional Markdown bio
- Optional avatar and favicon
- Optional header and body background images
- Optional Dreamail link
- Registry page built from
u/registry.json - Optional custom page redirect via
use_custom_page: true
suki-live/
├── assets/
│ ├── css/
│ │ ├── site.css
│ │ └── template.css
│ └── js/
│ ├── registry.js
│ └── template/
│ ├── backgrounds.js
│ ├── bili.js
│ ├── bootstrap.js
│ ├── loaders.js
│ ├── playlist.js
│ ├── render.js
│ └── utils.js
├── index.html
├── registry.html
├── CNAME
├── README.md
├── scripts/
│ └── validate-repo.mjs
└── u/
├── index.html
├── registry.json
├── example/
│ ├── info.json
│ ├── playlist.json
│ ├── bio.md
│ ├── avatar.png
│ ├── favicon.ico
│ ├── head_bg.png
│ ├── head_bg_mobile.png
│ ├── body_bg.png
│ ├── body_bg_mobile.png
│ └── custom.html
└── your-id/
Create a fork of:
https://github.com/vtuber-toolkit/suki-live
Add a directory under u/:
u/your-id/
your-id becomes your subdomain:
https://your-id.suki.live
Minimum setup:
u/your-id/
├── info.json
└── playlist.json
Optional files:
u/your-id/
├── bio.md
├── avatar.png
├── favicon.ico
├── head_bg.png
├── head_bg_mobile.png
├── body_bg.png
├── body_bg_mobile.png
└── custom.html
Update u/registry.json and add a new object to vtubers.
Submit your changes to:
https://github.com/vtuber-toolkit/suki-live
Recommended PR title:
[Register] your-id
Example:
{
"name": "Your Name",
"tagline": "A short description",
"bio": true,
"show_playlist": true,
"show_header_bg": false,
"show_body_bg": false,
"anonymail": "https://dreamail.cn/send?dm=xxx",
"social": [
{ "label": "B站", "url": "https://space.bilibili.com/xxx" }
],
"created_at": "2026-01-01",
"updated_at": "2026-01-01"
}Fields:
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | Display name |
tagline |
string | no | Short subtitle |
bio |
boolean | no | Whether to load bio.md |
show_playlist |
boolean | no | Whether to display the playlist section |
show_header_bg |
boolean | no | Whether to use head_bg.png or head_bg_mobile.png |
show_body_bg |
boolean | no | Whether to use body_bg.png or body_bg_mobile.png |
anonymail |
string | no | Dreamail link |
social |
array | no | Social link list |
created_at |
string | no | Creation date |
updated_at |
string | no | Last update date |
use_custom_page |
boolean | no | Redirects to custom.html instead of rendering the shared template |
Example:
{
"title": "My Playlist",
"description": "Optional description",
"items": [
{
"title": "Song Title",
"artist": "Artist Name",
"source": "B站",
"language": "中文",
"genre": "流行",
"access": "免费",
"url": "https://example.com",
"cover": "https://example.com/cover.jpg",
"note": "Optional note",
"added_at": "2026-01-01"
}
]
}Fields for each item:
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | yes | Song title |
artist |
string | no | Artist or original performer |
source |
string | no | Platform or source |
language |
string or string[] | no | One or more language labels; single-string values remain supported |
genre |
string or string[] | no | One or more genre labels; single-string values remain supported |
access |
string or string[] | no | One or more access tags such as 免费 or 歌切; single-string values remain supported |
url |
string | no | Playback link |
cover |
string | no | Cover image URL |
note |
string | no | Free-form note |
added_at |
string | no | Added date |
If bio is true, the shared template will try to load bio.md.
The page currently supports simple Markdown content including:
- headings
- paragraphs
- emphasis
- links
- blockquotes
- tables
- horizontal rules
If you set:
{
"use_custom_page": true
}the current shared template redirects the creator page to:
u/your-id/custom.html
This is the current behavior of the repository and should be treated as the supported custom-page path.
u/registry.json contains the public directory listing used by registry.html.
Example entry:
{
"id": "your-id",
"name": "Your Name",
"tagline": "Your short description",
"registered_at": "2026-01-01",
"status": "active"
}Fields:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Subdomain identifier, must match the directory name |
name |
string | yes | Display name |
tagline |
string | no | Short description shown in the registry |
registered_at |
string | no | Registration date |
status |
string | yes | One of active, inactive, banned, or memorial |
- Keep file names and directory names consistent with the chosen subdomain ID
- Creator directory names and registry IDs should be lowercase with no leading or trailing spaces
- Prefer relative paths for creator-owned files
- Keep playlist data valid JSON
Run the repository checks before submitting a pull request:
node scripts/validate-repo.mjs
The validator currently checks:
- every
.jsonfile parses successfully - every creator directory under
u/is lowercase - every registry
idis trimmed, lowercase, unique, and matches a real directory playlist.jsonexists when playlists are enabledbio.mdexists whenbio: truecustom.htmlexists whenuse_custom_page: true- Keep public-facing copy factual and aligned with the current implementation
Check:
- The pull request has been merged
u/your-id/info.jsonexists and is valid JSON- The creator ID matches the intended subdomain
- Deployment and cache have caught up
Check:
- The file is named
avatar.png - It exists in
u/your-id/ - The image is valid and readable by the browser
Check:
biois set totrueininfo.jsonbio.mdexists in the same directory
Check:
use_custom_pageis set totruecustom.htmlexists inu/your-id/
Issues and pull requests are welcome.
Suggested PR title patterns:
[Register] add creator page
[Fix] correct template behavior
[Docs] rewrite project documentation
Repository: