Skip to content

PixiJS implementation of the Marching Squares algorithm. Interactive demo with responsive design, grid toggle, point interpolation, and dynamic circle management.

License

Notifications You must be signed in to change notification settings

billymosis/pixijs-marching-square

Repository files navigation

PixiJS Marching Squares

This project is to demonstrate and facilitate learning about computer algorithms. It uses a variety of modern web technologies and libraries to create an interactive experience.

Features

  • Responsive Design: The application adjusts to various screen sizes and resolutions.
  • Toggleable Grid: You can enable or disable the grid overlay.
  • Point Interpolation: Visualize and interact with interpolated points.
  • Circle Management: Add or remove circles dynamically.
  • Interactive Controls: Use Tweakpane to adjust settings and parameters in real-time.

Technologies Used

  • PixiJS: A powerful 2D rendering engine for creating interactive graphics.
  • Vite: A fast build tool and development server.
  • TypeScript: A statically typed superset of JavaScript.
  • Tweakpane: A lightweight library for creating interactive control panels.

Getting Started

To get a local copy up and running, follow these steps:

  1. Clone the Repository

    git clone https://github.com/billymosis/pixijs-marching-square.git
  2. Navigate to the Project Directory

    cd pixijs-marching-square
  3. Install Dependencies

    pnpm install
  4. Run the Development Server

    pnpm run dev
  5. Open Your Browser

    Go to http://localhost:5173 to see the application in action.

Usage

  • Grid Toggle: Use the provided controls to show or hide the grid.
  • Add/Remove Circles: Use the controls to dynamically add or remove circles.
  • Adjust Interpolation: Modify interpolation parameters using Tweakpane.

Contributing

Contributions are welcome! If you have suggestions or improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

  • PixiJS - The 2D rendering engine used.
  • Vite - The build tool and development server.
  • TypeScript - The statically typed language.
  • Tweakpane - The interactive control panel library.

About

PixiJS implementation of the Marching Squares algorithm. Interactive demo with responsive design, grid toggle, point interpolation, and dynamic circle management.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages