Welcome developers! We'd love to feature your game on the Realms World site. Follow this guide to add your game to our showcase.

• Your game should be built on or integrated with the Realms ecosystem
• Have all required assets ready (images, screenshots)
• Basic knowledge of Git and GitHub

# Fork the repository on GitHub first, then:
git clone https://github.com/YOUR_USERNAME/realms-world-site.git
cd realms-world-site

Create a folder for your game in public/games/ with your game's slug name:

mkdir -p public/games/your-game-name/screenshots

Add the following assets:

• cover.png or cover.webp - Your game's cover image (recommended: 16:9 aspect ratio)
• screenshots/ folder - Add numbered screenshots (1.png, 2.png, etc.)

Edit src/data/games.ts to add your game information:

{
  id: 14, // Use the next available ID
  slug: "your-game-slug", // URL-friendly name (lowercase, hyphens)
  title: "Your Game Title",
  image: "/games/your-game-slug/cover.png",
  backgroundImage: "/games/your-game-slug/cover.png",
  backgroundImages: [
    "/games/your-game-slug/screenshots/1.png",
    "/games/your-game-slug/screenshots/2.png",
    // Add more screenshots as needed
  ],
  genre: ["Genre1", "Genre2"], // e.g., ["Strategy", "PvP", "RPG"]
  description: "A compelling description of your game...",
  status: "development", // Options: "mainnet" | "testnet" | "development"
  isLive: true, // Is the game currently playable?
  studio: "Your Studio Name",

  // Optional fields:
  players: 1000, // Current player count
  tvl: 500000, // Total Value Locked in USD
  whitepaper: "https://your-whitepaper-url.com",
  video: "https://www.youtube.com/embed/VIDEO_ID", // YouTube embed URL

  links: {
    homepage: "https://your-game.com",
    discord: "https://discord.gg/your-invite",
    twitter: "https://twitter.com/your-handle",
    telegram: "https://t.me/your-channel",
    github: "https://github.com/your-repo"
  }
}

• Cover Image: 16:9 aspect ratio recommended, min 1200x675px
• Screenshots: Same aspect ratio for consistency
• File Formats: Use .webp for better compression or .png for transparency
• File Size: Keep images under 500KB each for optimal loading

# Install dependencies
pnpm install

# Run development server
pnpm dev

# Visit http://localhost:5173 to see your game

1. Commit your changes:

git add .
git commit -m "Add [Your Game Name] to games showcase"

2. Push to your fork:

git push origin main

3. Create a Pull Request on GitHub with:
   • Clear title: "Add [Game Name] to showcase"
   • Description including:
     • Brief game overview
     • Link to live game (if available)
     • Any special requirements or notes

Before submitting, ensure:

• All images are properly sized and optimized
• Game data includes all required fields
• Links are working and correct
• Description is clear and compelling
• Status accurately reflects game state
• Code follows existing formatting

• Join our Discord for support
• Check existing games in src/data/games.ts for examples
• Open an issue if you encounter problems

We're excited to showcase your game in the Realms ecosystem! 🎮