Directory Setup

Let's set up your project structure. This takes about two minutes and gets you ready to build your first SYNQ rotation.

Choose a Project Name

Pick a simple name for your routines folder. For this guide, we'll use example:

synq/routines/example/

Keep it simple—no spaces or special characters. This folder will hold all your rotation files.

Create Your Project Structure

Step 1: Navigate to your SYNQ folder (located in your unlocker directory)
Step 2: Create the project directory:

synq/routines/example/

This becomes your project root where all your rotation files will live.

Create Your Core Config File

Create example.lua in your project folder. This file registers your rotation actors with SYNQ:

local Unlocker, synq, example = ...

example.hunter = {
  bm = synq.Actor:New({ spec = 1, class = "hunter" }),
  mm = synq.Actor:New({ spec = 2, class = "hunter" }),
  sv = synq.Actor:New({ spec = 3, class = "hunter" }),
}

Important: Any rotation files you create must be registered here, otherwise SYNQ won't load them.

Verify SYNQ is Working

Test that SYNQ is loaded correctly. In game chat, run:

/dump synq.hello

If you see a message, SYNQ is loaded and ready. If not, double-check that SYNQ is properly installed in your unlocker folder.

Next: Create your rotation actor in Routine Actor & File Layout.