Giter VIP home page Giter VIP logo

pyxelsand2's Introduction

PyxelSand 2

PyxelSand2 is a rewrite of the PyxelSand project, which is a "falling sand" style game written with the Python game engine: Pyxel

pyxel-210524-184203

How to install

  1. Install Poetry
  2. Run poetry install in the root directory
  3. Run poetry run python -m sand_game
  4. (Optional) Run poetry run pytest to run the unit tests

How to play

  • Left click places the currently selected particle
  • Right click removes particles under the cursor
  • Space pauses and resumes the simulation

License

This software is licensed under the GPLv3 license. The full license can be found in the LICENSE file.

Copyright (C) 2021  Harry Peach

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

pyxelsand2's People

Contributors

harrypeach avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

pyxelsand2's Issues

Add README

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

Add LICENSE

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

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 acid particle

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

Add water particle

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

Add fire particle

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

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

Implement basic GUI

Implement a GUI that allows you to at minimum:

  1. Change pen size
  2. Select from available particles

Add tooltip

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.