README.md

VTuber Database

The Virtual Youtuber Name List Database.

We are looking for creating a database containing all vtubers.

Online Editor: https://submit.vtbs.moe

Usage:

JSON file can be downloaded from: https://vdb.vtbs.moe/json/list.json, https://vdb.vtbs.moe/json/list.json

• meta: Object Metadata. Tools for parsing information about each individual VTuber.

  • UUID_NAMESPACE: (String) The UUID namespace, currently 9e880107-dd14-4f7d-a04c-4b2bf8d9db7d.

  • linkSyntax: (Object) A map of formatting strings, organized as "platform":"formatting string". The formating strings contain substring {id}. By replacing {id} with the respective platform ID, a URL to his/her channel or profile on that plaform is generated.

    For example, A virtual youtuber has bilibili id 349991143 (i.e. vtbs[].accounts[i].platform == "bilibili" and vtbs[].accounts[i].id == "349991143". See vtbs.accounts below), and linkSyntax.bilibili is https://space.bilibili.com/{id}, So https://space.bilibili.com/349991143 will be the url.

  • timestamp: (Number) Latest committer date, UNIX timestamp

• vtbs: (Array[Object]) Contains all Vtubers

  • uuid: (String) The uuid generated from the namecpace and file in /vtbs name
  • type: (String) Type, can be vtuber, group, fan or unknow
  • bot: (Boolean) robot vtuber/vup
  • accounts: (Array[Object])
    • id: (String) The account identifier of that platform
    • type: (String) official or relay
    • platform: (String) Can be youtube, twitter, bilibili, userlocal, or something else
  • name: (Object)
    • default: (String) the default language of name
    • cn: (String) Chinese name
    • jp: (String) Japanese name
    • en: (String) English name
    • ...
    • extra: (Array[String]) Alternative names

File structure:

• /backup: some script and list from elsewhere

• /config: the config file

  • /config/index.js: the main config file

    • UUID_NAMESPACE: The current UUID namespace

    • linkSyntax: the link syntax

• /syntax: syntax guides

  • /syntax/list.json: A very minimal list.json example

• /test: test files

  • /test/repeat.js: test for duplicated official accounts

• /vtbs: all vtubers in human readable/editable format

• index.js: The database generator, return promise

• generator.mjs: write the database to json file

Extra

uuid of each vtuber is generated with uuid v5 from the uuid namespace and the vtuber data filename located in /vtbs

Contribution

Node.js is required for some processes

if Node.js is installed, you can use npm install to install necessary packages.

• Fork it
• Pull request

Add/Update Vtuber

Add or edit files in /vtbs,

.json format,

if possible, run unit test by npm test.

Or, online editor https://submit.vtbs.moe can be used, only a browser is needed.

Add/Update Social Media Platform linkSyntax

Edit /config/index.js.

Unit test

npm test

If there is error, there is a problem with files.

Rewrite json files (Production)

Make sure to pass all the tests!

Use node generator.mjs

This step is required for vtbs.moe refresh the list.

Should be done automatically on GitHub Actions.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

simon3000 💻 🖋	brainbush 💻 🖋	Afanyiyu 📖	miragora123 🖋	makiscarle 🖋	yfk2012 🖋	yamisight 🖋	kevinmiao907 🖋
幻光灵风 🖋	GCyingmanji 🖋	JoshuaHiroko 🖋	NeroArc 🖋	IzumiNanaya 🖋	NekodakeRise 🖋	SlagerZ 🖋	Z - The Magical Color 🖋
yuqingyuci 🖋	morykudo 🖋	fubuki1057 🖋	AwAw565 🖋	aa610817338 🖋	bb610817338 🖋	sliddqdidkfa 🖋	C-JIUJIE 🖋
992939504 🖋	289788042 🖋	AFatOtaku 🖋	Curtis Xiao 💻 🖋	Thiece 🖋	Yuzhang Xie 🖋	example123 💻 🖋	shugen002 💻 🖋
Tunghsiao Liu 💻 🖋	yuzhongliang22 💻 🖋	Takaranoao 🖋	ghostmiaojun 🖋	IOP1473 🖋	sxuweil28kvw 🖋	PoiDaisuki 🖋 💻	NciyuandeAK 🖋
peng233163 🖋	bluboy-official 🖋 💻	plzsjj 🖋	eiji24 🖋	wdwsbn 🖋	Zixi Lee 📖	zhuhy051 🖋	ryouka-li 🖋
LoganHaiz 🖋	Tup0lev 🖋	2333tracy 🖋	Muyisa1551 🖋	doufubao0401 🖋	SaigusaTomato 🖋	qq542065853 🖋	8Mi_Yile 🖋
syosaisyo 🖋	Dreamluna 🖋	UMW 🖋	zhu1040028623 🖋	Benben 🖋	SaigyoujiKonpaku 🖋	1126441811 🖋	MPIQI 🖋
SuzumeRei 🖋	De. Clare 🖋	Hakuchuu 🖋	ATKghost 🖋	zhihaofans 🖋	yurix233 🖋	xijibache 🖋	okiseji 🖋
YukimuraAoi 🖋	DDs_moe 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!