Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tom-mohr/particle-life-app

🦠 A GUI for Particle Life, a particle system showing life-like behaviour
https://github.com/tom-mohr/particle-life-app

artificial-life java multiagent-systems particle-life particle-system

Last synced: 3 months ago
JSON representation

🦠 A GUI for Particle Life, a particle system showing life-like behaviour

Awesome Lists containing this project

README

        

# 🦠 Particle Life App

A GUI for the [Particle Life Framework](https://github.com/tom-mohr/particle-life).

- [Download](https://particle-life.com)
- [Documentation](https://particle-life.com/docs)

Join the [Discord server](https://discord.gg/Fd64AhKzMD)!

![Screenshot of the App](./readme_assets/app_demo.png)

## How to build this app from source

If you just want to try out this application, simply download the executables from [particle-life.com](https://particle-life.com).
However, if you want to contribute to this repository or just mess with the code, you need to build the application from source.

For this, you need to have [Git](https://git-scm.com/downloads) and [Java](https://jdk.java.net/19/) with version 16 or higher installed on your computer. Confirm your Java version with `java -version`.

Then, execute these lines in the terminal:
```sh
git clone https://github.com/tom-mohr/particle-life-app.git
cd particle-life-app
./gradlew run
```

You should now see many particles on your screen. If you encounter any problems, ask for help in the [`#tech-support`](https://discord.gg/EVG8XnCn3U) channel on the Discord server.

## How to make a release

- Confirm that everything is working correctly and check in with others that the current state of the main branch is ready for release.
- Run `./gradlew zipApp` from the project root.
This generates the zip file `particle-life-app.zip` in `./build/zipApp/`. It includes the Windows executable (`.exe`) along with other files.
- Go to the [Releases](https://github.com/tom-mohr/particle-life-app/releases) section of this GitHub repo and click `Draft a new release`.
- Click `Choose a tag` and type the new version name:
- Prefix the version name with the letter `v`. Some good tag names might be `v1.0.0` or `v2.3.4`.
- The version name should comply with [semantic versioning](https://semver.org/). Talk to others if you are unsure about what to choose here.
- Click `Create a new tag`.
- Set the release title to match the tag name.
- Use the description to summarize the changes of all commits since the last release.
- Add the generated `particle-life-app.zip` as an asset to the release.
- Click `Publish release`.