CubePal Links

About CubePal Links

CubePal Links is an implementation of the Universal Links (also referred to as App Links or Deep Links) that are web URLs that, when tapped on a mobile device, directly open them in an associated app, triggering specific actions or features defined by the link's parameters. CubePal app allows users to generate, export, share, modify, and use their own Universal Links as described below.

Why Using CubePal Links

CubePal Links enable users to create, store, and share custom cubes and algorithms. These links can be generated within the CubePal app or written manually and stored anywhere, including websites, notes, emails, other apps, or local storage. This feature simplifies the sharing of algorithms, allowing anyone to open and learn them using virtual cubes within the CubePal app.

You can download the CubePal app for free on the App Store.

Prerequisites

Before you start using CubePal Links on a mobile device, ensure that you meet the following requirements:

iPhone: iOS 14.0 or later.
iPod touch: iOS 14.0 or later.
iPad: iPadOS 14.0 or later.

Using CubePal Links

Using CubePal Links is as straightforward as working with any other web URL.

Tap the Link: To open the CubePal app with a specific cube or algorithm, simply tap on the CubePal Link you've either created or saved on your mobile device. The app will automatically launch and open the respective cube and algorithm.
CubePal Links can be initiated from various sources, including files, emails, notes and other apps on your iOS device that support web URLs.

Feel free to use CubePal Links for your personal needs or share them with others.

Creating CubePal Links

To create a CubePal Link that opens within the CubePal app, use the following format:

https://alg.cubepal.app?[parameters]

Additionally, you must include URL parameters to pass information to the CubePal app. Check out the Parameters section below for more details.

You can generate CubePal Links within the CubePal app using current cube and algorithm or scramble, or you can write the CubePal Links manually using the correct format and parameters.

Option A: Generate CubePal Links within the app

Open CubePal app on your mobile device.
Navigate to the desired cube and algorithm or scramble you want to share or save.
Optionally, customise the cube or supercube design and color scheme as needed.
Tap the menu button or the algorithm within the CubePal app and navigate as follows:
☰ → Share... and tap Algorithm or other algorithm type.
Tip: Use ☰ → Share... and tap All to share the CubePal Link and the current cube image.

Option B: Manually Create CubePal Links

Write the CubePal Link manually in the appropriate format described in this documentation.
Ensure that you include the necessary parameters, as listed in the Parameters section.
Save the CubePal Link in your preferred location, such as websites, other apps, or local storage.
Tip: Use the CubePal app to test manually created links before sharing them.

CubePal Link Parameters

URL parameters are used to convey information to the CubePal app. These parameters are essential for showing the desired cubes and algorithms within the app.

General Guidelines

Add parameters after the question mark ? without spaces:
```
https://alg.cubepal.app?alg=R-_F_U_R
```

Separate parameters using the ampersand symbol &:

https://alg.cubepal.app?cube=4x4x4&alg=R-_F_U_R&scheme=japanese

The CubePal Link URL has an empty path, so the trailing slash / after the hostname is optional. Modern browsers often add the slash as a standard convention. You can choose any approach. For instance, the following links are identical:

https://alg.cubepal.app/?=R_F-_U
https://alg.cubepal.app?=R_F-_U

Write an absolute URL using the <a> anchor element and href attribute as shown below, avoiding using target="_blank" or other attributes:

<a href="https://alg.cubepal.app?=R_U_F-">R U F'</a>

Omitting any parameter is allowed, except for the algorithm sequence.
While the order of parameters can be rearranged, it is advisable to follow the order outlined in the table below for consistency.
Ensure that the algorithm sequence comprises a minimum of 2 and a maximum of 80 moves.
Separate algorithm moves with underscore _ for enhanced readability (recommended), or use percent-encoded space %20.
Inverted algorithm moves, such as R', are represented with a dash symbol -, like in R-.
Algorithm sequence and algorithm name are the only case-sensitive parameters.

Parameters

Parameter	Value	Description
`alg`	alg=R-_F_U2_R	Specifies a particular algorithm¹ (sequence of cube turns or moves). Equivalent parameter name: `algorithm` Example: https://alg.cubepal.app?alg=R-_F_U2_R Opens the algorithm: `R' F U2 R`
	=R_U-_F_R-	Empty parameter has the same functionality as `alg` The parameter's name can be omitted only when the sequence is an algorithm. Example: https://alg.cubepal.app?=R_U-_F_R- Opens the algorithm: `R U' F R'`
