Skip to content

sibogentleman/vdb

 
 

Repository files navigation

VTuber Database Test Status Build Status

All Contributors

The Virtual Youtuber Name List Database.

We are looking for creating a database containing all vtubers.

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.

  • 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
      • ...

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.js: 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 nessasery packages.

  • Fork it
  • Pull request

Add/Update Vtuber

Add or edit files in /vtbs,

.json format,

if possible, run unit test by npm test.

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.js

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
simon3000

πŸ’» πŸ–‹
brainbush
brainbush

πŸ’» πŸ–‹
Afanyiyu
Afanyiyu

πŸ“–
miragora123
miragora123

πŸ–‹
makiscarle
makiscarle

πŸ–‹
yfk2012
yfk2012

πŸ–‹
yamisight
yamisight

πŸ–‹
kevinmiao907
kevinmiao907

πŸ–‹
εΉ»ε…‰η΅ι£Ž
εΉ»ε…‰η΅ι£Ž

πŸ–‹
GCyingmanji
GCyingmanji

πŸ–‹
JoshuaHiroko
JoshuaHiroko

πŸ–‹
NeroArc
NeroArc

πŸ–‹
IzumiNanaya
IzumiNanaya

πŸ–‹
NekodakeRise
NekodakeRise

πŸ–‹
SlagerZ
SlagerZ

πŸ–‹
Z - The Magical Color
Z - The Magical Color

πŸ–‹
yuqingyuci
yuqingyuci

πŸ–‹
morykudo
morykudo

πŸ–‹
fubuki1057
fubuki1057

πŸ–‹
AwAw565
AwAw565

πŸ–‹
aa610817338
aa610817338

πŸ–‹
bb610817338
bb610817338

πŸ–‹
sliddqdidkfa
sliddqdidkfa

πŸ–‹
C-JIUJIE
C-JIUJIE

πŸ–‹
992939504
992939504

πŸ–‹
289788042
289788042

πŸ–‹
AFatOtaku
AFatOtaku

πŸ–‹
Curtis Xiao
Curtis Xiao

πŸ’» πŸ–‹
Thiece
Thiece

πŸ–‹
Yuzhang Xie
Yuzhang Xie

πŸ–‹
example123
example123

πŸ’» πŸ–‹
shugen002
shugen002

πŸ’» πŸ–‹
Tunghsiao Liu
Tunghsiao Liu

πŸ’» πŸ–‹
yuzhongliang22
yuzhongliang22

πŸ’» πŸ–‹
Takaranoao
Takaranoao

πŸ–‹
ghostmiaojun
ghostmiaojun

πŸ–‹
IOP1473
IOP1473

πŸ–‹
sxuweil28kvw
sxuweil28kvw

πŸ–‹
PoiDaisuki
PoiDaisuki

πŸ–‹
NciyuandeAK
NciyuandeAK

πŸ–‹
peng233163
peng233163

πŸ–‹
bluboy-official
bluboy-official

πŸ–‹ πŸ’»
plzsjj
plzsjj

πŸ–‹
eiji24
eiji24

πŸ–‹
wdwsbn
wdwsbn

πŸ–‹
Zixi Lee
Zixi Lee

πŸ“–
zhuhy051
zhuhy051

πŸ–‹

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

About

Vtuber Database

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.4%
  • Shell 1.6%