Game 1

A platformer game built with LÖVE (Love2D) featuring spectacular particle effects, smooth teleportation, and dynamic visual feedback.

Building and Distribution

This project uses love-release to create distributable builds for multiple platforms.

Prerequisites

• LÖVE 11.5 installed
• love-release installed (via luarocks: luarocks install love-release)

Building

Simply run the build script:

./build.sh

This will:

1. Create a .love file (compatible with LÖVE installations)
2. Create platform-specific executables using love-release
3. Output all files to the releases/ directory

Build Output

After running build.sh, you'll find:

• game1.love - LÖVE package file (works on any platform with LÖVE installed)
• Platform-specific executables (macOS, Windows, Linux) based on your current platform

Customization

Edit build.sh to customize:

• GAME_NAME - Name of your game
• VERSION - Version number
• AUTHOR - Your name/team name

Distribution

You can distribute:

• The .love file (requires LÖVE to be installed)
• Platform-specific executables (standalone, no LÖVE required)

Popular distribution platforms:

• itch.io - Great for indie games
• Steam - For commercial releases
• Your own website

Development

Make sure to set DEBUG = false and isDev = false in conf.lua for production builds.

Documentation

This project includes comprehensive documentation for developers and level designers:

📚 Interactive Web Documentation

Local Development

Run the documentation viewer locally:

From the project root:

./docs-viewer/serve.sh

Or manually:

# From project root (important!)
python3 -m http.server 8000

Then open http://localhost:8000/docs-viewer/ in your browser.

Note: The server must run from the project root, not from docs-viewer/.

GitHub Pages Deployment

The documentation can be automatically deployed to GitHub Pages!

1. Push to main branch:

   • The workflow will automatically enable GitHub Pages (if not already enabled)
   • Or manually enable: Settings → Pages → Source: GitHub Actions

2. Wait for deployment:

   • The workflow automatically deploys when docs/ or docs-viewer/ files change
   • Check the Actions tab for deployment status

3. Access your docs:

   • Available at: https://[username].github.io/[repository-name]/docs-viewer/
   • Or visit: https://[username].github.io/[repository-name]/ (redirects to docs)

See GitHub Pages Setup Guide for detailed instructions.

The interactive viewer includes:

• Search functionality
• Code highlighting
• Dark/light theme
• Table of contents
• Mobile-responsive design

📖 Documentation Structure

Guides (docs/guides/)

• Getting Started - Quick start guide
• Tiled Integration - Complete guide for creating levels in Tiled Map Editor
• Trigger System - Comprehensive trigger system guide
• Camera Guide - Camera usage and examples

API Reference (docs/api/)

• Core: Camera, Constants, Colors, Utils
• Objects: Trigger, Player, Box, Coin, Door, Teleporter, Saw, Cutscene
• States: State Machine, Game State
• Systems: Particles, Shaders, Scene Effects, Save System, Input Config
• Game: Load Map, Resources
• Main: Main, Config

Architecture (docs/architecture/)

• Project Structure - Folder organization and structure

Examples (examples/)

• Triggers - Trigger examples (moving platforms, scaling, sequences)
• Camera - Camera examples (following, shake, smooth movement)
• More examples coming soon for particles, states, objects, and systems

Quick Start for Level Designers

1. Read Getting Started Guide
2. Read Tiled Integration Guide for level creation
3. Check Trigger Examples for common patterns
4. Use triggers to create moving platforms, scaling objects, and sequences

Quick Start for Developers

1. Read Getting Started Guide
2. Explore API Reference for system details
3. Check Examples for code samples
4. Read Architecture Docs for system design
5. Use the Interactive Documentation Viewer for the best experience