`scr`	scr=R-_F_U_R	Specifies a particular cube scramble.² Equivalent parameter name: `scramble` Example: https://alg.cubepal.app?scr=R-_F_U_R Opens the cube in its scrambled state using the `R U' F R'`scramble
`rec`	rec=R-_F_U_R	Specifies a particular cube reconstruction³ Equivalent parameter name: `reconstruction` Example: https://alg.cubepal.app?rec=R-_F_U_R Opens the reconstructed cube using the `R U' F R'`sequence
`pat`	pat=E_S-_E-_S	Specifies a particular cube pretty pattern⁴ Equivalent parameter name: `pattern` Example: https://alg.cubepal.app?pat=E_S-_E-_S Opens the cube pattern using the `E S' E' S` sequence
`cube`	cube=	Specifies a particular cube size (dimension). Both parameter and its value are optional. Default cube size: `3x3x3` Example 1: https://alg.cubepal.app?=R-_F_U_R&cube= Example 2: https://alg.cubepal.app?=R-_F_U_R Both examples open the `R U' F R'` algorithm with a `3x3x3`cube
	cube=2x2x2	Specifies a 2x2x2 cube. Equivalent values: `2` `2x2` `pocket` `mini` Example 1: https://alg.cubepal.app?=R-_F_U_R&cube=2x2x2 Example 2: https://alg.cubepal.app?=R-_F_U_R&cube=mini Both examples open the `R U' F R'` algorithm with a `2x2x2`cube
	cube=3x3x3	Specifies a 3x3x3 cube. Parameter and value are optional for 3x3x3 cube. Equivalent values: `3` `3x3` `rubik` `rubiks` `magic` Example 1: https://alg.cubepal.app?=R-_F_U_R&cube=3x3x3 Example 2: https://alg.cubepal.app?=R-_F_U_R Both examples open the `R U' F R'` algorithm with a `3x3x3`cube
	cube=4x4x4	Specifies a 4x4x4 cube. Equivalent values: `4` `4x4` `revenge` `master` Example 1: https://alg.cubepal.app?=R-_F_U_R&cube=4x4x4 Example 2: https://alg.cubepal.app?=R-_F_U_R&cube=revenge Both examples open the `R U' F R'` algorithm with a `4x4x4`cube
	cube=5x5x5	Specifies a 5x5x5 cube. Equivalent values: `5` `5x5` `professors` `professor` Example 1: https://alg.cubepal.app?=R-_F_U_R&cube=5x5x5 Example 2: https://alg.cubepal.app?=R-_F_U_R&cube=5 Both examples open the `R U' F R'` algorithm with a `5x5x5`cube
`name`	name=T_Perm	Specifies the name of the algorithm. Algorithm name words should be separated by underscore `_` Example 1: https://alg.cubepal.app?pat=M2_E2_S2&name=Checkerboard Opens the cube with the checkerboard pattern using the `M2 E2 S2` sequence Example 2: https://alg.cubepal.app?=R_U_R-_U-_R-_F_R2_U-_R-_U-_R_U_R-_F-&name=T_Perm Opens the T Perm algorithm `R U R' U' R' F R2 U' R' U' R U R' F'`
`super`	super=	Specifies the type of supercube⁵. Default supercube: `arrows` - a supercube with arrow stickers. Note: If `super` parameter is omitted, a default cube (not supercube) is shown Example: https://alg.cubepal.app?=R-_F_U_R&super= Opens a default supercube with arrow stickers
	super=none	Specifies a classic cube - not a supercube. Equivalent values: `classic`, `standard`, `regular` Example: https://alg.cubepal.app?=R-_F_U_R&super=none Opens the algorithm and a classic cube
	super=arrows	Specifies a supercube with arrow stickers. Equivalent values: `arrow`, `arr`, `shepherd` Example: https://alg.cubepal.app?=R-_F_U_R&super=arrows Opens the algorithm and a supercube with arrow stickers
	super=arrowheads	Specifies a supercube with arrowhead stickers. Equivalent value: `arrowhead` Example: https://alg.cubepal.app?=R-_F_U_R&super=arrowheads Opens the algorithm and a supercube with arrowhead stickers
	super=triangles	Specifies a supercube with triangle stickers. Equivalent values: `triangle`, `triangular` Example: https://alg.cubepal.app?=R-_F_U_R&super=triangles Opens the algorithm and a supercube with triangle stickers
	super=hint	Specifies a supercube with hint stickers. Equivalent values: `hints`, `pochmann`, `poch` Example: https://alg.cubepal.app?=R-_F_U_R&super=hint Opens the algorithm and a supercube with hint stickers
`mod`	mod=	Specifies the cube stickers mod. Default mod: `small` Example: https://alg.cubepal.app?=R-_F_U_R&mod= Parameter is ignored and opens a cube with default small rounded stickers
	mod=small	Specifies a mod with small classic stickers. Equivalent value: `classic`, `standard`, `regular` Example: https://alg.cubepal.app?=R-_F_U_R&mod=small Opens the algorithm and a cube with small rounded stickers
	mod=large	Specifies a mod with large borderless stickers. Equivalent value: `stickerless`, `borderless` Example: https://alg.cubepal.app?=R-_F_U_R&mod=large Opens the algorithm and a cube with large borderless stickers
	mod=carbon	Specifies a mod with carbon stickers Example: https://alg.cubepal.app?=R-_F_U_R&mod=carbon Opens the algorithm and a cube with carbon rounded stickers
