openstoryline-install

OpenStoryline Install

Use this skill when the task is to install or repair a local source checkout of FireRed-OpenStoryline.

Keep the workflow deterministic:

1. Confirm the repo path and read the current README.md and config.toml.
2. Detect local prerequisites before changing anything.
3. Prefer a local venv install unless the user explicitly asks for Docker or conda.
4. Download resources only after Python dependencies succeed.
5. Validate imports and config loading before claiming success.
6. This skill assumes macOS, Linux, or WSL with a POSIX shell.

What This Skill Covers

• Clone the GitHub repo if needed
• Create a Python environment
• Install Python dependencies
• Download .storyline models and resource/ assets
• Fill config.toml model settings
• Start MCP and web servers
• Explain common installation/documentation gaps

Preconditions

Check these first:

• git
• Python >= 3.11
• ffmpeg
• wget
• unzip

Optional:

• docker
• conda

If ffmpeg, wget, or unzip are missing, install them through the OS package manager before continuing.

Examples:

• macOS with Homebrew:

  brew install ffmpeg wget unzip
  

• Debian/Ubuntu:

  sudo apt-get update
  sudo apt-get install -y ffmpeg wget unzip
  

If no supported package manager or permission is available, stop and report the missing system dependency clearly.

Interpreter selection

First prefer any interpreter that already exists and passes version checks:

1. A system Python >= 3.11
2. An already available conda Python >= 3.11
3. An already available pyenv Python >= 3.11, but only if basic stdlib modules work

Validate candidate interpreters before using them:

/path/to/python -c "import ssl, sqlite3, venv; print('stdlib_ok')"

If no supported interpreter already exists, peferr conda fallback:

conda create -y -n openstoryline-py311 python=3.11
conda run -n openstoryline-py311 python --version
conda run -n openstoryline-py311 python -m venv .venv