Quick Setup Guide

Get your first automated build running in 15 minutes

Before You Begin

Make sure you have:

• Admin access to your build server (Jenkins, TeamCity, etc.)
• Repository access (Git, Perforce, etc.)
• 15 minutes of uninterrupted time

Step 1: Create Your Project

1. Sign in to ButterStack
2. Click “New Project” from the dashboard
3. Enter your project details:

Project Name: My Game
Project Type: Game Development
Engine: Unreal Engine 5.3
Primary Platform: Windows

1. Click “Create Project”

Step 2: Connect Your Build System

Option A: Jenkins (Recommended)

1. Navigate to Integrations → Add Integration
2. Select Jenkins
3. Enter your Jenkins details:

Jenkins URL: https://jenkins.yourdomain.com
Username: your-username
API Token: [Generate from Jenkins]

1. Click “Test Connection”
2. Once verified, click “Save Integration”

Option B: GitHub Actions

1. Navigate to Integrations → Add Integration
2. Select GitHub Actions
3. Authorize ButterStack to access your repository
4. Select repositories to monitor

Step 3: Configure Your First Build

1. Go to Build Configurations
2. Click “New Configuration”
3. Use our quick template:

1. Customize the configuration:

Build Name: Nightly Game Build
Target: Game
Configuration: Development
Platforms: [Win64, Linux]
Triggers: 
  - Push to main branch
  - Commits with #ci tag

Step 4: Test Your Setup

1. Make a test commit to your repository:

git add .
git commit -m "Test ButterStack integration #ci"
git push origin main

1. Watch the magic happen:
   • ButterStack detects the commit
   • Triggers your Jenkins/GitHub Actions build
   • Updates status in real-time
   • Notifies your team when complete

Step 5: Add Team Notifications (Optional)

Keep your team informed with automated notifications:

Slack Integration

1. Go to Integrations → Add Integration → Slack
2. Click “Add to Slack”
3. Select your channel
4. Choose notification types:
   • ✅ Build Started
   • ✅ Build Completed
   • ✅ Build Failed

Discord Integration

1. Go to Integrations → Add Integration → Discord
2. Add webhook URL from Discord
3. Configure notification preferences

What’s Next?

Now that you have basic automation working:

Troubleshooting

Build Not Triggering?

1. Check webhook delivery in your Git provider
2. Verify commit message includes #ci tag
3. Ensure Jenkins job is not paused

Connection Failed?

1. Verify firewall allows ButterStack IPs
2. Check API token has correct permissions
3. Test connection with curl:

curl -u username:token https://jenkins.yourdomain.com/api/json