Getting Started

Quick Reference

Overview

ClibDT (CommonLib Developers Toolkit) is a PyQt6 application designed to streamline SKSE plugin development for Skyrim Special Edition. It provides:

• Tool installation helpers - Guided installation of VS Build Tools, xmake, and Git
• Project scaffolding - Create new CommonLibSSE-NG projects from a working template
• Build management - Compile projects with xmake for SE, AE, VR, or dual runtimes
• Environment configuration - Manage development paths and environment variables
• Backup utilities - Protect your work with backup features

ClibDT significantly lowers the barrier to entry for SKSE plugin development. Setting up a CommonLib development environment traditionally requires navigating scattered documentation, manually configuring build systems, and troubleshooting cryptic errors. ClibDT consolidates this process into a guided workflow, though you'll still need to learn C++ and understand how SKSE plugins work.

Requirements

System Requirements

• Windows 10 or later (64-bit)
• At least 10 GB free disk space for tools and projects
• Internet connection for downloading tools and templates

Tools (Installed via ClibDT)

Initial Setup

Step 1: Choose a Development Root

1. Open ClibDT
2. Go to Set Paths in the left panel
3. Click Choose Folder under "Development Root Folder"
4. Select or create a folder (e.g., C:\Dev\Skyrim)

ClibDT will automatically create the following structure:

Dev Root/
├── builds/       # Compiled plugin outputs (DLL files)
├── projects/     # Your SKSE plugin source code
├── tools/        # Development tools (xmake, Build Tools)
├── resources/    # Headers, libraries, CommonLibSSE
├── plugins/      # SKSE plugin dependencies
└── backups/      # Automatic project backups

Step 2: Install Development Tools

1. Go to Install Toolchain in the left panel
2. Click Install next to each tool:
   • VS Build Tools - The C++ compiler
   • xmake - Build system
   • Git - Version control
3. Wait for each installation to complete
4. Green status indicators show installed tools

Step 3: Configure Game Path (Optional)

If you want compiled plugins to be automatically copied to your mods folder:

1. Go to Set Paths
2. Set Game Path to your Skyrim SE installation folder
3. Set Mods Path to your mod organizer's mods directory

Creating Your First Project

Step 1: Open Create Project

1. Go to Create Project in the left panel
2. Enter a Project Name (e.g., MyFirstPlugin)
3. The Location will default to your projects folder

Step 2: Configure Project Metadata

Step 3: Create the Project

1. Click Create
2. ClibDT will:
   • Clone the CommonLibSSE-NG template
   • Install ClibUtil and xbyak dependencies
   • Generate xmake.lua build configuration
   • Initialize Git repository (if selected)
3. Your project is ready at projects/MyFirstPlugin

Building Your Project

Step 1: Select Your Project

1. Go to Compile Project in the left panel
2. Select your project from the Project dropdown

Step 2: Configure Build Options

Step 3: Compile

1. Click Compile
2. Build output appears in the terminal panel at the bottom
3. On success, your DLL is in the project's build folder

xmake f -m release --skse_runtime=ae
xmake

Folder Structure Reference

Environment Variables

ClibDT manages these environment variables:

Development Workflow