README Updates

GAME_RULES.MD

@@ -0,0 +1,18 @@
+## Game Rules
+
+You are playing a social deduction game where every player pretends the be the same animal. 
+During the round each player gets a turn to describe themselves using an "I"-statement as if they were the animal. 
+All but one of players know what animal they are pretending to be, collectively these players are called the Herd.
+The remaining player, known as the Chameleon, does not know what animal the others are pretending to be.
+The Chameleon must blend in by providing details about the animal using context from other players. 
+The Herd must be careful not to give away too much information with their responses so that Chameleon deduce the animal. 
+
+After all players have spoken, two thing will happen:
+1. The Chameleon will guess what animal the other players are pretending to be
+2. The Herd will vote on who they think the Chameleon is.
+ 
+The game is played in rounds, and the first player to reach 7 points wins. Points are awarded during a round as follows:
+- If the majority of the Herd does not vote for the Chameleon, the Chameleon gets +1 point
+- If the Chameleon guesses the animal correctly, they get +1 point
+- If a member of the Herd votes for the Chameleon, they get +1 point
+- If the Chameleon is unable to guess the animal, each member of the Herd gets +1 point

README.md

@@ -2,26 +2,27 @@
 
 *A social deduction game powered by LLMs*
 
-## Game Rules
+[Play Now](https://huggingface.co/spaces/ericbotti/chameleon)
 
-Chameleon is a social deduction game (a la Mafia, Among Us, etc.) about blending in, and finding out who doesn't belong.
+## Description
 
+Chameleon is a social deduction game (a la Mafia, Among Us, etc.) about blending in, and figuring out who doesn't belong.
 
 At the start of the game, each player is assigned one of two roles:
-- **The Herd**: The herd is a group of players who are all the same animal. They are trying to identify the chameleon hidden amongst them, while keeping the true animal a secret.
-- **The Chameleon**: The chameleon is pretending to be part of the herd. Their goal is to identify what animal the herd is while remaining undetected.
+- **Herd**: The herd is a group of players who are all the same animal. They are trying to identify the chameleon hidden amongst them, while keeping the true animal a secret.
+- **Chameleon**: This player is pretending to be part of the herd. Their goal is to identify what animal the herd is while remaining undetected.
 
-Each round, all players say something about themselves, in the form of a "I am a/have/do/etc..." sentence in 10 words or less. 
+See the [game rules file](GAME_RULES.md) for more details.
 
-After all players have spoken, the Chameleon is given the choice to guess what animal the herd is. If they guess correctly, they win. If they guess incorrectly, the herd wins.
+## Running the Game
 
-If the Chameleon chooses not to guess the herd then votes on what player they think the Chameleon is. 
-If the majority of the herd votes for the Chameleon, the herd wins. If the majority of the herd votes for a member of the herd, the Chameleon wins.
+The Easiest way to play the game is to use [Hugging Face Space Demo](https://huggingface.co/spaces/ericbotti/chameleon)
+
+If you want to run the game locally, you can clone the repository and run the game using the command line or the Streamlit app.
+
+1. **Using the command line**:
+    - Run `python src/main.py` from the root directory
+
+2. **Using the Streamlit App**:
+    - Run `streamlit run src/app.py` from the root directory
 
-Example Round:
-*The secret animal is an owl Owl*
-Herd player 1: I have sharp claws.
-Herd player 2: I am a creature of the night.
-Herd player 3: I soar the skies looking for prey.
-Herd player 4: I have a keen eye.
-Chameleon: I am a predator.

src/prompts.py

@@ -8,24 +8,9 @@ def format_prompt(prompt_name, **kwargs):
     return fetch_prompt(prompt_name).format(**kwargs)
 
 
-_game_rules = '''\
-You are playing a social deduction game where every player pretends the be the same animal. 
-During the round each player gets a turn to describe themselves using an "I"-statement as if they were the animal. 
-All but one of players know what animal they are pretending to be, collectively these players are called the Herd.
-The remaining player, known as the Chameleon, does not know what animal the others are pretending to be.
-The Chameleon must blend in by providing details about the animal using context from other players. 
-The Herd must be careful not to give away too much information with their responses so that Chameleon deduce the animal. 
-
-After all players have spoken, two thing will happen:
-1. The Chameleon will guess what animal the other players are pretending to be
-2. The Herd will vote on who they think the Chameleon is.
- 
-The game is played in rounds, and the first player to reach 7 points wins. Points are awarded during a round as follows:
-- If the Chameleon remains undetected, they get +1 point
-- If the Chameleon guesses the animal correctly, they get +1 point
-- If a member of the Herd votes for the Chameleon, they get +1 point
-- If the Chameleon is unable to guess the animal, each member of the Herd gets +1 point
-'''
+# Get game rules from GAME_RULES.md
+with open("GAME_RULES.md", "r") as file:
+    _game_rules = file.read()
 
 _assign_herd = """\
 You are a **{herd_animal}**, keep this secret at all costs and figure which player is not really a {herd_animal}