# Alterchase SDK - Image Requirements Guide

This guide covers all image and icon requirements for creating mods with the Alterchase SDK.

## Package Icons

Package icons are displayed on mod.io and in the game's mod browser.

### Requirements
- **Size**: 512x288 pixels (16:9 aspect ratio)
- **Format**: PNG or JPG
- **Maximum File Size**: 8MB
- **Color Space**: sRGB

### Best Practices
- Use clear, recognizable imagery that represents your mod
- Avoid text that's too small to read at thumbnail size
- Use high contrast colors for better visibility
- Test how your icon looks at different sizes
- Include your mod name or logo if space permits

### Common Mistakes to Avoid
❌ Using images that are too small (will look pixelated when scaled up)  
❌ Using the wrong aspect ratio (will be stretched or cropped)  
❌ Text that's unreadable at thumbnail size  
❌ Low contrast images that don't stand out  

## Level Preview Images

Level previews help players understand what your level looks like before downloading.

### Requirements
- **Recommended Size**: 1920x1080 pixels (Full HD)
- **Alternative Size**: 1280x720 pixels (HD)
- **Aspect Ratio**: 16:9
- **Format**: PNG or JPG
- **Maximum File Size**: 8MB per image

### Best Practices
- Capture screenshots from interesting gameplay angles
- Show the level's unique features and environments
- Use the best lighting and post-processing settings
- Capture multiple preview images showing different areas
- Avoid UI elements in screenshots when possible

### Capture Tips
1. Use Unity's Recorder package for high-quality captures
2. Set your Game View to 1920x1080 resolution
3. Disable UI overlays before capturing
4. Use good camera angles that showcase your level design
5. Consider using the Frame Debugger for perfect captures

## Model Preview Images

While not required, preview images help showcase your 3D models.

### Recommended Specifications
- **Size**: 1024x1024 pixels (square) or 1920x1080 pixels (16:9)
- **Format**: PNG (with transparency if needed) or JPG
- **Maximum File Size**: 8MB

### Best Practices
- Use neutral backgrounds or transparent backgrounds
- Show the model from multiple angles
- Include a sense of scale (e.g., next to a reference object)
- Use good lighting to show model details
- Consider creating turntable GIFs for complex models

## Enemy Preview Images

Help players visualize your custom enemies.

### Recommended Specifications
- **Size**: 1024x1024 pixels (square) or 1920x1080 pixels (16:9)
- **Format**: PNG or JPG
- **Maximum File Size**: 8MB

### Best Practices
- Show the enemy in an action pose or idle stance
- Include multiple views (front, side, back)
- Show attack animations if possible
- Use in-game lighting and environments
- Display the enemy's size relative to the player

## Texture Sizes for Assets

When creating textures for your 3D models, follow these guidelines:

### Standard Texture Sizes
- **Characters/Enemies**: 2048x2048 or 4096x4096 (for hero assets)
- **Props/Models**: 1024x1024 to 2048x2048
- **Environment Textures**: 1024x1024 to 2048x2048
- **UI Elements**: 512x512 or 1024x1024

### Performance Considerations
- Use texture compression (DXT5 for color + alpha, DXT1 for color only)
- Consider mipmaps for 3D textures
- Use power-of-two dimensions (512, 1024, 2048, 4096)
- Keep total texture memory budget in mind
- Use texture atlases when possible

## Image Optimization Tips

### File Size Optimization
1. **Compress images** without losing quality:
   - Use tools like TinyPNG, ImageOptim, or Squoosh
   - JPG quality 85-90 is usually optimal
   - PNG can be compressed losslessly

2. **Resize appropriately**:
   - Don't upload images larger than required
   - Scale down high-res images before import

3. **Choose the right format**:
   - PNG for images with transparency or crisp details
   - JPG for photos and complex images without transparency
   - Avoid BMP or uncompressed formats

### Unity Import Settings
```
Texture Type: Default (for most textures)
Max Size: Match your source image size or lower
Compression: High Quality (or Normal Maps for normal maps)
Generate Mip Maps: Enabled for 3D textures
sRGB: Enabled for color textures, disabled for data textures
```

## Quick Reference Table

| Image Type | Recommended Size | Aspect Ratio | Format | Max Size |
|------------|-----------------|--------------|---------|----------|
| Package Icon | 512x288 | 16:9 | PNG/JPG | 8MB |
| Level Preview | 1920x1080 | 16:9 | PNG/JPG | 8MB |
| Model Preview | 1024x1024 | 1:1 | PNG/JPG | 8MB |
| Enemy Preview | 1024x1024 | 1:1 | PNG/JPG | 8MB |
| Character Texture | 2048x2048 | 1:1 | PNG | - |
| Prop Texture | 1024x1024 | 1:1 | PNG | - |

## mod.io Specific Requirements

When uploading to mod.io, follow these additional guidelines:

### Logo/Icon
- **Dimensions**: 512x288 (required ratio)
- **Format**: PNG, JPG, or GIF
- **Max File Size**: 8MB

### Gallery Images
- **Recommended**: 1280x720 or higher
- **Format**: PNG, JPG, or GIF
- **Max File Size**: 8MB per image
- **Max Count**: Up to 10 images

### Header Image (Optional)
- **Recommended**: 1920x1080
- **Format**: PNG or JPG
- **Max File Size**: 8MB

## Testing Your Images

Before publishing, verify your images:

1. ✅ Check dimensions match requirements
2. ✅ Verify file sizes are under 8MB
3. ✅ Test visibility at different sizes (thumbnail, full screen)
4. ✅ Ensure colors are accurate (use sRGB color space)
5. ✅ Confirm images represent your mod well
6. ✅ Check that text is readable if included

## Tools and Resources

### Image Editing
- **Adobe Photoshop** - Industry standard
- **GIMP** - Free alternative
- **Paint.NET** - Simple and free
- **Krita** - Free, artist-friendly

### Compression
- **TinyPNG** - https://tinypng.com
- **Squoosh** - https://squoosh.app
- **ImageOptim** (Mac) - https://imageoptim.com

### Screenshot Tools
- **Unity Recorder Package** - Built into Unity
- **ShareX** (Windows) - Free screenshot tool
- **Lightshot** - Cross-platform screenshot tool

## Need Help?

If you have questions about image requirements:
- Check the [README.md](README.md) for general SDK documentation
- Review the [QUICKSTART.md](QUICKSTART.md) for quick setup
- Visit the Alterchase Discord for community support

---

**Last Updated**: For Unity 6000.2 compatibility
