diff --git a/EN_README.md b/EN_README.md new file mode 100644 index 0000000..ea2d6ad --- /dev/null +++ b/EN_README.md @@ -0,0 +1,208 @@ + +

+ ๐Ÿ‡จ๐Ÿ‡ณ ไธญๆ–‡ ยท ๐Ÿ‡บ๐Ÿ‡ธ English +

+

โ€” โœฆ โ€”

+ +# Cultivation World Simulator + +An AI-augmented, rules-driven cultivation world simulator aimed at creating a truly living and immersive xianxia world. + +## Overview + +Cultivation World Simulator combines traditional deterministic rule systems with modern AI. It models terrains, characters, cultivation system, relationships, and more, to form an autonomous, vibrant virtual world. + +Core idea: **Build a credible rule-based world model first, then plug in AI to bring it to life.** + +### Tech Stack + +- **Frontend Rendering**: pygame (Web support in the future) +- **Simulation Engine**: custom event-driven simulator +- **World Model**: rule-based deterministic systems +- **AI Integration**: LLM-generated actions, decisions, micro-stories + +## Background + +I have been a long-time reader of xianxia novels, from classics to modern works. As a game AI practitioner, I believe todayโ€™s LLM capabilities are sufficient to support a xianxia-style world simulation. + +However, LLM-only NPC decision/dialogue is not enough. A credible rule system must ground the world as the โ€œworld modelโ€, and then AI makes it vivid. + +I aim to create a pure, joyful, direct, living sense of immersion. Not a mere marketing demo, nor purely academic like โ€œStanford Townโ€, but a world that players can actually feel and inhabit. + +If you like this project, consider starring it. You can also watch an intro video on my Bilibili: [`link`](https://space.bilibili.com/527346837). + +![Screenshot](assets/screenshot.png) + +## Development Progress + +### ๐Ÿ—๏ธ Foundation +- โœ… World map basics +- โœ… Diverse terrain types (plain, mountain, forest, desert, water, etc.) +- โœ… Time system (year-month timestamps) +- โœ… Frontend UI (pygame) +- โœ… Simulation framework +- โœ… Project documentation (README) +- โœ… Config system +- [ ] Standalone release (packaged exe) +- [ ] Web frontend (later) +- [ ] ECS parallel toolkit (later) +- [ ] Player-configurable prompts (later) + +### ๐Ÿ—บ๏ธ Tile System +- โœ… Basic tile mechanics +- โœ… Normal, cultivate, city, sect regions +- โœ… Same-tile NPC interactions +- โœ… Qi distribution and yields + +### ๐Ÿ‘ค Character System +- โœ… Core attributes +- โœ… Cultivation realms +- โœ… Spiritual roots +- โœ… Basic movement actions +- โœ… Personality +- โœ… Breakthrough system +- โœ… Relationships +- โœ… Perception radius +- [ ] Special abilities +- [ ] Epithets/nicknames +- [ ] Buff system: buffs/debuffs, state mgmt +- [ ] Combat-related + - [ ] Attribute points allocation + - [ ] Skill system (techniques) + - [ ] Equipment system + - [ ] Artifacts system +- [ ] Skill learning + - [ ] Learnable skills + - [ ] Personal techniques (flexible integration) + - [ ] Life professions (alchemy, formations, farming, forging, etc., with tailored prompts and info space) +- [ ] Mortals support +- [ ] Prodigies (stronger abilities and AI) + +### ๐Ÿ›๏ธ Organizations +- [ ] Sect system + - โœ… Settings, techniques, healing, base, styles + - โœ… Special sect action: Hehuan Sect (dual cultivation) + - [ ] Sect artifacts, sect will AI, tasks, recruiting + - [ ] Sect tiers: different titles, abilities, actions +- [ ] Clans +- [ ] Court/Empire (TBD) +- [ ] Inter-organization relations + +### โšก Action System +- โœ… Basic movement +- โœ… Action execution framework +- โœ… Defined actions (rule-complete) +- โœ… Long-duration actions and settlement + - โœ… Multi-month actions (cultivate, breakthrough, play, etc.) + - โœ… Auto-settlement upon completion +- โœ… Multiplayer actions: initiator + responder flow +- โœ… LLM actions that affect relationships +- โœ… Systematic action registration and runtime logic +- [ ] Richer actions + +### ๐ŸŽญ Event System +- [ ] World-scale events: + - [ ] Auctions + - [ ] Secret realm exploration + - [ ] Martial tournaments +- [ ] Sudden events + - [ ] Treasure/cave emergence + - [ ] Novelized/CG/film-style presentations +- [ ] Natural events: + - [ ] Natural disasters + - [ ] Beast tides + +### โš”๏ธ Combat +- [ ] Combat design (roots influence skills and styles) +- [ ] Advantages and counters +- โœ… Win-rate estimation (simple) + +### ๐ŸŽ’ Items +- โœ… Basic items and spirit stones +- [ ] Trading mechanics +- [ ] Economy system + +### ๐ŸŒฟ Ecology +- โœ… Animals and plants +- โœ… Hunting, gathering, materials +- [ ] Beasts/monsters + +### ๐Ÿค– AI Enhancements +- โœ… LLM interface integration +- โœ… Character AI (rules AI + LLM AI) +- โœ… Coroutine decision making, async, multithreaded speedups +- โœ… Long-term planning and goal-driven behavior +- โœ… Reactive responses to external stimuli +- โœ… LLM-driven NPC dialogue, thinking, interaction +- โœ… LLM-generated micro-stories +- โœ… Use different models (max/flash) per task needs +- โœ… Micro-theaters + - โœ… Battle micro-theaters + - โœ… Dialogue micro-theaters + - โœ… Multiple writing styles +- [ ] NPC observation space design +- [ ] One-off choices (e.g., switch techniques or not) +- [ ] Long-term memories / unforgettable memories + +### ๐Ÿ›๏ธ World Lore +- [ ] Lore framework +- [ ] Worldbuilding +- [ ] Ancient history generation + +### Specials +- [ ] Fortuitous encounters +- [ ] Paths/Daos +- [ ] Possession & Rebirth +- [ ] Formations +- [ ] Opportunities +- [ ] Tribulations & Heart devils +- [ ] Flexible world rules +- [ ] Divination & Omens +- [ ] Male-female traits inversion + +## Usage + +### Run Steps +1. Clone the repo: + ```bash + git clone https://github.com/your-username/cultivation-world-simulator.git + cd cultivation-world-simulator + ``` + +2. Install dependencies: + ```bash + pip install -r requirements.txt + ``` + +3. Configure LLM: + Edit `static/config.yml`: + ```yaml + llm: + model_name: "gpt-3.5-turbo" # or another model supported by LiteLLM + key: "your-api-key-here" # your API key + ``` + See the LiteLLM docs: [`link`](https://docs.litellm.ai/docs/providers) + +4. Run the simulator: + ```bash + python -m src.run.run + ``` + +### Basic Operations +- A random map is generated at startup +- Observe characters moving and acting in the world +- Press ESC to quit + +## Contributing + +Contributions are welcome! + +## License + +This project is licensed as specified in [`LICENSE`](LICENSE). + +## Contact + +Open an issue or pull request if you have questions or suggestions. + + diff --git a/README.md b/README.md index 2eb4ca3..5fa3bb7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ + +

+ ๐Ÿ‡จ๐Ÿ‡ณ ไธญๆ–‡ ยท ๐Ÿ‡บ๐Ÿ‡ธ English +

+

โ€” โœฆ โ€”

+ # ไฟฎไป™ไธ–็•Œๆจกๆ‹Ÿๅ™จ (Cultivation World Simulator) ไธ€ไธชๅŸบไบŽ่ง„ๅˆ™ๅ’ŒAI้ฉฑๅŠจ็š„ไฟฎไป™ไธ–็•Œๆจกๆ‹Ÿๅ™จ๏ผŒๆ—จๅœจๅˆ›้€ ไธ€ไธช็œŸๆญฃๆดป็€็š„ใ€ๆœ‰ๆฒ‰ๆตธๆ„Ÿ็š„ไป™ไพ ไธ–็•Œใ€‚