PierreBrunelle commited on
Commit
22e40bb
·
verified ·
1 Parent(s): 3d99571

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -1
README.md CHANGED
@@ -11,4 +11,43 @@ license: apache-2.0
11
  short_description: An interactive RPG experience
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  short_description: An interactive RPG experience
12
  ---
13
 
14
+ # 🎲 AI RPG Adventure
15
+
16
+ An interactive text-based RPG powered by Pixeltable and OpenAI that creates dynamic, responsive storytelling experiences. Players can embark on adventures across different genres with AI-generated narratives that adapt to their choices.
17
+
18
+ ## 🚀 Features
19
+ - Dynamic storytelling with AI-generated narratives
20
+ - Multiple genre support (Fantasy, Sci-Fi, Horror, etc.)
21
+ - Player choice tracking and game state management
22
+ - Adventure history logging
23
+ - Real-time story generation
24
+
25
+ ## 🛠️ Requirements
26
+ - Python 3.8+
27
+ - Pixeltable
28
+ - OpenAI API key
29
+ - Gradio
30
+
31
+ ## 🎮 Quick Start
32
+ 1. Install dependencies: `pip install pixeltable gradio openai`
33
+ 2. Set your OpenAI API key
34
+ 3. Run the application: `python app.py`
35
+ 4. Input your character's name, choose a genre, and start your adventure!
36
+
37
+ ## 🎯 Example Adventures
38
+ 1. **Magical Academy**
39
+ ```
40
+ Name: Novice Thalia
41
+ Genre: 🧙‍♂️ Fantasy
42
+ Scenario: It's your first day at the Celestial Academy of Arcane Arts. During the sorting ceremony, your magical aura suddenly starts behaving strangely, catching the attention of the ancient sorting crystal...
43
+ ```
44
+
45
+ 2. **Space Pirate**
46
+ ```
47
+ Name: Captain Zara
48
+ Genre: 🚀 Sci-Fi
49
+ Scenario: Your smuggling ship is docked at a secret trading post in the Andromeda Nebula. As you're finalizing a deal for mysterious cargo, your ship's AI reports that Imperial cruisers are entering the system...
50
+ ```
51
+
52
+ ## 📝 Credits
53
+ Built with [Pixeltable](https://github.com/pixeltable/pixeltable) | Licensed under Apache 2.0