1
Fork 0
mirror of https://github.com/Steffo99/particle-clash.git synced 2024-11-21 23:24:18 +00:00
particle-clash/README.md

93 lines
2.7 KiB
Markdown
Raw Normal View History

2022-10-02 13:49:29 +00:00
# Particle Clash
2022-09-30 21:47:28 +00:00
2022-10-02 13:49:29 +00:00
_A match-4 game for two players about particles about to collide_
2022-09-30 21:47:28 +00:00
2022-09-30 21:49:52 +00:00
## Ludum Dare 51: Compo entry
2022-09-30 21:47:28 +00:00
[![Overall: TBD](https://img.shields.io/badge/overall-TBD-lightgrey)
![Fun: TBD](https://img.shields.io/badge/fun-TBD-lightgrey)
![Innovation: TBD](https://img.shields.io/badge/innovation-TBD-lightgrey)
![Theme: TBD](https://img.shields.io/badge/theme-TBD-lightgrey)
![Graphics: TBD](https://img.shields.io/badge/graphics-TBD-lightgrey)
![Audio: TBD](https://img.shields.io/badge/audio-TBD-lightgrey)
![Humor: TBD](https://img.shields.io/badge/humor-TBD-lightgrey)
2022-10-02 13:49:29 +00:00
![Mood: TBD](https://img.shields.io/badge/mood-TBD-lightgrey)](https://ldjam.com/events/ludum-dare/51/$303236/)
## About
TODO
2022-09-30 21:47:28 +00:00
## Credits
### Game
2022-10-02 13:49:29 +00:00
- Stefano Pigozzi (@Steffo99)
2022-09-30 21:47:28 +00:00
### Tools
2022-10-02 13:49:29 +00:00
- [⚙️ Godot Engine `3.5.1`](https://godotengine.org/)
- [💻 Visual Studio Code](https://code.visualstudio.com/)
2022-09-30 21:47:28 +00:00
- [`geequlim.godot-tools` extension](https://marketplace.visualstudio.com/items?itemName=geequlim.godot-tools)
- [`ms-vsliveshare.vsliveshare` extension](https://marketplace.visualstudio.com/items?itemName=ms-vsliveshare.vsliveshare)
2022-10-02 13:49:29 +00:00
- [✏️ GIMP `2.10.32`](https://www.gimp.org/)
- [🎵 REAPER `6.61`](https://www.reaper.fm/)
- [🏗️ Git](https://git-scm.com/)
2022-09-30 21:47:28 +00:00
- [Git Large File Storage extension](https://git-lfs.github.com/)
2022-10-02 13:49:29 +00:00
- [🏗️ GitHub](https://github.com/)
2022-09-30 21:47:28 +00:00
- [GitHub Actions](https://github.com/features/actions)
- [`abarichello/godot-ci` action](https://github.com/marketplace/actions/godot-ci)
2022-10-02 13:49:29 +00:00
- [🏗️ `Steffo99/template-godot-ld50` template](https://github.com/Steffo99/template-godot-ld50)
2022-09-30 21:47:28 +00:00
## Development
### Large file storage
This repository is configured with the [Git Large File Storage extension](https://git-lfs.github.com/).
#### Cloning
To clone this repository with all LFS files:
1. Ensure Git LFS is installed on your system
1. Clone the repository normally
1. Run:
```console
$ 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:
```console
$ git lfs install
```
1. Ensure the extension of the file you are committing [is tracked](.gitattributes):
```console
$ git lfs track "*.ext"
```
1. Ensure the `.gitattributes` file itself is tracked:
```console
$ git add .gitattributes
```
### Auto-build
To trigger an automatic export of the project:
1. Ensure GitHub Actions are enabled
2022-10-02 13:49:29 +00:00
1. Push a new tag with formatted as `vX.Y.Z`
2022-09-30 21:47:28 +00:00
To download the resulting builds:
1. Visit the Actions tab
1. Click on the triggered workflow
1. 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!