robot_cleaning_game/README.md

975 B

Two Player Cleaning Game

A two-player cooperative cleaning game built with Fennel and Löve 2D.

Setup

  1. Install LÖVE 2D following the Getting Started guide
  2. Run the game with:
    love ./two_player_cleaning_game
    

Architecture

The game uses Fennel (a Lisp dialect) compiled to Lua at runtime. Fennel setup is shared across projects via symlinks:

  • fennel-1.5.3.lua (root): The Fennel compiler
  • fennel_bootstrap.lua (root): Module loader that auto-compiles .fnl files

The two_player_cleaning_game directory contains:

  • main.fnl: Game source code (Fennel)
  • main.lua → symlink to ../fennel_bootstrap.lua: Entry point
  • fennel.lua → symlink to ../fennel-1.5.3.lua: Compiler reference

Development

See CLAUDE.md for detailed development notes, including Fennel syntax and LÖVE2D API reference.