anima-world 1.0.0__tar.gz

anima_world-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

anima_world-1.0.0/NOTICE

@@ -0,0 +1,16 @@
+anima-world —— ANIMA 世界引擎
+Copyright 2026 ANIMA
+
+This product includes software developed at ANIMA (https://animametaverse.com).
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

anima_world-1.0.0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.4
+Name: anima-world
+Version: 1.0.0
+Summary: A world-simulation engine for LLM-driven agents: event-sourced core, behavior-tree scheduling, memory and relationships, packaged as portable .cyberworld files
+Author-email: ANIMA <aubrey@animametaverse.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://animametaverse.com
+Project-URL: Source, https://github.com/aubrey-anima/core
+Project-URL: Issues, https://github.com/aubrey-anima/core/issues
+Project-URL: Changelog, https://github.com/aubrey-anima/core/blob/main/CHANGELOG.md
+Keywords: simulation,agents,llm,event-sourcing,behavior-tree,worldbuilding
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Games/Entertainment :: Simulation
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: cryptography>=42.0
+Requires-Dist: openai>=1.30
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# anima-world
+
+**A world-simulation engine for LLM-driven agents.** Characters wake up, get hungry,
+go to work, gossip about each other, form cliques, spend money, remember what happened
+last week, and change how they feel about you. One SQLite file is one world.
+
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/aubrey-anima/core/blob/main/LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://github.com/aubrey-anima/core/blob/main/pyproject.toml)
+[![PyPI](https://img.shields.io/pypi/v/anima-world.svg)](https://pypi.org/project/anima-world/)
+
+English | [中文](https://github.com/aubrey-anima/core/blob/main/README.zh-CN.md)
+
+---
+
+## What this is
+
+Most "AI agent" frameworks give you a chatbot with tools. This gives you a **place** —
+one that keeps running whether or not anyone is watching, and remembers what happened
+while they were away.
+
+A world is a tick-driven simulation. On every tick each character runs a behavior tree
+against its own needs and the state of the world, and acts. Those acts become events in
+an append-only log, which is the world's only source of truth — balances, relationships,
+and locations are all *projections* of that log, never separately stored rows that could
+drift out of sync.
+
+The LLM sits beside the simulation, not inside it. It writes the narration, plans what a
+character does with free time, and judges how a conversation changed a relationship —
+all on background threads. **The clock never blocks on a network call.** Take the LLM
+away entirely and the world still runs; it just narrates in templates.
+
+The engine is **a library, not a service.** There is no HTTP server and no port. Your
+application imports it, and the world lives inside your process:
+
+```
+your app  ──import anima_world.api──▶  world.db
+```
+
+## See it run
+
+```console
+$ pip install anima-world
+$ anima-world start
+
+  ANIMA 世界引擎
+  ────────────────────────────────────────────
+
+  ① LLM
+     ! LLM 未配置 —— 叙事、空闲计划、关系判定都会降级成模板文本
+       修复:anima-world config set llm.api_key sk-…
+
+  ② 世界
+     ✓ 新建 saves/world.db
+     时钟:1 tick/秒 —— 约 5 分钟走完一个世界日(现实时间的 300 倍速)
+     ✓ 3 个角色就位: 苏晚夏、陆知遥、沈亦柔
+
+  ③ 运行
+     世界在本进程里运行,叙事会打印在下面;停止:Ctrl-C
+
+  [第0天 00:10] 遥:遥 wandered around
+  [第0天 00:10] 夏:夏 went to sleep
+  [第0天 00:35] 遥:遥 went to sleep
+  ^C
+  世界已停下,快照已保存。下次接着跑:anima-world start
+```
+
+`start` configures the LLM, creates the world, and runs it — in that order, with no
+documentation required first. Without an API key everything still works; narration is
+templated and characters have no plans. That degradation is deliberate, and it is never
+silent (`anima-world doctor` will tell you, and `World.state()` carries the reason).
+
+> **Heads up on language:** the engine speaks Chinese. CLI output, narration prompts, the
+> built-in seed world, and the reference docs are all in Chinese. The API itself is
+> English (`World.open`, `world.tick`, `world.chat`), so embedding it in an
+> English-language application works fine — you supply your own seed and prompts.
+
+## Install
+
+```bash
+pip install anima-world          # Python 3.11+
+```
+
+Three runtime dependencies, chosen to stay out of your way since they land in every host
+that embeds a world: `cryptography` (encrypts the API key at rest), `openai` (any
+OpenAI-compatible endpoint), `httpx`.
+
+From source:
+
+```bash
+git clone https://github.com/aubrey-anima/core.git anima-world
+cd anima-world && pip install -e ".[dev]" && python -m pytest
+```
+
+## Use it in your app
+
+This is the main interface. `World` is a plain object with a lifetime — open it, drive
+it, close it.
+
+```python
+from anima_world.api import World
+
+with World.open("saves/world.db") as world:
+    world.start_clock()                        # background clock; or drive it yourself
+    print(world.state()["world_time"])         # {'day': 0, 'hour': 6, 'minute': 25, ...}
+
+    # Talk to a character on a player's behalf. Streams; your app owns the transcript.
+    for chunk in world.chat("夏", [{"role": "user", "content": "你好"}],
+                            player_id="p1", display_name="阿宇"):
+        print(chunk, end="")
+
+    # Commit a finished exchange: summary + one world event + a relationship verdict
+    world.record_chat_turn("夏", "p1", [
+        {"role": "user", "content": "你好"},
+        {"role": "assistant", "content": "你好呀"},
+    ])
+
+    world.player_move("p1", "cafe")
+    world.config_set("scheduler.tick_rate", 1.0)
+```
+
+For batch work, drive the clock yourself — `world.tick(n)` is synchronous and
+deterministic, which is what makes fast-forwarding and testing possible:
+
+```python
+with World.open("w.db") as world:
+    world.tick(288)                     # one world day
+    print(world.memories("夏"))         # what she remembers, ranked
+    print(world.needs("夏"))            # {'energy': 0.59, 'hunger': 0.16, ...}
+    print(world.cliques())              # who has clustered together
+```
+
+## What a world contains
+
+Four subsystems, each an opt-in flag except memory. They are off by default because a
+world that only walks around and talks is a legitimate world, and every mechanism you
+enable is more LLM spend and more surface to reason about.
+
+| Subsystem | Flag | What it adds |
+|---|---|---|
+| **Memory** | always on | Retrieval scored on relevance × recency × importance, periodic reflection that writes higher-order memories, and a forgetting curve |
+| **Needs** | `needs.enabled` | `energy` / `hunger` / `social` decay per tick and drive an urgency band in the behavior tree — a tired character stops what it is doing and goes to sleep |
+| **Economy** | `economy.enabled` | Items, money, shops, wages, and price drift. The ledger is a projection of `payment` events, so balances cannot be forged |
+| **Social** | `social.enabled` | Three-axis relationships (always on) plus gossip that propagates second-hand with confidence decay, and emergent cliques |
+
+```bash
+anima-world config set needs.enabled true --db-path saves/world.db
+```
+
+## How it is built
+
+**One file is one world.** `world.db` holds events, chats, memories, and config.
+`world.db.key` sits next to it and encrypts the API key — **it must travel with the
+database**, or the key becomes unreadable and the world silently drops to Mock. (Not
+actually silently: the engine says so at boot and keeps saying so in `state()`.)
+
+**The event log is the only truth.** There is no `balances` table, because two sources
+of truth eventually disagree and you cannot tell which one is right. `world.db` does not
+store "夏 has 50 coins" — it stores *why* she has 50 coins. Reconciliation is replay.
+
+**One running world owns its file.** Half the truth lives in memory (clock, projection,
+locks, thread pools), so a second process writing the same `world.db` forks it
+immediately. Offline work — packaging, fast-forwarding — happens after the world closes.
+
+**Version is contract.** One release freezes (engine code, db format, package format)
+together. The major version *is* the db format version, and `db.py` enforces it at
+runtime: mount a database from an incompatible format and it refuses on the spot rather
+than quietly writing garbage.
+
+## Ship a world to someone else
+
+Worlds package into a single `.cyberworld` file — either a template (just the seed, the
+world builds itself on first boot) or a snapshot (a database that has already lived).
+
+```bash
+anima-world world export --seed seed.json --output my.cyberworld \
+    --world-id my-world --name "我的世界" --mode template
+
+anima-world world import my.cyberworld --destination ./instances
+```
+
+## Commands
+
+```bash
+anima-world start          # create + run, with guided setup — start here
+anima-world doctor         # health check: files, keys, a real LLM call, clock speed
+anima-world config         # read/write settings, secrets encrypted and masked
+anima-world run            # foreground host, no onboarding (for deployment)
+anima-world simulate       # headless fast-forward
+anima-world world          # export / import .cyberworld packages
+```
+
+## Documentation
+
+| | |
+|---|---|
+| [docs/REFERENCE.md](https://github.com/aubrey-anima/core/blob/main/docs/REFERENCE.md) | Every command, every `World` method, every config key, the beat-script format 🇨🇳 |
+| [docs/ARCHITECTURE.md](https://github.com/aubrey-anima/core/blob/main/docs/ARCHITECTURE.md) | Why it is shaped this way: the truth model, the tick frame, threads and locks, invariants, known debt 🇨🇳 |
+| [CONTRIBUTING.md](https://github.com/aubrey-anima/core/blob/main/CONTRIBUTING.md) | Development setup, the invariants a patch must not break, how to propose changes |
+| [CHANGELOG.md](https://github.com/aubrey-anima/core/blob/main/CHANGELOG.md) | Release history |
+
+## Contributing
+
+Issues and pull requests are welcome. Start with [CONTRIBUTING.md](https://github.com/aubrey-anima/core/blob/main/CONTRIBUTING.md) —
+it lists the handful of invariants that a change must not break (there is exactly one
+lock in the system, the LLM is never called on the tick thread, and a few file formats
+are mirrored by other repositories).
+
+## License
+
+[Apache License 2.0](https://github.com/aubrey-anima/core/blob/main/LICENSE). Use it, modify it, ship it inside closed-source products;
+keep the copyright notice and state what you changed. Apache rather than MIT for the
+patent grant, and permissive rather than copyleft because an engine that hosts embed
+cannot be copyleft without infecting every host that embeds it.

anima_world-1.0.0/README.md

@@ -0,0 +1,213 @@
+# anima-world
+
+**A world-simulation engine for LLM-driven agents.** Characters wake up, get hungry,
+go to work, gossip about each other, form cliques, spend money, remember what happened
+last week, and change how they feel about you. One SQLite file is one world.
+
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/aubrey-anima/core/blob/main/LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://github.com/aubrey-anima/core/blob/main/pyproject.toml)
+[![PyPI](https://img.shields.io/pypi/v/anima-world.svg)](https://pypi.org/project/anima-world/)
+
+English | [中文](https://github.com/aubrey-anima/core/blob/main/README.zh-CN.md)
+
+---
+
+## What this is
+
+Most "AI agent" frameworks give you a chatbot with tools. This gives you a **place** —
+one that keeps running whether or not anyone is watching, and remembers what happened
+while they were away.
+
+A world is a tick-driven simulation. On every tick each character runs a behavior tree
+against its own needs and the state of the world, and acts. Those acts become events in
+an append-only log, which is the world's only source of truth — balances, relationships,
+and locations are all *projections* of that log, never separately stored rows that could
+drift out of sync.
+
+The LLM sits beside the simulation, not inside it. It writes the narration, plans what a
+character does with free time, and judges how a conversation changed a relationship —
+all on background threads. **The clock never blocks on a network call.** Take the LLM
+away entirely and the world still runs; it just narrates in templates.
+
+The engine is **a library, not a service.** There is no HTTP server and no port. Your
+application imports it, and the world lives inside your process:
+
+```
+your app  ──import anima_world.api──▶  world.db
+```
+
+## See it run
+
+```console
+$ pip install anima-world
+$ anima-world start
+
+  ANIMA 世界引擎
+  ────────────────────────────────────────────
+
+  ① LLM
+     ! LLM 未配置 —— 叙事、空闲计划、关系判定都会降级成模板文本
+       修复:anima-world config set llm.api_key sk-…
+
+  ② 世界
+     ✓ 新建 saves/world.db
+     时钟:1 tick/秒 —— 约 5 分钟走完一个世界日(现实时间的 300 倍速)
+     ✓ 3 个角色就位: 苏晚夏、陆知遥、沈亦柔
+
+  ③ 运行
+     世界在本进程里运行,叙事会打印在下面;停止:Ctrl-C
+
+  [第0天 00:10] 遥:遥 wandered around
+  [第0天 00:10] 夏:夏 went to sleep
+  [第0天 00:35] 遥:遥 went to sleep
+  ^C
+  世界已停下,快照已保存。下次接着跑:anima-world start
+```
+
+`start` configures the LLM, creates the world, and runs it — in that order, with no
+documentation required first. Without an API key everything still works; narration is
+templated and characters have no plans. That degradation is deliberate, and it is never
+silent (`anima-world doctor` will tell you, and `World.state()` carries the reason).
+
+> **Heads up on language:** the engine speaks Chinese. CLI output, narration prompts, the
+> built-in seed world, and the reference docs are all in Chinese. The API itself is
+> English (`World.open`, `world.tick`, `world.chat`), so embedding it in an
+> English-language application works fine — you supply your own seed and prompts.
+
+## Install
+
+```bash
+pip install anima-world          # Python 3.11+
+```
+
+Three runtime dependencies, chosen to stay out of your way since they land in every host
+that embeds a world: `cryptography` (encrypts the API key at rest), `openai` (any
+OpenAI-compatible endpoint), `httpx`.
+
+From source:
+
+```bash
+git clone https://github.com/aubrey-anima/core.git anima-world
+cd anima-world && pip install -e ".[dev]" && python -m pytest
+```
+
+## Use it in your app
+
+This is the main interface. `World` is a plain object with a lifetime — open it, drive
+it, close it.
+
+```python
+from anima_world.api import World
+
+with World.open("saves/world.db") as world:
+    world.start_clock()                        # background clock; or drive it yourself
+    print(world.state()["world_time"])         # {'day': 0, 'hour': 6, 'minute': 25, ...}
+
+    # Talk to a character on a player's behalf. Streams; your app owns the transcript.
+    for chunk in world.chat("夏", [{"role": "user", "content": "你好"}],
+                            player_id="p1", display_name="阿宇"):
+        print(chunk, end="")
+
+    # Commit a finished exchange: summary + one world event + a relationship verdict
+    world.record_chat_turn("夏", "p1", [
+        {"role": "user", "content": "你好"},
+        {"role": "assistant", "content": "你好呀"},
+    ])
+
+    world.player_move("p1", "cafe")
+    world.config_set("scheduler.tick_rate", 1.0)
+```
+
+For batch work, drive the clock yourself — `world.tick(n)` is synchronous and
+deterministic, which is what makes fast-forwarding and testing possible:
+
+```python
+with World.open("w.db") as world:
+    world.tick(288)                     # one world day
+    print(world.memories("夏"))         # what she remembers, ranked
+    print(world.needs("夏"))            # {'energy': 0.59, 'hunger': 0.16, ...}
+    print(world.cliques())              # who has clustered together
+```
+
+## What a world contains
+
+Four subsystems, each an opt-in flag except memory. They are off by default because a
+world that only walks around and talks is a legitimate world, and every mechanism you
+enable is more LLM spend and more surface to reason about.
+
+| Subsystem | Flag | What it adds |
+|---|---|---|
+| **Memory** | always on | Retrieval scored on relevance × recency × importance, periodic reflection that writes higher-order memories, and a forgetting curve |
+| **Needs** | `needs.enabled` | `energy` / `hunger` / `social` decay per tick and drive an urgency band in the behavior tree — a tired character stops what it is doing and goes to sleep |
+| **Economy** | `economy.enabled` | Items, money, shops, wages, and price drift. The ledger is a projection of `payment` events, so balances cannot be forged |
+| **Social** | `social.enabled` | Three-axis relationships (always on) plus gossip that propagates second-hand with confidence decay, and emergent cliques |
+
+```bash
+anima-world config set needs.enabled true --db-path saves/world.db
+```
+
+## How it is built
+
+**One file is one world.** `world.db` holds events, chats, memories, and config.
+`world.db.key` sits next to it and encrypts the API key — **it must travel with the
+database**, or the key becomes unreadable and the world silently drops to Mock. (Not
+actually silently: the engine says so at boot and keeps saying so in `state()`.)
+
+**The event log is the only truth.** There is no `balances` table, because two sources
+of truth eventually disagree and you cannot tell which one is right. `world.db` does not
+store "夏 has 50 coins" — it stores *why* she has 50 coins. Reconciliation is replay.
+
+**One running world owns its file.** Half the truth lives in memory (clock, projection,
+locks, thread pools), so a second process writing the same `world.db` forks it
+immediately. Offline work — packaging, fast-forwarding — happens after the world closes.
+
+**Version is contract.** One release freezes (engine code, db format, package format)
+together. The major version *is* the db format version, and `db.py` enforces it at
+runtime: mount a database from an incompatible format and it refuses on the spot rather
+than quietly writing garbage.
+
+## Ship a world to someone else
+
+Worlds package into a single `.cyberworld` file — either a template (just the seed, the
+world builds itself on first boot) or a snapshot (a database that has already lived).
+
+```bash
+anima-world world export --seed seed.json --output my.cyberworld \
+    --world-id my-world --name "我的世界" --mode template
+
+anima-world world import my.cyberworld --destination ./instances
+```
+
+## Commands
+
+```bash
+anima-world start          # create + run, with guided setup — start here
+anima-world doctor         # health check: files, keys, a real LLM call, clock speed
+anima-world config         # read/write settings, secrets encrypted and masked
+anima-world run            # foreground host, no onboarding (for deployment)
+anima-world simulate       # headless fast-forward
+anima-world world          # export / import .cyberworld packages
+```
+
+## Documentation
+
+| | |
+|---|---|
+| [docs/REFERENCE.md](https://github.com/aubrey-anima/core/blob/main/docs/REFERENCE.md) | Every command, every `World` method, every config key, the beat-script format 🇨🇳 |
+| [docs/ARCHITECTURE.md](https://github.com/aubrey-anima/core/blob/main/docs/ARCHITECTURE.md) | Why it is shaped this way: the truth model, the tick frame, threads and locks, invariants, known debt 🇨🇳 |
+| [CONTRIBUTING.md](https://github.com/aubrey-anima/core/blob/main/CONTRIBUTING.md) | Development setup, the invariants a patch must not break, how to propose changes |
+| [CHANGELOG.md](https://github.com/aubrey-anima/core/blob/main/CHANGELOG.md) | Release history |
+
+## Contributing
+
+Issues and pull requests are welcome. Start with [CONTRIBUTING.md](https://github.com/aubrey-anima/core/blob/main/CONTRIBUTING.md) —
+it lists the handful of invariants that a change must not break (there is exactly one
+lock in the system, the LLM is never called on the tick thread, and a few file formats
+are mirrored by other repositories).
+
+## License
+
+[Apache License 2.0](https://github.com/aubrey-anima/core/blob/main/LICENSE). Use it, modify it, ship it inside closed-source products;
+keep the copyright notice and state what you changed. Apache rather than MIT for the
+patent grant, and permissive rather than copyleft because an engine that hosts embed
+cannot be copyleft without infecting every host that embeds it.