Propeller Rat

Source code for my Playdate game "Propeller Rat", a game where you pilot a propeller-strapped rat through increasingly challenging, hazard-filled worlds with crank-based movement! Features a total of 80 action packed levels spread across 8 different worlds, and leaderboards to compete for the fastest times in each world! You can get it on Catalog, or on Itch IO.

Project Structure

• mockups/: contains all the .aseprite files used in the project
• source/: contains all the source code and assets
  • data/: contains font + LDtk world data
    • fonts/: contains the fonts used: m6x11 by managore
    • LDtk_lua_levels/: auto-generated by LDtk.lua, contains cached level data
    • tileset-table-16-16.png: tileset used by LDtk world
    • world.ldtk: LDtk world file
  • images/: contains all game images
  • launcherImages/: contains all images used by Playdate launcher
  • scripts/: contains all source code
    • audio/: contains audio manager
      • audioManager.lua: handles all SFX and Music in one place
    • game/: contains game scene
      • gameScene.lua: manager for all game elements (player, hazards, tilemap, etc.)
    • hazards/: code for all the hazard elements
    • levels/: handles spawning all the level elements (walls, hazards, etc.)
    • libraries/: contains all the libraries used in this project
      • Assets.lua: Lazy Loading Assets by Shaun Inman
      • LDtk.lua: Playdate LDtk Importer by Nic Magnier
      • SceneManager.lua: Scene Management, by me
      • Utilites.lua: Generic Utilities, by me
    • pickups/: contains code for keys and the teleporter
    • player/: contains player controller
    • story/: contains dialog/story code
    • title/: contains all non-game scenes
      • gameCompletedScene.lua: unused game end scene
      • levelSelectScene.lua: level select + level preview generation
      • scoreboardScene.lua: scoreboard display
      • starfield.lua: generates random starfield background
      • titleScene.lua: title + disabled cheat code
      • worldSelectScene.lua: world select + unlocking
    • globals.lua: game data, tags, z indexes, all script imports
    • tests.lua: sanity checks for valid levels
  • sound/: contains all sfx and music files
  • main.lua: only imports globals and sets the starting scene

License

All code under source/scripts is under the MIT License, except the libraries LDtk.lua and Assets.lua. All the assets that are not code and outside of the scripts folder (e.g. sound, images, etc.) are not under the MIT License.

"/source/scripts/libraries"
LDtk.lua by Nic Magnier
Assets.lua by Shaun Inman

--

All other code under /source/scripts

MIT License

Copyright (c) 2024 SquidGod

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.