README file from
GithubRubik Cube algorithms
Bring your Rubik's Cube study to life. This plugin allows you to visualize OLL, PLL, and custom algorithms directly within your notes using interactive 2D cubes and dynamic arrows.
F2L and other puzzles to come.
Key Features
- 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.
- Coming Soon: Support for F2L and additional twisty puzzles.
Where to start?
1. Installation
Find Rubik Cube Algo View in the Obsidian Community Plugins gallery and click Install.
2. Fast-Track with Templates
The easiest way to start is using the built-in commands:
- Open the Command Palette (Cmd/Ctrl + P).
- Type 'Rubik' to see available commands:
- Select "Template" for a blank, commented code block.
- Select "Example" to see a pre-configured block in action.
3. Learn by Example
If you prefer a hands-on approach, download my example Markdown files and drop them directly into your vault.
Visual Preview
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.2.x Increased user experience: Overhauled README, added in-plugin tutorials, commands and description in settings view.
- 0.1.x 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.