https://github.com/wo0fle/sq1-img-gen

A customizable Square-1 image generator.
https://github.com/wo0fle/sq1-img-gen

image-generation python reflex rubiks-cube square-1 twisty-puzzles webapp

Last synced: 5 days ago
JSON representation

A customizable Square-1 image generator.

• Host: GitHub
• URL: https://github.com/wo0fle/sq1-img-gen
• Owner: Wo0fle
• Created: 2024-06-08T04:37:24.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-12-16T00:50:06.000Z (6 days ago)
• Last Synced: 2024-12-16T01:30:39.224Z (6 days ago)
• Topics: image-generation, python, reflex, rubiks-cube, square-1, twisty-puzzles, webapp
• Language: Python
• Homepage: https://sq1-img-gen-gold-grass.reflex.run
• Size: 16.2 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Seby's Square-1 Image Generator

### https://sq1-img-gen-gold-grass.reflex.run

## Made using [Reflex](https://github.com/reflex-dev/reflex)!

This Square-1 image generator is designed to be customizable to your heart's content!

### Here's how to use it:

1. Choose your input type.

    - **Case**: Your input will solve the Square-1 in the generated image.

        - *This input type is intended for algset designers. It works by inverting the input and then applying it (so that the image generated will be the case the algorithm solves). Be careful in that the inverted input can be applied properly (in the context of algsets, this usually means starting and ending in cubeshape with no misaligned layers).*

    - **Algorithm**: Your input will be applied to a solved Square-1 to generate the image.

    - **State**: Your inputted [sq1optim](https://www.jaapsch.net/puzzles/square1.htm#progs) state will be the Square-1's state in the generated image.




2. Input your Case/Alg/State in the text area.

    - **Case** and **Alg** read standard Square-1 notation, **State** reads standard [sq1optim](https://www.jaapsch.net/puzzles/square1.htm#progs)/[virtual-sq1](https://github.com/Wo0fle/virtual-sq1/blob/main/docs/jared19.md) notation.




3. Choose your rendering type.

    - **Normal**: Generates a fully colored Square-1 (including side colors).

    - **Orientation**: Generates a Square-1 with only top and bottom colors (and a monochrome equator, if applicable).

    - **Shape**: Generates a monochrome Square-1.




4. Choose which layers to include.

    - You can choose to include any combination of **top**, **bottom**, and **equator** layers (so long as you choose **at least one**).




5. Choose image orientation.

    - You can choose **vertical** or **horizontal**.




6. If it hasn't already loaded correctly, click the "**Reload Image**" button, and your generated image should appear on the right!

    - I like clicking the button after I am done changing my desired settings, just in case something is generated incorrectly and I can't tell at a glance.

    - If there is an error with the input, it will generate an image of a solved Square-1. If you weren't expecting a solved Square-1, check your input for typos, and make sure you chose the correct input type.

        - I am working on adding error messages, so errors should be more clear after I do that!




7. Right-click and save the `.svg` file, and that's it!




### Advanced Settings:

- **Custom colors:** Input any valid RGB value into the text box to change that part of the image to your desired color!

    - This includes all the sides (for Normal and Orientation renders), the border (for all renders), and the shape color (for equator in Orientation render and everything in Shape render).

- **Custom extension factor:** Input any numerical value to change how far the pieces extend into/out of the top/bottom sides!

    - Values above 1 lead to the sides sticking out of the top/bottom. Values below 1 lead to the sides sticking into the top/bottom. A value of 1 leads to no visible side colors on the top/bottom layers (but you will be able to see them on the equator). Values below 0 lead to some weird-looking things that kind of look cool sometimes.

- **Toggle slice indicator:** Choose to remove the line running through the slice of the Square-1!





### Known Bugs:

- **Color indicator circles don't work**

    - no clue why they dont update (might have to do with the fact that it's an `rx.box`?) but oh well maybe one day ill figure it out

- **Changing a setting too fast makes that setting stop working**

    - yeah i know, thats why i added the reload image button. might just go back to a "generate image button" to avoid this cuz im fairly sure it has to do with the time it takes to generate the image





- **Error messages:** Hopefully will be added. **REQUIRES UPDATING [virtual-sq1](https://github.com/Wo0fle/virtual-sq1)**

- **Exporting to `.png`:** Hopefully will be added.

- **Graying out particular pieces:** Hopefully will be added.




- **Labeling/coloring particular pieces:** May or may not be added.

- **Custom background color:** May or may not be added.




- **Built-in optimal solver (using [Jaap's Square-1 Optimiser (modified by Doug Benham)](https://github.com/dougbenham/Square1-Optimizer)):** Likely won't happen, but it's on my mind.