dtan3847 / starbattle-solver

StarBattle Solver

Overview

StarBattle Solver is a React-based web application designed for solving StarBattle puzzles.

Features

• Interactive puzzle board.
• Automatic and user-guided puzzle solving.
• Support for various puzzle sizes and difficulties.
• Responsive design, compatible with various devices and screen sizes.

Technology Stack

• React: A JavaScript library for building user interfaces.
• Material-UI (MUI): A popular React UI framework offering a comprehensive suite of UI tools.
• Yarn Zero-Install: Ensures all dependencies are included with the source code, enabling immediate installation and execution without needing to download packages from the internet.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Yarn (Version 1.x or later)
• Node.js (Version 12.x or later)

Installation

1. Clone the repository:

   git clone https://github.com/dtan3847/starbattle-solver.git

2. Navigate to the project directory:

   cd starbattle-solver

3. Since this is a Yarn Zero-Install project, all dependencies are already included. Simply start the application:

   yarn start

   This will launch the app in development mode. Open http://localhost:3000 to view it in the browser.

Usage

In draw mode, click and drag to draw walls. Use the size and star count sliders to adjust size. Use "Mode: Draw" to toggle modes. In solve mode, you can solve manually, or let the computer solve for you. Use "Show next step" to show one possible step to make progress in the puzzle. Use "Apply next step" to automatically fill those cells. Use "Auto solve" to fill in the entire puzzle (Warning: may take some time). The "Save puzzle" and "Load puzzle" can be used to save the progress of a puzzle. Currently, only one puzzle can be saved.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under AGPL-3.0. See LICENSE for more information.

Contact

Your Name – [email protected]

Project Link: https://github.com/dtan3847/starbattle-solver

starbattle-solver's Issues

Clicking horizontal walls doesn't work if page is scrolled down

Migrate to vite

react-scripts is outdated. May be better to move to vite.

Import puzzle using image

Be able to recognize size, walls, etc. from screenshot, picture, etc. of existing puzzle.
Star count may still have to be inputted manually.

Detect cursor movement direction when drawing puzzle

Intuitively, we draw vertical lines when we want vertical walls and horizontal lines when we want horizontal walls.
Currently, walls are drawn based on cursor location.
It would be better to detect the direction the cursor is moving and use that to influence which walls will be drawn.

Undo/redo button

Be able to undo/redo latest change in solve mode.
Draw mode as well?