Skip to content

Latest commit

 

History

History
132 lines (106 loc) · 5.52 KB

CONTRIBUTING.md

File metadata and controls

132 lines (106 loc) · 5.52 KB
Raw

欢迎来到贡献手册

感谢您投入时间为 NESBox 做出贡献！您所做的任何贡献都将永久在 NESBox 留下足迹。

不编写代码

  • 优化 NESBox 的翻译
  • 进行更好的 UI/UX 设计（原型 1、原型 2）
  • 修正游戏的截图、介绍等信息（点击游戏详情页面中的编辑按钮）
  • 为 NESBox 添加游戏

贡献代码

想要贡献代码，请先了解 NESBox 项目。

NESBox 技术栈：

  • 前端使用 gemjs，它基于 WebComponents，大量使用 TypeScript 装饰器和 ES Classes 语法进行开发，可以参考文档
  • 后端使用 Juniper 构建 GraphQL 服务
  • 数据库 ORM 使用 Diesel

目录结构

packages
├── arcade                    实现 NESBox 接口的街机模拟器
├── config                    共享配置
├── e2e                       端到端自动化测试
├── ecs                       简单 JS ECS 框架
├── flutter_app               Android/iOS App
├── mt-app                    Android/iOS App 和 flutter_app 交互层
├── nes
│   ├── src                   定义 NESBox 接口，实现 NESBox 接口的 NES 模拟器
│   ├── utils                 用于开发实现 NESBox 接口的 WASM 游戏
│   └── utils_macro           utils 中用到的宏
├── nes-pkg                   从 `nes` 构建自动生成的 ES 模块
├── sandbox                   运行 JavaScript 游戏的沙箱，实现了 NESBox 接口
├── server                    NESBox GraphQL API
│   ├── migrations            数据库 SQL
│   └── src
│       ├── auth.rs           用户认证
│       ├── db                DB 连接和 Model 定义
│       ├── error.rs          自定义错误
│       ├── github.rs         通过 Github Issue 管理 NESBox 游戏
│       ├── handles.rs        Actix-web 路由处理
│       ├── main.rs
│       ├── schemas           数据库 CURD
│       └── voice             游戏语音服务
├── tauriapp                  NESBox 桌面端
│   ├── src
│   │   ├── handler.rs        用于 Web 端调用的接口，比如设置徽标
│   │   ├── main.rs
│   │   ├── preload.rs        注入 js
│   │   └── window_ext.rs     窗口自定义
│   └─ ...
├── wasm4                     实现 NESBox 接口的 WASM4 运行时
├── webapp                    Web, Desktop, Android/iOS 端都使用此包
│   ├── src
│   │   ├── elements          业务无关的自定义元素
│   │   ├── generated         GraphQL 自动生成的代码
│   │   ├── i18n              各模块的 i18n 定义
│   │   ├── images            项目中用到的 SVG 图片
│   │   ├── locales           各模块语言包
│   │   ├── modules           业务相关的自定义元素
│   │   ├── netplay           游戏连接 WebRTC 连接
│   │   ├── pages             页面元素
│   │   ├── services          GraphQL APIs
│   │   ├── shaders           游戏画面滤镜
│   │   ├── utils             共用的一些函数
│   │   ├── app.ts            NESBox Web 端根元素
│   │   ├── auth.ts
│   │   ├── configure.ts
│   │   ├── constants.ts
│   │   ├── drop.ts           接收用户拖放的 `.nes` 文件
│   │   ├── enums.ts
│   │   ├── gamepad.ts        手柄监听和模拟
│   │   ├── icons.ts          使用的图标集，使用 Material Symbol
│   │   ├── index.html
│   │   ├── index.ts
│   │   ├── logger.ts
│   │   ├── mt-app.ts         NESBox Android/iOS 端根元素
│   │   ├── routes.ts
│   │   ├── store.ts          用户的 NESBox 数据，会储存在 LocalStorage
│   │   ├── theme.ts
│   │   └── tours.ts          新手游戏指引
│   └─ ...
├── toolbox                   自制 JS/Rust 游戏静态资源工具箱
└── zombie                    网上爬取数据和下载图片用到的脚本

本地开发

准备环境（都是可选，取决于要对那部分进行开发调试）：

  • Node
  • Rust
  • Flutter

拉取代码：

git clone --recurse-submodules https://github.com/mantou132/nesbox.git

调试 API

查看 README

调试 Web

yarn
yarn --cwd packages/webapp start

调试 Tauri

查看 README

调试 Flutter

查看 README

调试 NES 模拟器

cargo watch -w packages/nes -w deps/tetanes -s "yarn run build:nes"

对您感兴趣的地方进行改进，然后提交 PR，感谢您的贡献。