AP Data Scripts

Some scripts to help me learn python. Used to look at Archipelago data

get_room_data.py - Gets data for an Archipelago room and stores to json
create_hint_graph.py - Make a hint graph using the room data from above. Has a good number of options to show the data in different ways
create_goal_data.py - Parses room data and outputs relevant goal data. Only supports Pokemon Emerald for now

Typical order of how to run scripts

flowchart TD;
   A["get_room_data.py (at least once)"];
   B[create_hint_graph.py];
   C[create_goal_data.py];
   A --> B;
   A --> C;

Loading

Run each python script with the -h or --help argument to see what you can do

python get_room_data.py -h

Setup

First time setup

# Linux only. Look up your specific package manager if you don't use apt
sudo apt install build-essential graphviz libgraphviz-dev

# Create a python virtual environment
python -m venv .venv

# Start the virtual environment
source .venv/bin/activate # bash
.\.venv\Scripts\Activate.ps1 # powershell

# Upgrade pip
pip install --upgrade pip

# Install python depedencies. Use the file that matches your OS
# Note: mac os is untested. Try using requirements_windows.txt for mac os
pip install -r requirements_linux.txt
pip install -r requirements_windows.txt

Every time you open a new terminal after the first time setup is complete

source .venv/bin/activate # bash
.\.venv\Scripts\Activate.ps1 # powershell