# mishiro

**Repository Path**: toyobayashi/mishiro

## Basic Information

- **Project Name**: mishiro
- **Description**: CGSS Windows desktop application
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2018-03-16
- **Last Updated**: 2021-01-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mishiro

## 下载

* [从 Github 下载](https://github.com/toyobayashi/mishiro/releases)  
<!-- * [从码云下载（中国大陆地区推荐，由于众所周知的原因 Github 上可能无法下载）](https://gitee.com/toyobayashi/mishiro/releases)   -->

注意：

* 不推荐将 mishiro 安装或解压在包含汉字的路径下，可能会出现一些问题。
<!-- * 由于我没有 mac 电脑，所以很抱歉 mac 用户请参照请按照下面的步骤和[Electron分发应用](http://electronjs.org/docs/tutorial/application-distribution)自行编译打包。 -->

## 特性

* 语言支持：中文 / 日本語 / English
* [ HOME ] 拿资源。(unity3d, acb, bdb, mdb)
* [ IDOL ] 查卡，拿卡面，拿角色语音。
* [ COMMU ] 查P。
* [ LIVE ] 拿背景音乐 / Live乐曲，谱面演示。
* [ MENU ] 活动算分，设置等

谱面查看演示：[https://toyobayashi.github.io/mishiro-score-viewer/](https://toyobayashi.github.io/mishiro-score-viewer/)  
仓库：[mishiro-score-viewer](https://github.com/toyobayashi/mishiro-score-viewer)

## 开发 & 构建

### Windows 需要

* __Windows 7 以上__
* __Node.js 12+__
* __Python 2.7__ （`node-gyp` 现在不支持 3.x ）
* __Visual Studio 2015/2017/2019 并安装`使用 C++ 的桌面开发`工作负载或 `VC++ v140+ 构建工具集`__
* __.NET 和 Powershell__ （Windows 10 有自带）

### Linux 需要

* __Node.js 12+__
* __Python 2.7__
* __gcc & g++__
* __make__
* __zip & unzip__

### MacOS 需要  （这部分未测试）

* __Node.js 12+__
* __Python 2.7__
* __Xcode__ （终端运行 ```xcode-select --install``` 安装Command Line Tools）

### 快速开始

1. 拉代码 / 更新代码  

    ``` bash 
    $ git clone https://github.com/toyobayashi/mishiro.git

    $ git pull
    ```

    **NOTE:** 由于 C++ 原生模块编译必须匹配对应的 Electron / Node.js 版本，每当 `package.json` 内的 `electron` 版本变化时，请手动删除以下的文件夹然后再重新跑一次 `npm install`。

    * `/app/node_modules/mishiro-core`
    * `/app/node_modules/sqlite3`
    * `/app/node_modules/hca-decoder`

    也可以直接跑 `npm run rm` 来完成。

2. 装依赖  

    mishiro 依赖了一些 C++ 原生模块，在 `npm install` 的时候这些 C++ 包的代码会被编译，所以请确保本地配置好了 C++ 的编译环境，否则 `npm install` 会失败。  

    * Windows

        ``` bat
        > cd mishiro/app

        REM 设置国内镜像
        > npm config set registry http://registry.npm.taobao.org/
        > npm config set electron_mirror https://npm.taobao.org/mirrors/electron/

        REM 特别的，如果安装的 VC++ 构建工具集版本不是 v140 (VS 2015)
        REM 需要全局设置一下 toolset 变量让 sqlite3 能够编译通过
        > npm config set toolset v142

        REM 安装 node-gyp@5
        > npm install -g node-gyp

        REM 这一步很重要，把 npm 内部使用的 node-gyp 设置成全局安装的 node-gyp
        REM 新版 node-gyp 的头文件缓存位置和老版本不一样，没有这一步安装原生模块依赖时可能会报找不到头文件的错
        > for /f "delims=" %P in ('npm prefix -g') do npm config set node_gyp "%P\node_modules\node-gyp\bin\node-gyp.js"

        REM 根据 package.json 中指定的 electron 版本下载对应的头文件
        > for /f "delims=" %P in ('node -p "require('./package.json').devDependencies.electron"') do node-gyp install --target=%P --dist-url=https://npm.taobao.org/mirrors/atom-shell

        REM 安装依赖
        > npm install
        REM 获取开发所需要的额外的资源
        > npm run get
        ```

    * Linux / MacOS

        ``` bash
        $ cd mishiro/app

        $ npm config set registry http://registry.npm.taobao.org/
        $ npm config set electron_mirror https://npm.taobao.org/mirrors/electron/

        $ npm install -g node-gyp
        $ npm config set node_gyp "`npm prefix -g`/lib/node_modules/node-gyp/bin/node-gyp.js"
        $ node-gyp install --target=$(node -p require\(\'./package.json\'\).devDependencies.electron) --dist-url=https://npm.taobao.org/mirrors/atom-shell

        $ npm install
        $ npm run get # 获取开发所需要的额外的资源
        ```

    如果 `npm install` 失败，请检查下面几种情况：

    1. 是否有 C++ 编译环境（VC++ / g++）
    2. electron 头文件版本及其存放的位置是否正确
    3. 网络环境和 npm 镜像

* 开发

    推荐使用 VSCode
    
    ``` bash
    # ~/mishiro/app$ code .
    $ npm run dev

    # 或者
    $ npm run serve
    # 然后通过 VSCode 的调试模式启动
    ```

    如果启动时弹框报错，请检查原生模块是否编译成功以及 electron 头文件的版本是否正确。

* 构建  

    ``` bash
    # 打包生产环境代码
    $ npm run build
    ```

* 启动  

    ``` bash
    # 生产环境启动
    $ npm start
    ```

* 打包

    ``` bash
    $ npm run pack:x64 # x64 
    $ npm run pack:ia32 # Windows x86
    ```

## 参考
特别感谢：     
* [デレステ解析ノート](https://subdiox.github.io/deresute/)
* [subdiox/UnityLz4](https://github.com/subdiox/UnityLz4)
* [subdiox/StarlightTool](https://github.com/subdiox/StarlightTool)
* [Nyagamon/HCADecoder](https://github.com/Nyagamon/HCADecoder)
* [marcan/deresuteme](https://github.com/marcan/deresuteme)
* [summertriangle-dev/sparklebox](https://github.com/summertriangle-dev/sparklebox)
* [superk589/DereGuide](https://github.com/superk589/DereGuide)
* [OpenCGSS/DereTore](https://github.com/OpenCGSS/DereTore)

## 版权
CGSS及其相关所有内容的版权归[BANDAI NAMCO Entertainment Inc.](https://bandainamcoent.co.jp/)所属。