Develop

Setup

Important

Prerequisites:

Windows 10+

- show

Install Git

Linux

- show

Install libportaudio2, ffmpeg and toga

MacOS 13+ (Ventura-Sequoia)

- show

Install xcode-select (optionally brew) from Terminal app:

xcode-select --install

brew install ffmpeg

Tip

OPTIONAL: Graphics card installation instructions

- show

NVIDIA

- show

NVIDIA Drivers

CUDA Toolkit for gguf support

linux [export CMAKE_ARGS="-DGGML_CUDA=on"] -windows [setx CMAKE_ARGS="-DGGML_CUDA=on"] for OUTETTS support

AMD

- show

AMD Drivers

ROCm/HIP SDK Windows for gguf support

ROCm SDK Linux for gguf support

linux [export CMAKE_ARGS="-DGGML_HIPBLAS=on"] -windows [setx CMAKE_ARGS="-DGGML_HIPBLAS=on"] for OUTETTS support

INTEL

- show

INTEL drivers

APPLE

- show

Open Terminal and type:

xcode-select --install

type export CMAKE_ARGS="-DGGML_METAL=on" for OUTETTS support

If you have XCode or are interested in Apple's code editor, you can opt to use that instead. XCode ( via. Developer Site | Via App Store) (40gb)

>

Our Python tools use uv. Use a terminal to git clone a project:

• The main Shadowbox repo

  git clone https://github.com/darkshapes/sdbx
  cd sdbx
  

  Windows systems only:

  uv python install 3.12
  uv python pin 3.12
  

  then:

  uv sync --group dev --extra cuda
  

  If you have a different graphics card (or none), replace cuda with xpu,mps, rocm, or just use cpu

Once installed, activate the python environment in

• Linux/Macos:

  source .venv/bin/activate
  

  Windows Powershell:

  Set-ExecutionPolicy Bypass -Scope Process -Force; .venv\Scripts\Activate.ps1
  

You can also run a single session without installation (from sdbx, Zodiac, or nnll):

• Run Shadowbox without installing

  uvx --from git+https://github.com/darkshapes/sdbx sdbx
  

Other projects [Optional]

These repos may be cloned separately to work on individual components of Shadowbox

git clone https://github.com/darkshapes/nnll
cd nnll

git clone https://github.com/darkshapes/zodiac
cd zodiac

git clone https://github.com/darkshapes/mir
cd mir

then:

uv sync --group dev

For singularity :

We use Bun for TypeScript/React projects.

Clone the repo

git clone https://github.com/darkshapes/singularity

Then install and open your dev copy:

cd singularity
bun install
bun run dev

Alternative Pip Setup [Legacy, Not recommended..]

• Follow the Python instructions

• Configure advanced GPU settings (OPTIONAL. Linux, flash-attn, PyTorch compile, etc)

• Clone your repo(s)

  For sdbx :

  git clone https://github.com/darkshapes/sdbx
  pip install -e "sdbx[dev]"
  sdbx
  ```<hr>
  

  For nnll :

  git clone https://github.com/darkshapes/nnll
   pip install -e "zodiac[dev]"
  

  For mir :

  git clone https://github.com/darkshapes/nnll
   pip install -e "zodiac[dev]"
  

  For Zodiac :

  git clone https://github.com/darkshapes/zodiac.git
  pip install -e "zodiac[dev]"
  

Directions for use

Happy Hacking!