# *Rubik Cube algorithms*
Bring your Rubik's Cube study to life.

- Create your own fully customizable algorithm library.
- Look at algorithms from different angles.
- Train yourself with integrated speedcubing timer.

For a detailed guide, run the 'Insert quick start guide' command directly inside Obsidian, or view the full documentation [here](https://github.com/Altarok/RubikCubeAlgoView/blob/main/docs/usage.md).

***Key Features***
- **Integrated timer**: Includes scrambled algorithms.
- **Interactive Controls**: Rotate the cube or reset to the default view with integrated buttons.
- **Smart Rotation**: Algorithm notation automatically updates based on your current cube orientation.
- **Fully Customizable**: Tailor your experience with custom cube sizes, hex-code colors, and directional arrows.
- **Mobile support**

# *Where to start?*
## 1. Installation
Find 'Rubik Cube algorithms' in the Obsidian Community Plugins gallery and click Install.
## 2. Fast-Track with *built-in commands
1. Open the Command Palette (Cmd/Ctrl + P).
2. Type 'Rubik' to see available commands:
  - Select "**Template**" for a blank, commented code block.
  - Select "**Example**" to see a pre-configured block in action.
  - Select "**Timer**" to add stopwatch for cube training.
  - Select "**Timer Results**" to add result table for training. Must be in same file as timer.
## 3. Learn by Example
If you prefer a hands-on approach, download the example Markdown files and drop them directly into your vault: https://github.com/Altarok/RubikCubeAlgoView/tree/main/examples

# *Visual Preview*
<div>
<details>
<summary>Click to see screenshot</summary>
<img width="781" height="732" alt="Cube visualization example" src="https://github.com/user-attachments/assets/1ace1a85-a8b1-4d5c-8839-48fd3476dba3"/>
</details>
<details>
<summary>Click to see animation</summary>
<img width="750" height="300" alt="Animated cube visualization example" src="https://github.com/user-attachments/assets/c1324ae8-e120-4b4d-a99f-9f82d01d8159"/>
</details>
</div>

# *Configuration options*
## Per-Block Settings
You can customize individual cubes within their code blocks:
- **Dimensions**: Set width and height independently (Scale 2 to 10).
- **Styling**: Custom colors for cube and arrow (3- or 6-digit hex values).
- **Arrows**: Define custom arrow paths to visualize layer movements.
## Global Settings
Set your defaults in the Plugin Settings menu:
- Default Cube Color
- Default Arrow Color

# *Change log*
- 0.4.2 (work in progress) Add commands for timer and table
- 0.4.1 Added result table for speedcubing timer
- 0.4.0 Added speedcubing timer with scrambled algorithms
- 0.3.0 UX: Added property 'setup' to make training easier
- 0.2.0 UX: README, built-in commands and tutorials, description in settings view
- 0.1.0 Prepared for Obsidian's official community release.
- 0.0.4 Added full mobile support.
- 0.0.3 Introduced rotation buttons and dynamic algorithm updates.
- 0.0.2 Added arrows and initial rotation support.
- 0.0.1 Basic cube visualization.

# *Planned Features*
- Display PLL with overhanging stickers (optional) for blocks and headlight recognition
- Change arrows to optional
- Add property 'sticker-size' (pixel/percent)
- Persist favorite rotation
- Persist favorite algorithm
- Add stopwatch to cubes
  - Persist 'best' and 'ao5' 
- Support for F2L
- Add additional twisty puzzles