Rubik Cube algorithms

by Altarok
5
4
3
2
1
Score: 53/100

Description

Obsidian plugin able to visualize Rubik Cube algorithms

Reviews

No reviews yet.

Stats

1
stars
265
downloads
0
forks
47
days
46
days
47
days
1
total PRs
0
open PRs
0
closed PRs
1
merged PRs
0
total issues
0
open issues
0
closed issues
435
commits

Latest Version

2 months ago

Changelog

More lint chores because of new Obsidian settings

README file from

Github

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.

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

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