# no.js

**Repository Path**: nofree5th/no.js

## Basic Information

- **Project Name**: no.js
- **Description**: 给AI看的微信小游戏开发指南
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 2
- **Created**: 2025-12-14
- **Last Updated**: 2026-02-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# No.js

给AI看的微信小游戏开发指南

## 核心目标
- 帮助普通创作者（非游戏程序员甚至非程序员）使用CodeBuddy开发微信小游戏
- **目标游戏类型：轻量级休闲游戏**
- 通过架构约束和设计原则，让 AI 生成：
  - ✅ 可维护的代码
  - ✅ 尽可能保证高性能
  - ✅ 符合微信小游戏规范
  - ✅ **尽量不依赖自建服务端**（优先使用微信小游戏开放能力）

## 快速开始

### 给 AI
**从 [`docs/index.md`](./docs/index.md) 开始。**

### 示例项目

**所有示例的完整提示词都保存在 `UserPrompts.txt` 文件中，可直接参考使用。**

- **[examples/triangle](./examples/triangle)** - 2D 项目示例：一个旋转的三角形
  - 技术栈：Pixi.js
  - 展示基础 2D 渲染和动画
  
- **[examples/three.js](./examples/three.js)** - 3D 项目示例：一个旋转的魔方
  - 技术栈：Three.js
  - 展示基础 3D 场景和交互

### 给微信小游戏创作者

**方式一：使用 CLI 工具（推荐）**

1. 克隆并安装 no.js
   ```bash
   git clone --depth=1 --recurse-submodules --shallow-submodules https://gitee.com/nofree5th/no.js.git
   cd no.js
   npm install
   npm link  # 全局安装 CLI 工具
   ```

2. 创建新项目
   ```bash
   nojs create game my-game
   cd my-game
   npm install
   ```

3. 用 CodeBuddy 打开项目，开始开发
   > 规则已自动配置，直接用 Craft 模式描述游戏想法即可

**方式二：手动配置**

**前置准备：安装 CodeBuddy**
- 下载地址：https://copilot.tencent.com/ide/
- 建议使用独立IDE版本
- 模型选择：可以多尝试，目前阶段不一定某个模型在所有领域都超越其他模型
- 模式选择：Craft
- 开启：Plan Mode（执行计划）

**开始使用：**
1. 克隆 no.js 到本地
   ```bash
   git clone --depth=1 --recurse-submodules --shallow-submodules https://gitee.com/nofree5th/no.js.git
   ```

2. 建议的项目目录结构：
   ```
   {your_project}/
   ├── .codebuddy/
   │   └── rules/
   │       └── wechat-minigame-dev-rule.mdc
   └── (你的游戏项目文件)
   
   no.js/
   └── (克隆的 no.js 目录)
   ```

3. 配置 CodeBuddy 规则：
   打开你的项目目录（默认应该为空目录），右上角设置-规则-创建规则
   规则名称： wechat-minigame-dev-rule
   规则类型：总是
   规则内容：必须遵守no.js规范（/path/to/no.js目录下的docs/index.md文件为规范的入口文件)
   或者直接在 `{your_project}/.codebuddy/rules/wechat-minigame-dev-rule.mdc` 中添加：
    ```markdown
    ---
    description: 微信小游戏开发指南
    alwaysApply: true
    enabled: true
    updatedAt: 
    provider: no.js
    ---

    必须遵守no.js规范（/path/to/no.js目录下的docs/index.md文件为规范的入口文件)
    ```
   > 将 `/path/to/no.js` 替换为实际的 no.js 本地路径

4. 用自然语言描述游戏想法，让CodeBuddy帮你实现吧
   > CodeBuddy切换到Craft模式，开始与AI的协作之旅

### 给本项目贡献者
1. 遵守核心理念：代码不重要，思想更重要
2. 文档的表达关注本质，保持简洁
> 可以让AI辅助优化描述、结构，但不要让AI扩写。已经内化到AI模型的知识不要再提细节
3. 避免浪费AI token：尽量通过多级索引的方式渐进式表达

## 致谢

本项目与 [CodeBuddy](https://copilot.tencent.com/ide/) 协作完成。

## 许可证
MIT