Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redefining Puzzle Generation: Sudoklify's Innovative Approach #18

Merged
merged 1 commit into from
Aug 25, 2023

Conversation

teogor
Copy link
Owner

@teogor teogor commented Aug 25, 2023

Updated docs

What's New

  • Key Features: Explore an array of functionalities that make Sudoklify stand out:

    • Efficient and customizable Sudoku puzzle generation algorithms ✨
    • Support for various grid sizes, including 4x4, 9x9, 16x16, and more πŸ“
    • Multiple difficulty levels - Easy, Medium, Hard, and Expert 🌟
    • Flexible token mapping system for personalized puzzle representation 🎨
    • Intuitive API for puzzle generation, population, and solution retrieval 🧩
    • Randomization techniques for puzzle layout and digit placement πŸ”€
  • Redefining Puzzle Generation: Sudoklify reimagines how Sudoku puzzles are generated. Instead of the traditional method of removing numbers one by one, Sudoklify leverages an ingenious approach. It starts with a solvable "seed" puzzle and applies a series of transformative algorithms to craft fresh puzzles. This unique process ensures rapid puzzle creation without complex backend resources.

  • Unparalleled Puzzle Diversity: Each seed employed by Sudoklify unlocks a staggering 2.4 trillion unique puzzles. To put this in perspective, if you solved one puzzle every 3 minutes, it would take over 13 million lifetimes to exhaust a single seed. πŸŽ‰

  • Transformative Algorithms: Sudoklify harnesses various transformations to create captivating puzzles:

    • Board Rotation: Four permutations (0Β°, 90Β°, 180Β°, 270Β°).
    • Column Stacks Shuffle: Six permutations (3!).
    • Row Bands Shuffle: Another six permutations (3!).
    • Column Shuffle: A whopping 216 permutations (3! x 3! x 3!).
    • Row Shuffle: An additional 216 permutations (3! x 3! x 3!).
    • Number Swapping: An incredible 362,880 permutations (9!).
  • Usage: Learn how to generate Sudoku puzzles using Sudoklify:

    1. Add Sudoklify as a dependency in your project.
    2. Create a ParamsBuilder to configure puzzle generation parameters.
    3. Generate Sudoku puzzles using the generateSudoku extension function.
  • Accessing Generated Sudoku: Get insights into accessing properties of the generatedSudoku instance, including puzzle and solution strings, difficulty level, and grid type.

  • Contributing: Contributions to Sudoklify are welcome! Open issues or submit pull requests for ideas, bug reports, and feature requests.

Join the Sudoklify community and experience the next evolution of Sudoku puzzle generation! πŸ§ πŸ§©πŸš€

@teogor teogor added @documentation Improvements or additions to documentation @priority-high @maintenance labels Aug 25, 2023
@teogor teogor added this to the 1.0.0-alpha02 milestone Aug 25, 2023
@teogor teogor self-assigned this Aug 25, 2023
@teogor teogor merged commit 32a4ee1 into main Aug 25, 2023
4 checks passed
@zeobot zeobot bot deleted the docs/readme-md branch August 25, 2023 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@documentation Improvements or additions to documentation @maintenance @priority-high
Projects
Development

Successfully merging this pull request may close these issues.

None yet

1 participant