You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-9Lines changed: 42 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,26 +5,59 @@
5
5
# Detective 9 Text Based Game
6
6
7
7
## Overview
8
-
Detective Game is an interactive text-based game where you play the role of a detective. This sample is meant to show of Llama 3 from Meta running locally. The AI bot that is running on Llama 3 via Ollama assumes a random role related to a crime scenario. Your goal is to determine whether the AI bot is innocent or guilty through a series of questions.
8
+
Detective Game is an interactive text-based game where you play the role of a detective. This sample is meant to show off Llama 3 from Meta running locally. The AI bot that is running on Llama 3 via Ollama assumes a random role related to a crime scenario. Your goal is to determine whether the AI bot is innocent or guilty through a series of questions.
9
9
10
10
## Info
11
11
-**Llama 3**: Open source Large Language Model from Meta for generating AI responses.
12
12
-**Ollama**: Platform for running Llama 3 locally.
13
13
-**Rich**: Library for creating beautiful terminal outputs.
14
14
15
-
## Requirements
16
-
- Llama 3 model files (from Ollama)
17
-
-`python-dotenv` for environment variable management
18
-
-`rich` for terminal UI
19
-
-`langchain_community` for Llama 3 integration
15
+
### Requirements for Running the Source Code:
16
+
-**Llama 3 model files**: Required to generate AI responses (download from Ollama).
17
+
-**Python Libraries**:
18
+
-`python-dotenv`: For environment variable management.
The command `ollama run llama3` initializes and runs the Llama 3 model locally using the Ollama platform. Without this it will not generate AI responses.
27
31
28
-
Run the command `python startGame.py` to start the game.
32
+
### Method 1: Running the Source Code
29
33
34
+
1. **Initialize Llama 3**:
35
+
- Run the command`ollama run llama3` to initialize and run the Llama 3 model locally using the Ollama platform. This is required for generating AI responses.
30
36
37
+
2. **Install Dependencies**:
38
+
- Install the required Python packages by running:
39
+
```bash
40
+
pip install -r requirements.txt
41
+
```
42
+
43
+
3. **Start the Game**:
44
+
- Run the following command to start the game:
45
+
```bash
46
+
python startGame.py
47
+
```
48
+
49
+
### Method 2: Running the Executable
50
+
51
+
1. **Initialize Llama 3**:
52
+
- Just like with the source code method, you need to run the Llama 3 model:
53
+
```bash
54
+
ollama run llama3
55
+
```
56
+
57
+
2. **Run the Game**:
58
+
- Navigate to the `dist` folder where the executable is located.
59
+
- Double-click on `startGame.exe` to launch the game.
60
+
61
+
Alternatively, you can run the executable via the command line:
0 commit comments