Documentation/Tutorials/Quick Start Guide

Quick Start Guide

Set up your development environment and create your first game in under 5 minutes.

Welcome to StarForge!

This guide will help you get up and running with StarForge in just a few minutes. By the end, you'll have created your first simple game.

Prerequisites

  • A computer running Windows 10+, macOS 10.15+, or Ubuntu 20.04+
  • A StarForge account (you can create one here)

Step 1: Download the Client

Visit the Downloads page and download the StarForge client for your operating system.

Step 2: Install and Launch

Run the installer and follow the on-screen instructions. Once installed, launch the StarForge application.

Step 3: Create a New Game

Click "New Game" in the editor and give your game a name. You'll see a blank world with a default camera.

Step 4: Add Some Objects

Use the "Add Object" menu to add some basic shapes to your world. Try adding a Part and changing its color!

Step 5: Write Your First Script

Add a Script to your game and paste the following code:

-- My first script!
print("Hello, StarForge!")

-- Move a part up and down
local part = new("Part")
part.Name = "BouncingPart"
part.Position = Vector3.new(0, 5, 0)

while true do
    for i = 0, 10 do
        part.Position = Vector3.new(0, 5 + i * 0.5, 0)
        wait(0.1)
    end
    for i = 10, 0, -1 do
        part.Position = Vector3.new(0, 5 + i * 0.5, 0)
        wait(0.1)
    end
end

Step 6: Test Your Game

Click the "Play" button to test your game. You should see the part bouncing up and down!

Next Steps

Congratulations! You've created your first StarForge game. Here are some suggested next steps:

All Tutorials