Skip to content

Latest commit

 

History

History
95 lines (77 loc) · 3.81 KB

README.md

File metadata and controls

95 lines (77 loc) · 3.81 KB
Raw

七奈按钮 / NANA BUTTON

项目地址: https://kaguranana.moe/

相关链接：

参与完善本项目

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

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

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

Pull Request请提交至dev分支

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

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

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

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

category.json结构示例如下：

[
  {
    // 分类命名
    "name": "ななちゃん罵倒して",
    "translate": {
      // 分类中文翻译
      "zh-CN": "七奈再骂我一次~",
      // 分类英文翻译
      "ja-JP": "ななちゃん罵倒して~"
    }
  }
]

语音文件结构示例如下：

[
  {
    // 语音命名
    "name": "DD斩首x5",
    // 语音文件名
    "path": "DD斩首x5.mp3",
    "translate": {
      // 语音中文翻译
      "zh-CN": "DD斩首x5",
      // 语音日语翻译
      "en-US": "DD斬首x5"
    },
    // 语音所属分类(对应category的name)
    "category": "ななちゃん罵倒して",
    // 以下属性为可选
    // 添加时间
    "date": "2020-10-27",
    // 语音出处
    "mark": {
      "title": "“恐怖”游戏PIEN初见！",
      "time": "15:24~15:29",
      "url": "https://www.bilibili.com/video/BV1Ga4y1E74H"
    }
  }
]

添加usePicture字段可以添加鼠标悬浮时显示的图片(请放到public/voices/img目录)

参与网页开发

本项目使用Vue3.0进行开发，使用yarn进行包管理 要部署本地开发环境，请先安装较新版的Node

  1. Fork并Clone代码到本地
  2. 进入代码目录，运行yarn以安装依赖项目
  3. 开启本地开发服务器，运行yarn serve，这将会在localhost:8080启动，在代码修改过程中，本地开发服务器可以即时反映修改的结果
  4. 要编译可供部署的文件，请运行yarn build，这将会在dist目录下生成可以直接部署到静态网站托管(GitHub Pages等)或服务器的文件

使用模板

注意： 本项目已基本停止更新，不推荐直接当作模板使用，请使用其它方式

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

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

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

LICENSE

若使用了本项目为范本开发项目或使用了项目代码请在明显位置声明原作者(https://github.com/blacktunes) 以及本仓库(https://github.com/blacktunes/kaguranana-button).