# small-game-sdk

> ## 上线流程（功能分支、集成分支或 xx 分支测试通过后）

Latest version **1.0.0** (published 2020-09-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install small-game-sdk
pnpm add small-game-sdk
yarn add small-game-sdk
bun add small-game-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-09-01 |
| First published | 2020-09-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | liqian0411 |

## Links

- npm: https://www.npmjs.com/package/small-game-sdk
- npm.io page: https://npm.io/package/small-game-sdk

## Dependencies (2)

- [crypto-js](https://npm.io/package/crypto-js.md) ^4.0.0
- [bili-small-game-framework](https://npm.io/package/bili-small-game-framework.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2020-09-01

## README

# Small Game SDK

## 上线流程（功能分支、集成分支或 xx 分支测试通过后）

1. 相关分支合入 master
2. 重要！！！ 打开 small-game-sdk 项目，确保 node_modules 中 bili-small-game-framework 中依赖文件中代码与 small-app 项目中 game/master 分支一致 (可以手动替换或者自己脚本等)（如果 small-app 项目中有相应改动，需要将相应分支合入 game/master）
3. Small-game-sdk 项目内 npm run build
4. 打开 small-game 项目（此项目专门用来发布小游戏框架），将 lib 文件夹内文件全部替换为刚刚构建出来的 dist 文件内的文件。并修改 package.json 中版本号。commit 信息写清楚完整
5. npm login => npm publish
6. 过个 10 分钟左右通知 qa 回归
7. qa 回归完通知 cp

## 小游戏 sdk

-   基于`bili-small-game-framework`的`bl api`在小游戏框架下的扩展
-   实现小游戏`webview`方案中的`shell.game.html`、`subContext.html`
-   实现小游戏`jsCore Binding`方案的`shell.game.js`、`adapter.*.js`
-   实现三大引擎对应的`weapp-adapter.js`修改

## 文件结构

```
    src
     ├─ adapter  # adapter.*.js
     ├─ blapp-adapter-cocos  # blapp-adapter for cocos2d
     ├─ blapp-adapter-egret  # blapp-adapter for egret
     ├─ blapp-adapter-laya  # blapp-adapter for laya
     ├─ entries  # 构建入口
     │     ├─ native  # Native引擎入口
     │     │     ├─ mainContext  # 主域入口
     │     │     └─ subContext  # 开放域入口
     │     └─ webview  # webview引擎入口
     │           ├─ mainContext  # 主域入口
     │           └─ subContext  # 开放域入口
     ├─ lib  # bl api的实现目录
     ├─ adapter.game.js  # 这个没用
     ├─ shell.game.html  # 主域html页面模板
     └─ subContext.html  # 开放域html模板
```

## 小游戏引擎

小游戏在代码经过`gulp`构建后文件夹结构应该为：

```
    ┌─ _base
    │     ├─ adapter.android.js
    │     ├─ adapter.android.opendata.js
    │     ├─ adapter.ios.js
    │     ├─ adapter.ios.opendata.js
    │     ├─ shell.game.js
    │     └─ shell.opendata.game.js
    ├─ game.js
    ├─ game.json
    ├─ 其他游戏依赖文件
    ├─ shell.game.html
    └─ subContext.html
```

### Native

相关依赖：

-   `adapter/adapter.*.js`：将 Native 层实现的 API 转换为 JS 层，其中实现了部分`bl api`
-   `entries/native/*`：Native 引擎用入口，用于构建`shell.game.js`和`shell.game.opendata.js`

### Webview

相关依赖：

-   `entries/webview/*`：Webview 引擎用入口，用于构建`shell.game.html`和`subContext.html`中的 js 部分
-   `shell.game.html`和`subContext.html`：Webview 引擎壳

---
_Source: https://npm.io/package/small-game-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
