5/13 api support

README copy.md

@@ -0,0 +1,137 @@
+# BookWorld: Interactive Multi-Agent Story Creation System
+
+<div align="center">
+
+🖥️ [Project Page](https://bookworld2025.github.io/) | 📃 [Paper](https://arxiv.org/abs/2406.18921) | 🤗 [Demo](https://huggingface.co/spaces/alienet/BookWorld)
+
+</div>
+
+
+
+
+This is the official implementation of the paper "BOOKWORLD: From Novels to Interactive Agent Societies for Story Creation".
+
+![Preview.png](<https://media-hosting.imagekit.io/14ce589aed514385/Preview.png?Expires=1840513142&Key-Pair-Id=K2ZIVPTIP2VGHC&Signature=oH~h5cUOwe3DjyDa86z40LBKpVanA81kQcGWubqjAa7SdiRWbYq2GIIF27urVYi4JK6u20IcmbRmoIxqkIQ1D-IBc9aMKcyVLJrjtlsvbaePOzgi-GtivxWIFuJvSzzuOfYmWF89KxzQ~EFsximhKJqtuw-WCZYRhpEFMUSuy42z-Lhv4ou6mWM58PIwzvsdc~rJxtMEXdaoxA9BGKKfcWD8mrhN8TI~mQzeRP-WE6KxHS9ib3MKES1BN9n5jLa4vEI5I2OwnzBFnc2iJ2vcyYgYRUY~1JF-ucYubMt85H2aWo9PUBYy38BYzodDdI0X8sKesL~evjstY5RH0buyCw__>)
+
+## Introduction
+
+BookWorld is a comprehensive system for social simulation in fictional worlds through multi-agent interactions. The system features:
+
+- Scene-based story progression with multiple character agents
+- Continuous updating of agent memories, status, and goals
+- World agent orchestration of the simulation
+- Support for human intervention and control
+- LLM-based story generation and refinement
+
+## Setup
+
+### Step 1. Clone the repository
+```bash
+git clone https://github.com/your-repo/bookworld.git
+cd bookworld
+```
+
+### Step 2. Install dependencies
+```bash
+pip install -r requirements.txt
+```
+
+### Step 3. Configure Simulation Settings
+- Update the configuration parameters in `config.json`:
+  - `role_llm_name`: LLM model for character roles
+  - `world_llm_name`: LLM model for world simulation
+  - `config_path`: The path to the experiment
+  - `if_save`: Enable/disable saving (1/0)
+  - `scene_mode`: Scene progression mode
+  - `rounds`: Number of simulation rounds
+  - `mode`: Simulation mode ("free" or "script")
+
+## Usage
+
+### Step 1. Start the server
+```bash
+python server.py
+```
+or
+```bash
+uvicorn server:app --host 127.0.0.1 --port 8000  
+```
+
+### Step 2. Access the web interface
+Open a browser and navigate to http://localhost:8000.
+
+### Step 3. Interact with the system
+- Start/pause/stop story generation
+- View character information and map details
+- Monitor story progression and agent interactions
+- Edit generated content if needed
+
+### Step 4. Continue from previous simulation
+Locate the directory of the previous simulation within `/experiment_saves/`, and set its path to the `save_dir` field in `config.json`.
+
+## Customization
+### Construct Your Virtual World
+1. Create the roles, map, worldbuilding following the examples given in `/data/`. You can improve the simulation quality by providing background settings about the world in `world_details/` or put character dialogue lines in `role_lines.jsonl`. Additionally, you can place an image named `icon.(png/jpg)` inside the character's folder — this will be used as the avatar displayed in the interface.
+3. Enter the preset path to `preset_path` in `config.json`.
+
+### Convert SillyTavern Character Cards to Role Data
+1. Put your character cards in `/data/sillytavern_cards/`.
+2. Run the script. It will convert all the cards into the role data that BookWorld needs.
+```bash
+python convert_sillytavern_cards_to_data.py
+```
+3. Input role codes of all the characters participating in this simulation to `role_agent_codes` in the preset file.
+
+## Directory Structure
+
+```
+.
+├── data/
+├── frontend/
+│   ├── assets/
+│   ├── css/
+│   └── js/
+├── modules/
+│   ├── db/
+│   ├── llm/
+│   ├── prompt/
+│   ├── main_role_agent.py
+│   └── world_agent.py
+├── experiment_configs/
+├── BookWorld.py
+├── server.py
+├── config.json
+└── index.html
+```
+
+
+## Authors and Citation
+**Authors:** Yiting Ran, Xintao Wang, Tian Qiu,
+Jiaqing Liang, Yanghua Xiao, Deqing Yang.
+
+```bibtex
+@misc{ran2025bookworldnovelsinteractiveagent,
+      title={BookWorld: From Novels to Interactive Agent Societies for Creative Story Generation}, 
+      author={Yiting Ran and Xintao Wang and Tian Qiu and Jiaqing Liang and Yanghua Xiao and Deqing Yang},
+      year={2025},
+      eprint={2504.14538},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2504.14538}, 
+}
+```
+## License
+
+This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+
+##  Acknowledgements
+
+- Fantasy Map: The background of map panel used in the frontend is from [Free Fantasy Maps](https://freefantasymaps.org/epic-world-cinematic-landscapes/), created by Fantasy Map Maker. This map is free for non-commercial use.
+
+## Contact
+
+BookWorld is a foundational framework that we aim to continuously optimize and enrich with custom modules. We welcome and greatly appreciate your suggestions and contributions!
+
+If you have any suggestions or would like to contribute, please contact us at: [email protected]
+

config.json

@@ -1,13 +1,13 @@
 {
-    "role_llm_name": "gpt-4o-mini",
-    "world_llm_name": "gpt-4o-mini",
+    "role_llm_name": "gemini-2",
+    "world_llm_name": "gemini-2",
     "embedding_model_name":"bge-m3",
     "preset_path":"./experiment_presets/example_free.json",
     "if_save": 0,
     "scene_mode": 1,
     "rounds": 10,
     "save_dir": "",
-    "mode": "free",
+    "mode": "script",
 
     "OPENAI_API_KEY":"",
     "GEMINI_API_KEY":"",

convert_sillytavern_cards_to_data.py

@@ -11,7 +11,7 @@ for name in names:
     path = os.path.join(card_dir, name)
     role_code = name.split('.')[0].replace(" ","_")
     if is_image(path):
-        with open(path, 'rb') as f:
+        with open(path, 'rb',encoding="utf-8") as f:
             image = Image.open(f)
             card_info = json.loads(decode_base64(image.text['chara']))
             language = lang_detect(card_info['data']['description'])