This section will help you get set up with the game environment on your local computer.

🐍 Step 1: Install Python 3

To run the game, you will need a working version of Python 3.

To check what version of Python you have, type the following into your terminal:

python --version

Some helpful articles on installing Python 3:

Mac 🍎: https://programwithus.com/learn-to-code/install-python3-mac/

Windows ⌨️: https://realpython.com/installing-python/#how-to-install-python-on-windows

If you're unfamiliar with Python, we highly recommend looking online for some Python tutorials to get familiar working with indexing, classes/objects, and functions and then using this tutorial to practise what you've learnt.

🎮 Step 2: Install the game environment

Option A: Use the Installation Package via GitHub (Recommended)

1. Head over to our GitHub Repo containing the game environment:

🐉 Dungeons and Data Structures Releases

2. Go to the most recent release and click the file coderone-challenge-dungeons-xxxxx.tar.gz under 'Assets' to download it.

The most recent release may have a different -xxx.tar.gz number to the image shown above. Please ensure you are installing the most recent version.

3. Install the game environment:

🍎 MacOS/ 🐧 Linux

Assuming ~/workspace is the directory you want to use to develop your AI-agent, open your terminal and run:

# Create a working directory for your project:
> mkdir -p ~/workspace/my-agent

# Change into that directory
> cd ~/workspace/my-agent

# Create a python virtual environment. Lets call it venv
> python3 -m venv venv
# Activate your new python environment
> source venv/bin/activate

# Install the Coder One Dungeon module you have previously downloaded:
> pip install ~/Downloads/coderone-challenge-dungeon-0.1.4.tar.gz

💻 Windows:

Similar to the instructions for MacOS/Linux, open your terminal (Press Windows + R, type "cmd" and press CTRL+SHIFT+ENTER to open as administrator) and run:

# Create a working directory for your project:
> mkdir -p workspace\my-agent

# Change into that directory
> cd workspace\my-agent

# Create a python virtual environment. Lets call it venv
> python3 -m venv venv
# Activate your new python environment
> venv\Scripts\activate

# Install Coder One Dungeon module you have previously downloaded:
> pip install %UserProfile%\Downloads\coderone-challenge-dungeon-0.1.4.tar.gz

Option B: Using Git

1. Alternatively, you can open your terminal and clone our GitHub Repo using: