particle-clash/README.md

Particle Clash

A match-4 game for two players about particles about to collide

Ludum Dare 51: Compo entry

About

TODO

Credits

Game

• Stefano Pigozzi (@Steffo99)

Tools

• ⚙️ Godot Engine 3.5.1
• 💻 Visual Studio Code
  • geequlim.godot-tools extension
  • ms-vsliveshare.vsliveshare extension
• ✏️ GIMP 2.10.32
• 🎵 REAPER 6.61
• 🏗️ Git
  • Git Large File Storage extension
• 🏗️ GitHub
  • GitHub Actions
    • abarichello/godot-ci action
• 🏗️ Steffo99/template-godot-ld50 template

Development

Large file storage

This repository is configured with the Git Large File Storage extension.

Cloning

To clone this repository with all LFS files:

1. Ensure Git LFS is installed on your system

2. Clone the repository normally

3. Run:

   $ git lfs pull
   

Committing

Before you commit a large binary file (such as an image, or an audio file):

1. Ensure the Git LFS hooks are installed:

   $ git lfs install
   

2. Ensure the extension of the file you are committing is tracked:

   $ git lfs track "*.ext"
   

3. Ensure the .gitattributes file itself is tracked:

   $ git add .gitattributes
   

Auto-build

To trigger an automatic export of the project:

1. Ensure GitHub Actions are enabled
2. Push a new tag with formatted as vX.Y.Z

To download the resulting builds:

1. Visit the Actions tab
2. Click on the triggered workflow
3. Download the created artifacts from the bottom of the page

Note that artifacts are visible only if you're logged in to a GitHub account!