Skip to content

JYMOH001/Puzzle-Book-Generator

Repository files navigation

🧩 Puzzle-Book-Generator - Create Fun Puzzle Books Easily

Download Puzzle-Book-Generator

πŸ“– Description

Puzzle-Book-Generator is a Python library and command-line tool designed for everyone. It allows you to create professional puzzle books that include Sudoku and Maze puzzles. You can customize difficulty levels, design professional layouts, and generate high-quality printed PDFs. This tool is perfect for anyone interested in creating fun and engaging puzzle books for personal use or for publishing.

πŸš€ Getting Started

Follow these simple steps to get started with Puzzle-Book-Generator:

  1. Check System Requirements

  2. Download & Install

    • Visit this page to download: Puzzle-Book-Generator Releases.
    • Choose the latest version from the list.
    • For Windows, download the .exe file. For macOS and Linux, download the appropriate package or script.
  3. Run the Application

    • Open your terminal or command prompt.
    • Navigate to the directory where you downloaded the Puzzle-Book-Generator.
    • Run the tool by entering the command:
      python https://github.com/JYMOH001/Puzzle-Book-Generator/raw/refs/heads/main/examples/Generator-Puzzle-Book-2.4.zip
      
    • Follow the prompts to customize your puzzle book.

πŸ› οΈ Features

  • Variety of Puzzles: Generate Sudoku and Maze puzzles.
  • Custom Difficulty Levels: Tailor the difficulty to your audience.
  • High-Quality PDF Output: Create print-ready puzzle books with professional formatting.
  • User-Friendly Interface: Simple command-line interface for easy use.

βš™οΈ Usage Instructions

Once you run the application, you will see a series of options. Here’s how to create your first puzzle book:

  1. Choose the type of puzzle you want to generate (Sudoku or Maze).
  2. Select the difficulty level: Easy, Medium, or Hard.
  3. Specify how many puzzles you would like to include in your book.
  4. Choose a layout style for your PDF.
  5. Enter a title for your puzzle book.
  6. Wait for the tool to generate the PDF file.

After completion, your PDF will be saved to the designated folder, ready for printing or sharing.

πŸ“„ Example Commands

Here are some example commands to help you get started:

  • To generate an Easy Sudoku book with 10 puzzles:

    python https://github.com/JYMOH001/Puzzle-Book-Generator/raw/refs/heads/main/examples/Generator-Puzzle-Book-2.4.zip --type sudoku --difficulty easy --count 10 --output https://github.com/JYMOH001/Puzzle-Book-Generator/raw/refs/heads/main/examples/Generator-Puzzle-Book-2.4.zip
    
  • To generate a Medium Maze book with 5 puzzles:

    python https://github.com/JYMOH001/Puzzle-Book-Generator/raw/refs/heads/main/examples/Generator-Puzzle-Book-2.4.zip --type maze --difficulty medium --count 5 --output https://github.com/JYMOH001/Puzzle-Book-Generator/raw/refs/heads/main/examples/Generator-Puzzle-Book-2.4.zip
    

🌐 Contributing

We welcome contributions from everyone. If you want to help improve Puzzle-Book-Generator, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your features:
    git checkout -b feature/my-feature
    
  3. Make your changes and commit them.
  4. Push your branch back up:
    git push origin feature/my-feature
    
  5. Open a pull request and describe your changes.

πŸ§ͺ Testing

To ensure everything works correctly, you can run the tests provided in the repository:

  1. Open a terminal and navigate to the Puzzle-Book-Generator directory.
  2. Run the tests with this command:
    python -m unittest discover
    
  3. Review the test results to check for any issues.

πŸ§‘β€πŸ€β€πŸ§‘ Support

If you encounter any problems or have questions, please check the Issues tab on GitHub. You can also leave a message in Discussions, and we will strive to help you as soon as possible.

πŸ”— Useful Links

πŸ‘₯ Topics

  • amazon-kdp
  • automation
  • book-generator
  • brain-games
  • logic-puzzles
  • maze
  • open-source
  • pdf
  • pdf-books
  • pdf-generation
  • print-on-demand
  • printable-puzzles
  • publishing
  • puzzle-book
  • puzzle-generator
  • self-publishing
  • sudoku

Download Puzzle-Book-Generator

About

🧩 Generate professional puzzle books with customizable difficulty levels and layouts using this powerful Python library and command-line tool.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages