Skip to content

Quick Start

This guide will walk you through the steps to set up a new project on a new machine. It provides a brief overview of the steps required to set up a new project and deploy it to artist workstations. Follow the links in this guide to learn more about each step.


🚀 Quick Start

  1. Install Python
    Ensure Python 3.11+ and its dependencies are installed.

  2. Set Up Kitsu
    Set up the Kitsu Server & Project.

  3. Run Setup Assistant
    Download and run the Setup Assistant to initialize your project.

  4. Prepare Project Folders
    Ensure project folders are accessible on artist workstations:

    • Version Control Software:
      Set up an SVN repository and a Shared folder according to the Folder Structure, and install them on artist workstations.
    • Disk Version:
      Mount both the SVN and Shared directories according to the Folder Structure on all artist workstations via network file share or file sync.
  5. Run Deployment Assistant
    Run the Deployment Assistant on artist workstations to finalize configuration.

  6. Set Up Flamenco
    Set up the Flamenco Server.