Game Title

A detailed description of your game. This section will appear below the game canvas.

How to Play

Explain your game's controls and objectives here. For example: Use WASD or arrow keys to move Space to jump Click to interact etc.

Credits

List any assets, libraries, or other resources you used: Sound effects from [source] Art by [artist] Built with [framework/engine]

Development Notes

Share any interesting technical details or challenges you encountered while building the game.

Technical Requirements

JavaScript Bundle

• Your game.js should be a self-contained bundle
• Must work when loaded as a script tag
• Should create and manage its own canvas element
• Must respect the container size provided
• Should handle window resize events appropriately

Asset Loading

• All assets should be loaded relative to your GitHub repository
• Use absolute URLs to your raw GitHub content
• Example: https://raw.githubusercontent.com/username/repo/branch/path/to/asset

Game Container

Your game will be loaded into a container with the following properties:

• Class: game-canvas-container
• Aspect ratio: 16:9
• Responsive width
• Dark background

Performance

• Bundle size should be reasonable (under 5MB recommended)
• Game should maintain 60 FPS on modern browsers
• Include loading states for assets

Testing Locally

1. Create your markdown file in the posts directory
2. Name it your-game-name.md
3. Ensure all required frontmatter fields are filled
4. Test your game loads and runs properly
5. Verify responsive behavior

Submission Process

1. Host your game repository on GitHub
2. Make sure it's public and the main branch is stable
3. Create your markdown file following the template above
4. Submit a pull request to our repository with your markdown file
5. We'll review and provide feedback if needed

Example Repository

Here's a minimal example repository showing the required structure: Example Minigame Repository

Common Issues

Game Doesn't Load

• Check your repository path and branch name
• Verify the entryPoint path is correct
• Ensure all URLs are using raw.githubusercontent.com

Asset Loading Fails

• Use absolute URLs from your GitHub repository
• Check file permissions and paths
• Verify assets are committed and pushed

Performance Issues

• Optimize your bundle size
• Implement proper cleanup when game is unmounted
• Handle window resize events efficiently

Support

If you need help or have questions:

1. Open an issue on our repository
2. Join our Discord server
3. Contact us at support@cityofbrains.com

Testing Your Submission

Before submitting, verify:

• [ ] Game loads and runs
• [ ] Controls work as expected
• [ ] Assets load correctly
• [ ] Responsive design works
• [ ] No console errors
• [ ] Cleanup works when navigating away