harrypeach/pyxelsand2

⏳ A falling sand game written in Python using the Pyxel library

pyxelsand2's Issues

Add README

A readme needs creating to showcase the project and include information about used libraries.

Add ability to pause simulation

There should be an ability to pause the simulation and resume it

Change cursor when not in canvas

It's difficult to use the cursor on the GUI when it is a large circle, the cursor should be changed when using the GUI

Add LICENSE

An open source license should be chosen and applied to the project before it is made public

Add tests for Python 3.10

Add missing documentation

Many functions are missing docstrings and adequate comments

Button hitbox is off-by-one

The top row and left column of pixels on buttons are not being detected by a click.

Add acid particle

Add a lava particle which burns through other particles (except water) and replaces them with lava too

Add ability to place without overwriting

Placing particles currently overwrites any particles beneath, there should be an option to disable this behaviour

Update README with changes from version 2.1

Add tooltip

Add a text tooltip so that an explanation is shown when hovering over buttons

Walls of canvas should stop particles

When a particle reaches the edge of the canvas, it should stop like a wall

Sand should sink to the bottom of water

Sand currently floats on top of water when ideally it should sink to the bottom

Add a button to clear the canvas

Refine _place_particle function

The current implementation does a very rough estimate of a circle and is inaccurate at smaller sizes, the algorithm should be reworked to make it more accurate while still being fast

Add fire particle

Add a fire particle that lets off embers / smoke and burns flammable objects

Add saving and loading of canvases

Canvases should be able to be serialised, and then saved or loaded from disk.

Add water particle

Add the particle water, which should extend to fill any space that it is within

Refactor UI to remove from main class

Investigate optimisations

Investigate where parts of the project can be optimised

1. Reworking algorithms such as update and _place_particle
2. Compiling some code using libraries such as numba

Add fuse particle

Implement basic GUI

Implement a GUI that allows you to at minimum:

1. Change pen size
2. Select from available particles