Here is the translated content of the `README.md` file:
```markdown
# Vibe Coding Guide
**The ultimate workstation to turn ideas into reality through AI pair programming**
---
[๐ Tools & Resources](#-ๅจ-ๅทฅๅ ทไธ่ตๆบ)
[๐ Get Started](#-ไป้ถๅผๅง)
[๐ฏ Original Repo Translation](#-ๅไปๅบ็ฟป่ฏ)
[โ๏ธ Full Setup Process](#๏ธ-ๅฎๆด่ฎพ็ฝฎๆต็จ)
[๐ Contact Info](#-่็ณปๆนๅผ)
[โจ Support Project](#-ๆฏๆ้กน็ฎ)
[๐ค Contribute](#-ๅไธ่ดก็ฎ)
AI interpretation link for this repository: [zread.ai/tukuaiai/vibe-coding-cn](https://zread.ai/tukuaiai/vibe-coding-cn/1-overview)
## ๐ฒ Foreword
**This is a constantly growing and self-negating project. All current experience and capabilities may become meaningless due to the evolution of AI capabilities. Therefore, please always maintain an AI-first mindset, do not be complacent, all experience may become invalid, view it dialectically๐๐๐**
---
โก 5 Minute Quickstart
## โก 5 Minute Quickstart
> Already have an internet and development environment? Start Vibe Coding directly!
**Step 1**: Copy the prompt below and paste it into [Claude](https://claude.ai/) or [ChatGPT](https://chatgpt.com/)
```
You are a professional AI programming assistant. I want to develop a project using Vibe Coding.
Please ask me first:
1. What project do you want to work on? (Describe in one sentence)
2. What programming languages are you familiar with? (No worries if you're not familiar)
3. What is your operating system?
Then help me:
1. Recommend the simplest tech stack
2. Generate the project structure
3. Guide me step-by-step through the development
Requirement: After each step is completed, ask me if it was successful before continuing to the next step.
```
**Step 2**: Follow the AI's guidance to turn your ideas into reality ๐
**It's that simple!** For more advanced content, continue reading ๐
---
## ๐ Get Started
Completely new? Follow these steps in order:
0. [00-Vibe Coding Philosophical Principles](./i18n/zh/documents/01-ๅ ฅ้จๆๅ/00-Vibe%20Coding%20ๅฒๅญฆๅ็.md) - Understand the core concepts
1. [01-Network Environment Configuration](./i18n/zh/documents/01-ๅ ฅ้จๆๅ/01-็ฝ็ป็ฏๅข้ ็ฝฎ.md) - Configure network access
2. [02-Development Environment Setup](./i18n/zh/documents/01-ๅ ฅ้จๆๅ/02-ๅผๅ็ฏๅขๆญๅปบ.md) - Copy the prompt to AI and let AI guide you through setting up the environment
3. [03-IDE Configuration](./i18n/zh/documents/01-ๅ ฅ้จๆๅ/03-IDE้ ็ฝฎ.md) - Configure VS Code editor
---
๐งฌ Glue Coding
> **The Holy Grail and Silver Bullet of Software Engineering**
Glue coding is the ultimate evolved form of Vibe Coding, potentially perfectly solving three fatal flaws:
| Problem | Solution |
|:---|:---|
| ๐ญ AI Hallucinations | โ Only use validated mature code, zero hallucinations |
| ๐งฉ Complexity Explosion | โ Each module is a battle-tested wheel |
| ๐ High Barrier to Entry | โ You only need to describe the "connection method" |
**Core Concept**: Copy, don't write. Connect, don't build. Reuse, don't originate.
๐ [Learn more about Glue Coding](./i18n/zh/documents/00-ๅบ็กๆๅ/่ถๆฐด็ผ็จ.md)
---
## ๐ผ๏ธ Overview
**Vibe Coding** is the ultimate AI pair programming workflow designed to help developers smoothly turn ideas into reality. This guide details the entire process from project conception, tech stack selection, implementation planning to specific development, debugging, and expansion, emphasizing **plan-driven** and **modularization** as the core to prevent AI from losing control and causing project chaos.
> **Core Concept**: *Planning is everything.* Be cautious about letting AI plan autonomously, otherwise your codebase will turn into an unmanageable mess.
**Note**: The experiences shared below are not universally applicable. Please integrate them dialectically with specific scenarios in your practice.
๐ Meta-Methodology
The core of this idea is to build an AI system capable of **self-optimization**. Its recursive nature can be broken down into the following steps:
> Further reading: [A Formalization of Recursive Self-Optimizing Generative Systems](./i18n/zh/documents/00-ๅบ็กๆๅ/A%20Formalization%20of%20Recursive%20Self-Optimizing%20Generative%20Systems.md)
#### 1. Define Core Roles:
* **ฮฑ-Prompt (Generator)**: A "mother" prompt whose sole responsibility is to **generate** other prompts or skills.
* **ฮฉ-Prompt (Optimizer)**: Another "mother" prompt whose sole responsibility is to **optimize** other prompts or skills.
#### 2. Describe the Recursive Lifecycle:
1. **Bootstrap**:
* Use AI to generate initial versions (v1) of `ฮฑ-Prompt` and `ฮฉ-Prompt`.
2. **Self-Correction & Evolution**:
* Use `ฮฉ-Prompt (v1)` to **optimize** `ฮฑ-Prompt (v1)`, resulting in a more powerful `ฮฑ-Prompt (v2)`.
3. **Generation**:
* Use the **evolved** `ฮฑ-Prompt (v2)` to generate all required target prompts and skills.
4. **Recursive Loop**:
* Feed the newly generated, more powerful artifacts (including new versions of `ฮฉ-Prompt`) back into the system, restarting the continuous evolution to optimize `ฮฑ-Prompt`.
#### 3. Ultimate Goal:
Through this continuous **recursive optimization loop**, the system achieves **self-transcendence** in each iteration, infinitely approaching the preset **desired state**.
๐งญ Methodology Essentials (Dao ยท Fa ยท Shu)
## ๐งญ Dao (The Way)
* **If AI can do it, don't do it manually**
* **Ask AI about everything**
* **Purpose-driven: All actions in the development process revolve around the "purpose"**
* **Context is the first principle of vibe coding; garbage in, garbage out**
* **Systematic thinking, entities, links, functions/purposes, three dimensions**
* **Data and functions are everything in programming**
* **Input, process, output describe the entire process**
* **Ask AI "what?", "why?", "how to do it?" (Golden Circle Rule)**
* **Structure first, then code. Always plan the framework well, otherwise you'll be endlessly paying technical debt**
* **Occam's Razor, don't add code if unnecessary**
* **Pareto Principle, focus on the important 20%**
* **Reverse thinking, first clarify your requirements, then build code backward from requirements**
* **Repeat, try multiple times. If it still doesn't work, open a new window.**
* **Focus, extreme focus can penetrate code. Do one thing at a time (except for divine beings)**
## ๐งฉ Fa (The Method)
* **One-sentence goal + non-goals**
* **Orthogonality (context-dependent)**
* **Copy, don't write. Don't reinvent the wheel. First ask AI if there's a suitable repository, download and modify it (a new paradigm for glue coding)**
* **Always read the official documentation. First scrape the official documentation and feed it to AI (let AI find tools to download locally)**
* **Decompose modules by responsibility**
* **Interface first, implementation later**
* **Modify only one module at a time**
* **Documentation is context, not an afterthought**
## ๐ ๏ธ Shu (The Technique)
* Clearly state: **what can be modified, what cannot be modified**
* For Debugging, only provide: **expected vs actual + minimal reproduction**
* Testing can be handed over to AI, **assertions are human-reviewed**
* When there's too much code, **switch sessions**
* **Consolidate AI-made errors into persistent experience using prompts. If a problem remains unsolved, let AI retrieve this collection of problems and find a solution.**
๐ Tools & Resources
## ๐ Tools & Resources
### Integrated Development Environment (IDE) & Terminal
* [**Visual Studio Code**](https://code.visualstudio.com/): A powerful integrated development environment, suitable for code reading and manual modifications. Its `Local History` plugin is particularly convenient for project version management.
* **Virtual Environment (.venv)**: Highly recommended, allows one-click configuration and isolation of project environments, especially suitable for Python development.
* [**Cursor**](https://cursor.com/): Has captured users' minds and is widely known.
* [**Warp**](https://www.warp.dev/): A modern terminal integrated with AI features, which can effectively improve the efficiency of command-line operations and error troubleshooting.
* [**Neovim (nvim)**](https://github.com/neovim/neovim): A high-performance modern Vim editor with a rich plugin ecosystem, the first choice for keyboard-driven developers.
* [**LazyVim**](https://github.com/LazyVim/LazyVim): A Neovim configuration framework that comes with a full suite of features such as LSP, code completion, and debugging, achieving a balance between out-of-the-box usability and deep customization.
### AI Models & Services
* [**Claude Opus 4.5**](https://claude.ai/new): A powerful AI model, providing services through platforms like Claude Code, and supporting CLI and IDE plugins.
* [**gpt-5.1-codex.1-codex (xhigh)**](https://chatgpt.com/codex/): An AI model suitable for handling large projects and complex logic, available through platforms like Codex CLI.
* [**Droid**](https://factory.ai/news/terminal-bench): Provides CLI access to various models including Claude Opus 4.5.
* [**Kiro**](https://kiro.dev/): Currently provides free Claude Opus 4.5 model access and offers client and CLI tools.
* [**Gemini CLI**](https://geminicli.com/): Provides free access to the Gemini model, suitable for executing scripts, organizing documents, and exploring ideas.
* [**antigravity**](https://antigravity.google/): Currently a free AI service provided by Google, supporting Claude Opus 4.5 and Gemini 3.0 Pro.
* [**AI Studio**](https://aistudio.google.com/prompts/new_chat): A free service provided by Google, supporting Gemini 3.0 Pro and Nano Banana.
* [**Gemini Enterprise**](https://cloud.google.com/gemini-enterprise): Google AI service for enterprise users, currently free to use.
* [**GitHub Copilot**](https://github.com/copilot): An AI code completion tool developed jointly by GitHub and OpenAI.
* [**Kimi K2**](https://www.kimi.com/): A domestic AI model suitable for various general tasks.
* [**GLM**](https://bigmodel.cn/): A domestic large language model developed by Zhipu AI.
* [**Qwen**](https://qwenlm.github.io/qwen-code-docs/zh/cli/): An AI model developed by Alibaba, its CLI tool offers free usage quota.
### Development & Auxiliary Tools
* [**Augment**](https://app.augmentcode.com/): Provides powerful context engine and prompt optimization features.
* [**Windsurf**](https://windsurf.com/): An AI development tool offering free credits for new users.
* [**Ollama**](https://ollama.com/): A local large model management tool, allowing convenient pulling and running of open-source models via the command line.
* [**Mermaid Chart**](https://www.mermaidchart.com/): Used to convert text descriptions into architectural diagrams, sequence diagrams, and other visual charts.
* [**NotebookLM**](https://notebooklm.google.com/): A tool for AI to interpret materials, audio, and generate mind maps.
* [**Zread**](https://zread.ai/): An AI-driven GitHub repository reading tool that helps quickly understand project code.
* [**tmux**](https://github.com/tmux/tmux): A powerful terminal multiplexer, supporting session persistence, split panes, and background tasks, ideal for server and multi-project development.
* [**DBeaver**](https://dbeaver.io/): A universal database management client, supporting various databases with comprehensive features.
### Resources & Templates
* [**Prompt Library (Online Table)**](https://docs.google.com/spreadsheets/d/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=2093180351#gid=2093180351&range=A1): An online table containing a large number of ready-to-use prompts of various types.
* [**Third-party System Prompt Learning Library**](https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools): For learning and referencing system prompts of other AI tools.
* [**Skills Creator**](https://github.com/yusufkaraaslan/Skill_Seekers): A tool that can generate customized Skills according to demand.
* [**Meta Prompts**](https://docs.google.com/spreadsheets/d/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=1770874220#gid=1770874220): Advanced prompts for generating prompts.
* [**General Project Architecture Template**](./i18n/zh/documents/00-ๅบ็กๆๅ/้็จ้กน็ฎๆถๆๆจกๆฟ.md): Can be used to quickly set up standardized project directory structures.
* [**Meta-Skill: Skills of Skills**](./i18n/zh/skills/00-ๅ ๆ่ฝ/claude-skills/SKILL.md): Meta-skill for generating Skills.
* [**tmux Shortcut Cheatsheet**](./i18n/zh/documents/02-ๆนๆณ่ฎบ/tmuxๅฟซๆท้ฎๅคงๅ จ.md): tmux shortcut reference document.
* [**LazyVim Shortcut Cheatsheet**](./i18n/zh/documents/02-ๆนๆณ่ฎบ/LazyVimๅฟซๆท้ฎๅคงๅ จ.md): LazyVim shortcut reference document.
* [**Mobile Remote Vibe Coding**](./i18n/zh/documents/02-ๆนๆณ่ฎบ/ๅ ณไบๆๆบsshไปปๆไฝ็ฝฎ้พๆฅๆฌๅฐ่ฎก็ฎๆบ๏ผๅบไบfrpๅฎ็ฐ็ๆนๆณ.md): Achieve mobile SSH remote control of local computers for Vibe Coding based on frp.
### External Tutorials & Resources
* [**Brother Er's Java Advanced Path**](https://javabetter.cn/): Contains detailed configuration tutorials for various development tools.
* [**Virtual Card**](https://www.bybit.com/cards/?ref=YDGAVPN&source=applet_invite): Can be used to register cloud services and other international payment scenarios.
### Community & Communication
* [**Telegram Chat Group**](https://t.me/glue_coding): Vibe Coding Chinese communication group
* [**Telegram Channel**](https://t.me/tradecat_ai_channel): Project updates and information
### Internal Project Documentation
* [**Glue Coding**](./i18n/zh/documents/00-ๅบ็กๆๅ/่ถๆฐด็ผ็จ.md): The holy grail and silver bullet of software engineering, the ultimate evolution of Vibe Coding.
* [**Chat Vault**](./libs/external/chat-vault/README_CN.md): AI chat log saving tool, supporting Codex/Kiro/Gemini/Claude CLI.
* [**prompts-library Tool Description**](./libs/external/prompts-library/README_CN.md): Supports Excel and Markdown format conversion, including hundreds of curated prompts.
* [**Programming Prompts Collection**](./i18n/zh/prompts/02-็ผ็จๆ็คบ่ฏ/): Dedicated prompts for the Vibe Coding process.
* [**System Prompt Construction Principles**](./i18n/zh/documents/00-ๅบ็กๆๅ/็ณป็ปๆ็คบ่ฏๆๅปบๅๅ.md): Comprehensive guide to building efficient AI system prompts.
* [**Development Experience Summary**](./i18n/zh/documents/00-ๅบ็กๆๅ/ๅผๅ็ป้ช.md): Variable naming, file structure, coding standards, architectural principles, etc.
* [**General Project Architecture Template**](./i18n/zh/documents/00-ๅบ็กๆๅ/้็จ้กน็ฎๆถๆๆจกๆฟ.md): Standard directory structures for various project types.
* [**Augment MCP Configuration Document**](./i18n/zh/documents/02-ๆนๆณ่ฎบ/auggie-mcp้ ็ฝฎๆๆกฃ.md): Augment context engine configuration instructions.
* [**System Prompts Collection**](./i18n/zh/prompts/01-็ณป็ปๆ็คบ่ฏ/): System prompts for AI development, including multi-version development specifications.
* [**External Resources Aggregation**](./i18n/zh/documents/04-่ตๆบ/ๅค้จ่ตๆบ่ๅ.md): Curated GitHub repositories, AI tool platforms, prompt resources, and top bloggers.
---
Encoding Model Performance Grading Reference
## Encoding Model Performance Grading Reference
It is recommended to only choose top-tier models for complex tasks to ensure optimal results and efficiency.
* **Tier 1**: `codex-5.1-max-xhigh`, `claude-opus-4.5-xhigh`, `gpt-5.2-xhigh`
* **Tier 2**: `claude-sonnet-4.5`, `kimi-k2-thinking`, `minimax-m2`, `glm-4.6`, `gemini-3.0-pro`, `gemini-2.5-pro`
* **Tier 3**: `qwen3`, `SWE`, `grok4`
---
Project Directory Structure Overview
### Project Directory Structure Overview
The core structure of this project `vibe-coding-cn` mainly revolves around knowledge management, AI prompt organization, and automation. Below is a simplified directory tree and descriptions of each part:
```
.
โโโ CODE_OF_CONDUCT.md # Community code of conduct, regulating contributor behavior.
โโโ CONTRIBUTING.md # Contribution guide, explaining how to contribute to this project.
โโโ GEMINI.md # AI assistant context document, including project overview, tech stack, and file structure.
โโโ LICENSE # Open source license file.
โโโ Makefile # Project automation scripts for code checking, building, etc.
โโโ README.md # Main project document, including project overview, usage guide, resource links, etc.
โโโ .gitignore # Git ignore file.
โโโ AGENTS.md # AI agent-related documents or configurations.
โโโ CLAUDE.md # Core behavior rules or configurations for the AI assistant.
โ
โโโ i18n/zh/documents/ # Stores various explanatory documents, experience summaries, and detailed configuration instructions.
โ โโโ 00-ๅบ็กๆๅ/ # Methodologies and principles
โ โโโ 04-่ตๆบ/ # Templates and resources
โ โโโ 02-ๆนๆณ่ฎบ/ # Tutorials and guides
โ
โโโ libs/ # Generic library code for project internal modularization.
โ โโโ common/ # Common functional modules.
โ โ โโโ models/ # Model definitions.
โ โ โ โโโ __init__.py
โ โ โโโ utils/ # Utility functions.
โ โ โโโ backups/ # Internal backup tools.
โ โโโ database/ # Database related modules.
โ โ โโโ .gitkeep # Placeholder file to ensure the directory is tracked by Git.
โ โโโ external/ # External integration modules.
โ โโโ my-nvim/ # User's Neovim configuration.
โ โโโ prompts-library/ # Prompt library management tool (Excel-Markdown conversion).
โ โ โโโ main.py # Main entry point for the prompt library management tool.
โ โ โโโ scripts/ # Contains Excel and Markdown conversion scripts and configurations.
โ โ โโโ prompt_excel/ # Stores raw prompt data in Excel format.
โ โ โโโ prompt_docs/ # Stores Markdown prompt documents converted from Excel.
โ โ โโโ ... (other prompts-library internal files)
โ โโโ XHS-image-to-PDF-conversion/ # Xiaohongshu image to PDF conversion tool.
โ
โโโ i18n/zh/prompts/ # Centralized storage for all types of AI prompts.
โ โโโ 00-ๅ ๆ็คบ่ฏ/ # Advanced prompts for generating prompts.
โ โโโ 01-็ณป็ปๆ็คบ่ฏ/ # AI system-level prompts, used to set AI behavior and framework.
โ โ โโโ ... (other system prompts)
โ โ
โ โโโ 02-็ผ็จๆ็คบ่ฏ/ # Prompt collection specifically for programming and code generation.
โ โ โโโ ... (specific programming prompt files)
โ โ
โ โโโ 03-็จๆทๆ็คบ่ฏ/ # User-defined or commonly used prompts.
โ โโโ ASCIIๅพ็ๆ.md # ASCII art generation prompt.
โ โโโ ๆฐๆฎ็ฎก้.md # Data pipeline processing prompt.
โ โโโ ... (other user prompts)
โ
โโโ i18n/zh/skills/ # Centralized storage for all types of skills.
โโโ 00-ๅ ๆ่ฝ/ # Meta-skills directory
โ โโโ claude-skills/ # Meta-SKILL for generating SKILLS
โโโ 01-AIๅทฅๅ ท/ # AI CLI and tools
โ โโโ headless-cli/ # Headless mode AI CLI calls
โโโ 02-ๆฐๆฎๅบ/ # Database skills
โโโ 03-ๅ ๅฏ่ดงๅธ/ # Cryptocurrency/quantitative trading
โโโ 04-ๅผๅๅทฅๅ ท/ # General development tools
```
---
## ๐บ Demos & Outputs
In a nutshell: Vibe Coding = **Plan-driven + Context fixation + AI pair execution**, turning "from idea to maintainable code" into an auditable pipeline, rather than an unmanageable monolith file.
**What you get**
- A systematic prompt toolchain: `i18n/zh/prompts/01-็ณป็ปๆ็คบ่ฏ/` constrains AI behavior boundaries, `i18n/zh/prompts/02-็ผ็จๆ็คบ่ฏ/` provides full-link scripts for requirement clarification, planning, and execution.
- Closed-loop delivery path: requirements โ context documentation โ implementation plan โ step-by-step implementation โ self-testing โ progress recording, fully reviewable and transferable.
โ๏ธ Architecture & Workflow
## โ๏ธ Architecture & Workflow
Core Asset Mapping:
```
i18n/zh/prompts/
00-ๅ ๆ็คบ่ฏ/ # Advanced prompts for generating prompts
01-็ณป็ปๆ็คบ่ฏ/ # System-level prompts constraining AI behavior boundaries
02-็ผ็จๆ็คบ่ฏ/ # Core prompts for requirement clarification, planning, and execution chain
03-็จๆทๆ็คบ่ฏ/ # Reusable user-side prompts
i18n/zh/documents/
04-่ตๆบ/ไปฃ็ ็ป็ป.md, 04-่ตๆบ/้็จ้กน็ฎๆถๆๆจกๆฟ.md, 00-ๅบ็กๆๅ/ๅผๅ็ป้ช.md, 00-ๅบ็กๆๅ/็ณป็ปๆ็คบ่ฏๆๅปบๅๅ.md etc. knowledge base
backups/
ไธ้ฎๅคไปฝ.sh, ๅฟซ้ๅคไปฝ.py # Local/remote snapshot scripts
```
```mermaid
graph TB
%% GitHub Compatible Simplified Version (using only basic syntax)
subgraph ext_layer[External Systems and Data Sources Layer]
ext_contrib[Community Contributors]
ext_sheet[Google Sheets / External Tables]
ext_md[External Markdown Prompts]
ext_api[Reserved: Other Data Sources / APIs]
ext_contrib --> ext_sheet
ext_contrib --> ext_md
ext_api --> ext_sheet
end
subgraph ingest_layer[Data Ingestion and Collection Layer]
excel_raw[prompt_excel/*.xlsx]
md_raw[prompt_docs/External MD Input]
excel_to_docs[prompts-library/scripts/excel_to_docs.py]
docs_to_excel[prompts-library/scripts/docs_to_excel.py]
ingest_bus[Standardized Data Frame]
ext_sheet --> excel_raw
ext_md --> md_raw
excel_raw --> excel_to_docs
md_raw --> docs_to_excel
excel_to_docs --> ingest_bus
docs_to_excel --> ingest_bus
end
subgraph core_layer[Data Processing and Intelligent Decision Layer / Core]
ingest_bus --> validate[Field Validation and Normalization]
validate --> transform[Format Mapping Transformation]
transform --> artifacts_md[prompt_docs/Standardized MD]
transform --> artifacts_xlsx[prompt_excel/Exported XLSX]
orchestrator[main.py ยท scripts/start_convert.py] --> validate
orchestrator --> transform
end
subgraph consume_layer[Execution and Consumption Layer]
artifacts_md --> catalog_coding[i18n/zh/prompts/02-็ผ็จๆ็คบ่ฏ]
artifacts_md --> catalog_system[i18n/zh/prompts/01-็ณป็ปๆ็คบ่ฏ]
artifacts_md --> catalog_meta[i18n/zh/prompts/00-ๅ ๆ็คบ่ฏ]
artifacts_md --> catalog_user[i18n/zh/prompts/03-็จๆทๆ็คบ่ฏ]
artifacts_md --> docs_repo[i18n/zh/documents/*]
artifacts_md --> new_consumer[Reserved: Other Downstream Channels]
catalog_coding --> ai_flow[AI Pair Programming Workflow]
ai_flow --> deliverables[Project Context / Plan / Code Output]
end
subgraph ux_layer[User Interaction and Interface Layer]
cli[CLI: python main.py] --> orchestrator
makefile[Makefile Task Encapsulation] --> cli
readme[README.md Usage Guide] --> cli
end
subgraph infra_layer[Infrastructure and Cross-Cutting Capabilities Layer]
git[Git Version Control] --> orchestrator
backups[backups/ไธ้ฎๅคไปฝ.sh ยท backups/ๅฟซ้ๅคไปฝ.py] --> artifacts_md
deps[requirements.txt ยท scripts/requirements.txt] --> orchestrator
config[prompts-library/scripts/config.yaml] --> orchestrator
monitor[Reserved: Logging and Monitoring] --> orchestrator
end
```
---
๐ Performance Benchmarking (Optional)
This repository is positioned as a "workflow and prompt" repository rather than a performance-oriented codebase. It is recommended to track the following observable metrics (currently mainly relying on manual recording, scores/traces can be marked in `progress.md`):
| Metric | Meaning | Current Status / Suggestion |
|:---|:---|:---|
| Prompt Hit Rate | Proportion of one-time generation meeting acceptance criteria | To be recorded; mark 0/1 in progress.md after each task |
| Turnaround Time | Time from requirement to first runnable version | Mark timestamps during screen recording, or use CLI timer |
| Change Traceability | Whether context/progress/backup is updated synchronously | Through manual updates; can add git tags/snapshots in backup scripts |
| Example Coverage | Whether there are minimal runnable examples/tests | It is recommended that each example project retains README + test cases |
---
## ๐บ๏ธ Roadmap
```mermaid
gantt
title Project Development Roadmap
dateFormat YYYY-MM
section In Progress (2025 Q4)
Complete Demo GIFs and Example Projects: active, 2025-12, 30d
Refine External Resource Aggregation: active, 2025-12, 20d
section Upcoming (2026 Q1)
Auto-generate Prompts Index Script: 2026-01, 15d
One-click Demo/Verification CLI Workflow: 2026-01, 15d
Add Snapshot and Validation to Backup Script: 2026-02, 10d
section Mid-term (2026 Q2)
Templated Example Project Set: 2026-03, 30d
Multi-model Comparison and Evaluation Baseline: 2026-04, 30d
```
---
## ๐ฏ Original Repo Translation
> The following content is translated from the original repository [EnzeD/vibe-coding](https://github.com/EnzeD/vibe-coding)
To start Vibe Coding, you only need one of the following two tools:
- **Claude Opus 4.5**, used in Claude Code
- **gpt-5.1-codex.1-codex (xhigh)**, used in Codex CLI
This guide applies to both the CLI terminal version and the VSCode extension version (both Codex and Claude Code have extensions, and the interface is updated).
*(Note: Earlier versions of this guide used **Grok 3**, then switched to **Gemini 2.5 Pro**, and now we are using **Claude 4.5** (or **gpt-5.1-codex.1-codex (xhigh)**))*
*(Note 2: If you want to use Cursor, please refer to [version 1.1](https://github.com/EnzeD/vibe-coding/tree/1.1.1) of this guide, but we believe it is currently not as powerful as Codex CLI or Claude Code)*
---
โ๏ธ Full Setup Process1. Game Design Document
- Hand your game idea to **gpt-5.1-codex** or **Claude Opus 4.5**, and let it generate a concise **Game Design Document** in Markdown format, named `game-design-document.md`.
- Review and refine it yourself to ensure it aligns with your vision. It can be rough at first; the goal is to provide AI with the context of the game's structure and intent. Do not over-design; it will be iterated later.
2. Tech Stack and CLAUDE.md / Agents.md
- Let **gpt-5.1-codex** or **Claude Opus 4.5** recommend the most suitable tech stack for your game (e.g., ThreeJS + WebSocket for a multiplayer 3D game), save it as `tech-stack.md`.
- Ask it to propose the **simplest yet most robust** tech stack.
- Open **Claude Code** or **Codex CLI** in the terminal, use the `/init` command, which will read the two .md files you created and generate a set of rules to properly guide the large model.
- **Key: Always review the generated rules.** Ensure the rules emphasize **modularization** (multiple files) and prohibit **monoliths**. You may need to manually modify or supplement the rules.
- **Extremely Important:** Certain rules must be set to **"Always"**, ensuring that AI is forced to read them before generating any code. For example, add the following rules and mark them as "Always":
> ```
> # Important Note:
> # Before writing any code, you must fully read memory-bank/@architecture.md (including full database structure)
> # Before writing any code, you must fully read memory-bank/@game-design-document.md
> # After completing any major feature or milestone, you must update memory-bank/@architecture.md
> ```
- Other (non-Always) rules should guide AI to follow best practices for your tech stack (e.g., networking, state management).
- *If you want the cleanest code and most optimized project, this entire set of rule settings is mandatory.*
3. Implementation Plan
- Provide the following to **gpt-5.1-codex** or **Claude Opus 4.5**:
- Game Design Document (`game-design-document.md`)
- Tech Stack Recommendation (`tech-stack.md`)
- Let it generate a detailed **Implementation Plan** (Markdown format), containing a series of step-by-step instructions for the AI developer.
- Each step should be small and specific.
- Each step must include tests to verify correctness.
- Strictly no code โ only clear, specific instructions.
- Focus on the **basic game** first; full features will be added later.
4. Memory Bank
- Create a new project folder and open it in VSCode.
- Create a subfolder `memory-bank` in the project root directory.
- Place the following files into `memory-bank`:
- `game-design-document.md`
- `tech-stack.md`
- `implementation-plan.md`
- `progress.md` (create an empty file to record completed steps)
- `architecture.md` (create an empty file to record the purpose of each file)
๐ฎ Vibe Coding to Develop the Basic Game
Now for the most exciting part!
Ensure Everything is Clear
- Open **Codex** or **Claude Code** in the VSCode extension, or launch Claude Code / Codex CLI in the project terminal.
- Prompt: Read all documents in `/memory-bank`. Is `implementation-plan.md` completely clear? What questions do you have for me to clarify, to make it 100% clear to you?
- It will typically ask 9-10 questions. After answering all of them, ask it to modify `implementation-plan.md` based on your answers to further refine the plan.
Your First Implementation Prompt
- Open **Codex** or **Claude Code** (extension or terminal).
- Prompt: Read all documents in `/memory-bank`, then execute step 1 of the implementation plan. I will be responsible for running tests. Do not start step 2 until I verify the tests pass. After verification, open `progress.md` to record what you did for future developers, and then add new architectural insights to `architecture.md` to explain the purpose of each file.
- **Always** use "Ask" mode or "Plan Mode" (press `shift+tab` in Claude Code) first, and only let AI execute the step after you are satisfied.
- **Ultimate Vibe:** Install [Superwhisper](https://superwhisper.com), chat freely with Claude or gpt-5.1-codex using voice, no typing needed.
Workflow
- After completing step 1:
- Commit changes to Git (ask AI if you don't know how).
- Start a new chat (`/new` or `/clear`).
- Prompt: Read all files in memory-bank, read progress.md to understand previous work progress, then proceed to step 2 of the implementation plan. Do not start step 3 until I verify the tests.
- Repeat this process until the entire `implementation-plan.md` is completed.
โจ Add Detailed Features
Congratulations! You have built the basic game! It might still be rough and lack features, but now you can experiment and refine it as much as you want.
- Want fog effects, post-processing, special effects, sound effects? Better planes/cars/castles? Beautiful skies?
- For each major feature you add, create a new `feature-implementation.md`, writing short steps + tests.
- Continue to implement and test incrementally.
๐ Bug Fixes & Stuck SituationsGeneral Fixes
- If a prompt fails or breaks the project:
- Use `/rewind` in Claude Code to revert; for gpt-5.1-codex, commit to git more often and reset when needed.
- Error handling:
- **JavaScript errors:** Open browser console (F12), copy the error, paste it to AI; for visual issues, send screenshots.
- **Lazy solution:** Install [BrowserTools](https://browsertools.agentdesk.ai/installation), automatically copies errors and screenshots.
Tough Problems
- If truly stuck:
- Revert to the previous git commit (`git reset`), try again with new prompts.
- Extremely stuck:
- Use [RepoPrompt](https://repoprompt.com/) or [uithub](https://uithub.com/) to consolidate the entire codebase into one file, then throw it to **gpt-5.1-codex or Claude** for help.
๐ก Tips & TricksClaude Code & Codex Usage Tips
- **Terminal Claude Code / Codex CLI:** Run in VSCode terminal, directly view diffs, feed context, without leaving the workspace.
- **Claude Code's `/rewind`:** One-click rollback to a previous state when iteration goes astray.
- **Custom Commands:** Create shortcut commands like `/explain $parameter` to trigger prompts: "Analyze the code in depth to fully understand how $parameter works. After understanding, tell me, and I will give you the next task." This makes the model load full context before modifying code.
- **Clean Context:** Frequently use `/clear` or `/compact` (to preserve historical conversations).
- **Time-saving trick (use at your own risk):** Use `claude --dangerously-skip-permissions` or `codex --yolo` to completely disable confirmation pop-ups.
Other Useful Tips
- **Small modifications:** Use gpt-5.1-codex (medium)
- **Write top-tier marketing copy:** Use Opus 4.1
- **Generate excellent 2D sprites:** Use ChatGPT + Nano Banana
- **Generate music:** Use Suno
- **Generate sound effects:** Use ElevenLabs
- **Generate videos:** Use Sora 2
- **Improve prompt effectiveness:**
- Add a sentence: "Think slowly, no rush. It's important to strictly follow my instructions and execute perfectly. If my expression is not precise enough, please ask."
- In Claude Code, the intensity of keywords that trigger deep thinking: `think` < `think hard` < `think harder` < `ultrathink`.
โ Frequently Asked Questions (FAQ)
- **Q: I'm building an application, not a game. Is the process the same?**
- **A:** Essentially identical! Just replace GDD with PRD (Product Requirements Document). You can also use v0, Lovable, Bolt.new for quick prototyping, then move the code to GitHub, and clone it locally to continue development with this guide.
- **Q: Your aerial combat game's plane model is amazing, but I can't make it with one prompt!**
- **A:** That wasn't one prompt, it was ~30 prompts + a dedicated `plane-implementation.md` file guiding it. Use precise instructions like "cut out space for ailerons on the wings" instead of vague instructions like "make a plane".
- **Q: Why are Claude Code or Codex CLI stronger than Cursor now?**
- **A:** It's entirely a matter of personal preference. We emphasize that Claude Code can better leverage the power of Claude Opus 4.5, and Codex CLI can better leverage the power of gpt-5.1-codex. Cursor's utilization of both is not as good as the native terminal versions. Terminal versions can also work in any IDE, use SSH remote servers, etc., and custom commands, sub-agents, hooks, and other features can significantly improve development quality and speed in the long run. Finally, even if you only have a low-tier Claude or ChatGPT subscription, it's completely sufficient.
- **Q: What if I don't know how to set up a multiplayer game server?**
- **A:** Ask your AI.
---
## ๐ Contact Info
- **GitHub**: [tukuaiai](https://github.com/tukuaiai)
- **Twitter / X**: [123olp](https://x.com/123olp)
- **Telegram**: [@desci0](https://t.me/desci0)
- **Telegram Chat Group**: [glue_coding](https://t.me/glue_coding)
- **Telegram Channel**: [tradecat_ai_channel](https://t.me/tradecat_ai_channel)
- **Email**: tukuai.ai@gmail.com (Replies may not be timely)
---
## โจ Support Project
Please help, thank you, good people will be safe and sound forever๐๐๐
- **Binance UID**: `572155580`
- **Tron (TRC20)**: `TQtBXCSTwLFHjBqTS4rNUp7ufiGx51BRey`
- **Solana**: `HjYhozVf9AQmfv7yv79xSNs6uaEU5oUk2USasYQfUYau`
- **Ethereum (ERC20)**: `0xa396923a71ee7D9480b346a17dDeEb2c0C287BBC`
- **BNB Smart Chain (BEP20)**: `0xa396923a71ee7D9480b346a17dDeEb2c0C287BBC`
- **Bitcoin**: `bc1plslluj3zq3snpnnczplu7ywf37h89dyudqua04pz4txwh8z5z5vsre7nlm`
- **Sui**: `0xb720c98a48c77f2d49d375932b2867e793029e6337f1562522640e4f84203d2e`
---
### โจ Contributors
Thanks to all the developers who contributed to this project!
---
## ๐ค Contribute
We warmly welcome contributions in all forms. If you have any ideas or suggestions for this project, please feel free to open an [Issue](https://github.com/tukuaiai/vibe-coding-cn/issues) or submit a [Pull Request](https://github.com/tukuaiai/vibe-coding-cn/pulls).
Before you begin, please take the time to read our [**Contribution Guidelines (CONTRIBUTING.md)**](CONTRIBUTING.md) and [**Code of Conduct (CODE_OF_CONDUCT.md)**](CODE_OF_CONDUCT.md).
---
## ๐ License
This project is licensed under the [MIT](LICENSE) license.
---
**If this project is helpful to you, please consider giving it a Star โญ!**
## Star History
---
**Crafted with passion by [tukuaiai](https://github.com/tukuaiai), [Nicolas Zullo](https://x.com/NicolasZu), and [123olp](https://x.com/123olp)**
[โฌ Back to Top](#vibe-coding-ๆๅ)
