Welcome! This guide will help you install everything you need to run Ollama Dungeon, even if you've never used GitHub or Python before. Follow each step carefully!
Git lets you download this project. Download and install it from the official site:
How to install:
- Click the link above and download the installer.
- Run the downloaded file (
Git-*-64-bit.exe
). - Click "Next" through all the steps (default options are fine for beginners).
- When finished, you can close the installer.
Python is the programming language for this project.
Download Python 3.12.7 for Windows (64-bit)
How to install:
- Click the link above and download the installer.
- Run the downloaded file.
- IMPORTANT: On the first screen, check the box that says "Add Python to PATH".
- Click "Install Now" and wait for it to finish.
- When done, close the installer.
- Open the Windows Start menu, type
cmd
, and press Enter to open the Command Prompt. - Type
python --version
and press Enter. You should see something likePython 3.12.7
. - Type
pip --version
and press Enter. You should see a version number. If you see an error, restart your computer and try again.
- In the Command Prompt, type:
git clone https://github.com/cyberofficial/Ollama-Dungeon.git
- Press Enter. This will create a folder called
Ollama-Dungeon
with all the files. - Move into the folder:
cd Ollama-Dungeon
A virtual environment keeps your Python packages isolated for this project.
- In the Command Prompt (inside the
Ollama-Dungeon
folder), type:
python -m venv venv
This creates a folder named venv
with your isolated environment.
- Activate the virtual environment:
venv\Scripts\activate
(You should see (venv)
at the start of your command line now.)
- With the virtual environment activated, type:
pip install -r requirements.txt
- Wait for all packages to finish installing.
Ollama supports many different models. The game is tested with the qwen3 models, but you can use any compatible model you prefer.
Recommended (but not required):
ollama pull qwen3:4b
ollama pull qwen3:8b
You can also pull and use other models from the Ollama model library.
Start the Ollama server (required for any model):
ollama serve
Leave ollama serve
running in its window while you play.
- In a new Command Prompt window (still in the
Ollama-Dungeon
folder), type:
python main.py
- The game will start! Follow the on-screen instructions to play.
- If you get errors about missing commands, try restarting your computer.
- If you see "Can't connect to Ollama", make sure
ollama serve
is running. - For more help, see the Troubleshooting section at the bottom of the README.md.