# Alterchase SDK Quick Start Guide

Get started creating mods for Alterchase in 5 minutes!

## Step 1: Create Your First Mod Asset

Choose what type of content you want to create:

### Creating a Level
1. Right-click in Project window → `Create > Alterchase SDK > Level Mod Asset`
2. Name it (e.g., "MyCustomLevel")
3. Assign your scene asset
4. Set difficulty and other properties
5. Click "Validate" in the Inspector

### Creating a Model
1. Right-click in Project window → `Create > Alterchase SDK > Model Mod Asset`
2. Name it (e.g., "MyCustomProp")
3. Assign your model prefab
4. Configure physics and interaction settings
5. Click "Validate" in the Inspector

### Creating an Enemy
1. Right-click in Project window → `Create > Alterchase SDK > Enemy Mod Asset`
2. Name it (e.g., "MyCustomEnemy")
3. Assign your enemy prefab
4. Set health, damage, and AI behavior
5. Click "Validate" in the Inspector

## Step 2: Create a Mod Package

1. Open `Alterchase SDK > Mod Package Builder`
2. Click **"Create New"**
3. Fill in your information:
   - Package Name: "My First Mod"
   - Author Name: Your name
   - Version: 1.0.0
   - Description: What your mod does
   - Package Icon: 512x288 pixels (16:9 ratio) - PNG or JPG format recommended
4. Save the package

> **📸 Icon Requirements:**
> - Recommended size: **512x288 pixels** (16:9 aspect ratio)
> - Maximum size: 8MB
> - Supported formats: PNG, JPG
> - This ensures compatibility with mod.io and optimal display quality

## Step 3: Add Assets to Your Package

1. Select your Mod Package in the Project window
2. In the Inspector, find the Package Contents section
3. Drag your mod assets into the appropriate lists:
   - Levels list for Level Mod Assets
   - Models list for Model Mod Assets
   - Enemies list for Enemy Mod Assets

## Step 4: Validate and Build

1. In **Mod Package Builder**, select your package
2. Click **"Validate Package"**
3. Fix any errors that appear
4. Click **"Build Asset Bundles"**
5. Wait for the build to complete

## Step 5: Test Your Mod

### Option A: Use the Mod Tester Window (Recommended)

1. Open `Alterchase SDK > Mod Tester`
2. Click **"Browse"** and select your built asset bundle file (in `Builds/Mods/[YourModName]/`)
3. Click **"Load Asset Bundle"**
4. Review your package information and loaded assets
5. Test individual assets:
   - **Levels**: Click "Load & Test Scene" to create a test environment
   - **Models**: Click "Spawn in Scene" to place models in your current scene
   - **Enemies**: Click "Spawn in Scene" to test enemy prefabs
6. Click **"Enter Play Mode"** to test your mod in action
7. Click **"Unload"** when finished testing

### Option B: Manual Testing with Script

Create a test scene to verify your mod works:

```csharp
using AlterchaseSDK;
using UnityEngine;

public class ModTester : MonoBehaviour
{
    public ModPackage testPackage;
    
    void Start()
    {
        ModLoader.Instance.LoadModPackage(testPackage);
        
        // Test spawning a model
        var models = ModLoader.Instance.GetAllAssetsOfType<ModelModAsset>();
        foreach (var model in models)
        {
            ModLoader.Instance.SpawnModel(model, Vector3.zero, Quaternion.identity);
        }
    }
}
```

## Step 6: Distribute Your Mod

After building your mod package, you can distribute it to players:

1. Locate your built mod files in the output directory (default: `ModBuilds/[YourModName]`)
2. Share the mod files with players or upload them to your preferred distribution platform
3. Players can install your mod by placing it in their game's mods folder

For detailed distribution instructions, see the [DISTRIBUTION_GUIDE.md](DISTRIBUTION_GUIDE.md).

## That's It!

Your mod is ready to share with Alterchase players!

## Next Steps

- Browse the full [README.md](README.md) for detailed information
- Check out the example assets in the Templates folder
- Join the Alterchase Discord for mod creator support
- Share your creations with the community!

## Common Issues

**"Validation Failed"**
- Make sure all required fields are filled in
- Check that prefabs and assets are properly assigned
- Ensure scene paths are correct for level mods

**"Build Failed"**
- Verify all assets exist in your project
- Check the console for specific error messages
- Make sure no assets are missing references

**"Upload Failed"**
- Confirm you're authenticated with mod.io
- Check your internet connection
- Verify asset bundles were built successfully

---

Need help? Check the README or visit our Discord community!
