猫猫按钮 / Hiiro 按钮 / Hiiro Button

Hiiro...Hiiro...寂しい

• https://hiiro.club/

相关链接：

• Hiiro 的 Bilibili 直播间

参与完善本项目

• 您可以在Issues提出您的建议。

  • 若是请求添加新语音，请使用指定的issues模板
  • 不熟悉github的用法也可以到Bilibili和我联系

• 如果您可以进行开发，那么请Fork本项目进行修改，完成修改后在本项目中发起一个Pull Request，详细说明请查看以下条目

  Pull Request请提交至dev分支

添加或修改音频/完善翻译

音频文件推荐使用mp3格式，请先音量标准化，然后放入public/voices/目录

所有的分类和音频信息都存储在setting/translate目录的json文件中，添加或修改音频信息、完善翻译，你需要修改对应文件中的内容

locales.json和category.json分别为 UI 界面翻译和分类信息，请不要修改文件名，语音信息可以使用除此外的任意名称，可使用多个json文件方便管理语音

可使用schema文件夹中的json文件增加json schema约束和代码提醒

category.json结构示例如下：

[
  {
    // 分类命名
    "name": "名言",
    // 是否隐藏
    "hide": true,
    "translate": {
      // 分类中文翻译
      "zh-CN": "猫猫名言~",
      // 分类英文翻译
      "en-US": "witticism~"
    }
  }
]

语音文件结构示例如下：

[
  {
    // 语音命名
    "name": "baba",
    // 语音文件名
    "path": "baba.mp3",
    // 是否隐藏
    "hide": true,
    "translate": {
      // 语音中文翻译
      "zh-CN": "米娜我是你爸爸",
      // 语音英语翻译
      "en-US": "I'm your Baba"
    },
    // 语音所属分类(对应category的name)
    "category": "名言",
    // 以下属性为可选
    // hover时显示图片，请放到public/voices/img目录
    "usePicture": {
      "zh-CN": "",
      "en-US": ""
    },
    // 添加时间
    "date": "2020-11-11",
    // 语音出处
    "mark": {
      "title": "【Hiiro】读评论 学中文 DD们的评论都是什么东西啊？",
      "time": "0:01~0:03",
      "url": "https://www.bilibili.com/video/BV1ET4y177A8"
    }
  }
]

使用模板

若想使用网站模板开发新的语音按钮，可以选择以下两种方式:

• 使用模板模板项目修改
  • 修改public和setting目录下的文件以及package.json
• 使用voices-button-cli命令行工具生成项目

因为本项目含有非通用的代码以及访问统计，所以不推荐直接修改本仓库，若依然要使用，请注意：

• 修改或删除setting/setting.json里用于访问统计的GA_ID

LICENSE

• 项目使用GPL-3.0为基础开源协议
• 若使用了本项目为范本开发项目或使用了项目代码请在明显位置声明原作者(https://github.com/blacktunes) 以及本仓库(https://github.com/blacktunes/hiiro-button).