https://github.com/developmenthf/quicklove

A Löve2D template for those who want to get straight to the action.
https://github.com/developmenthf/quicklove

game-development love2d lua

Last synced: 2 days ago
JSON representation

A Löve2D template for those who want to get straight to the action.

• Host: GitHub
• URL: https://github.com/developmenthf/quicklove
• Owner: DevelopmentHF
• Created: 2024-10-14T11:56:15.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-01-31T12:34:18.000Z (4 days ago)
• Last Synced: 2025-01-31T13:34:32.681Z (4 days ago)
• Topics: game-development, love2d, lua
• Language: Lua
• Homepage:
• Size: 675 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# quicklöve 

Starter project files to prototype ideas quicker. 

Don't get bogged with boilerplate.

> [!IMPORTANT]

> This template uses [middleclass](https://github.com/kikito/middleclass?tab=readme-ov-file) for basic OOP structuring, and [anim8](https://github.com/kikito/anim8/tree/master) for easier animation handling.

>

> Both are included in each `game/utils/` directory by default.

> [!WARNING]

> The **quicklöve** template, as outlined in `conf.lua` uses the classic gameboy aspect ratio by default, which is then scaled by 4.

>

> This means all our assets can be created for this 'style', then scaled up. In this codebase, this is done through the `ScalingFactor` global variable, which should be used to scale up each draw cycle prior to rendering sprites, and popped off the draw stack before rendering things like text.

>

> However, this technique of scaling can catch you out when using things like mouse coordinates, which need to be scaled down by `ScalingFactor` before transitioning to game logic.

> I.e, an `Entity`, in logic, might be have `position.x=4`, yet it will be rendered at `x=16`, and if you try click on it as part of your game, the mouse will be at `x=16`, thus needing to be scaled down.

---

## Running the development build

Execute this from top-most directory of your created game folder

```

/Applications/love.app/Contents/MacOS/love game

```

## Building

### Web Building

To build for web in order to publish to itch.io,

```bash

npm i love.js

```

```bash

npx love.js game build

```

then zip the build and upload it.

This repository has had issues with this technique of building. An alternative approach is to zip the **contents** of the `game/` directory, not `game/` itself into `build.love` then run

```bash

npx love.js game/build.love build

```

>[!CAUTION]

> Due to quirks with `love.js` make sure to turn on the experimental `SharedArrayBuffer` support option