`core`	core=	Specifies the cube core or body color or material. Default core: `black` Example: https://alg.cubepal.app?=R-_F_U_R&core= Paramater with empty value is ignored, and opens a cube with a default black core
	core=black	Specifies a black or dark core. Equivalent values: `b`, `dark` Example: https://alg.cubepal.app?=R-_F_U_R&core=black Opens the algorithm and a cube with black core
	core=white	Specifies a white or light core. Equivalent values: `w`, `light` Example: https://alg.cubepal.app?=R-_F_U_R&core=white Opens the algorithm and a cube with white core
`scheme`	scheme=	Specifies the color scheme of the cube. Default scheme: `western` Example: https://alg.cubepal.app?=R-_F_U_R&scheme= Paramater with empty value is ignored, and opens a cube with a western color scheme
	scheme=western	Specifies the western or BOY color scheme (Blue-Green, Orange-Red, Yellow-White color pairs for opposite cube faces). Equivalent value: `boy`, `west` Example: https://alg.cubepal.app?=R-_F_U_R&scheme=western Opens the algorithm and a cube with a western color scheme
	scheme=japanese	Specifies the Japanese color scheme (Yellow-Green, Orange-Red, Blue-White color pairs for opposite cube faces). Equivalent value: `jap`, `jpn` Example: https://alg.cubepal.app?=R-_F_U_R&scheme=japanese Opens the algorithm and a cube with a japanese color scheme
	scheme=custom	Specifies the custom color scheme as defined by the user Example: https://alg.cubepal.app?=R-_F_U_R&scheme=custom Opens the algorithm and a cube with a custom color scheme

CubePal App Versions

CubePal's functionality and parameters vary depending on the app version you are using:

Free Version: All features and parameters mentioned in this documentation are fully available for the 3x3x3 cube. For other cube sizes, please consider upgrading to the Pro Version of the app. You can download the FREE CubePal app on the App Store.
Pro Version: The Ad-Free Pro Version extends CubePal's unlimited capabilities to all cubes. If you wish to explore more and beyond the 3x3x3 cube, we recommend upgrading to the Pro Version of the app.

Legal Note

CubePal Links are distributed under the MIT License, which grants users the freedom to create, use and distribute them without any restrictions. All trademarks and brand names are the property of their respective owners, and are used for identification purposes only and does not imply endorsement.

FAQ

Question:

Why doesn't the CubePal Link open in the app?

Answer:

If you're experiencing the situation when the CubePal Link doesn't open in the app, please follow the following steps:

Ensure you tap the link on an iOS device: CubePal Links are designed to work on mobile devices. Make sure you are tapping the link on your iPhone of iPad where the CubePal app is already installed.
Ensure the latest version of the CubePal app is installed: CubePal Links functionality was introduced for beta testing in version 2.5 of the app and fully implemented in version 2.6. Please check for updates in the App Store.
The link still opens in a webpage? In some cases, CubePal Links may open in Safari on your mobile device rather than the app. If this happens, tap the Open button on the Smart App Banner at the top of the webpage. This will redirect you to the CubePal app.
If you opened a CubePal Link in the app before but accidentally chose to open it in the browser from the long-press menu, the link might stop opening in the app. To fix this, simply long-press the CubePal Link again and select "Open in CubePal".

Notes:

Algorithm is a pre-established sequence of cube turns or moves designed to transform a scrambled or unsolved cube into the solved state. Algorithm sequence starts from the unsolved state of the cube. ↩
Scramble is a sequence of cube turns or moves applied to a solved cube creating a randomly shuffled arrangement of its pieces, usually used for solving competitions. Scramble sequence starts from the solved state of the cube. ↩
Reconstruction is a sequence of cube turns or moves that represents a detailed record of the exact turns applied by someone to the cube, from its initial scrambled state to its final solved state. Reconstruction sequence starts from the unsolved state of the cube. ↩
Pattern is a sequence of cube turns or moves applied to a solved cube, resulting in a visually appealing and/or symmetric arrangement of colors or stickers on its faces used for artistic and aesthetic purposes. Pattern sequence starts from the solved state of the cube. ↩
Supercube or picture cube is a modified version of a classic cube where the additional challenge lies in the requirement to also solve/align the centerpieces, making it more difficult to solve than a regular cube. ↩

Download | Privacy Policy | Support | Contact Us