Kyuubu documentation
Kyuubu キューブ — Twisty cube puzzle for the browser
Turn CSS 3D cubes by touch, keys or notation, reproduce a scramble from a seed, and follow a solve one named step at a time.
Install
npm install @johnmorrisdotca/kyuubu
Start here
Entry points
| Import it | What it is | Size |
|---|---|---|
@johnmorrisdotca/React components · 5 exports | 29.4 kB | |
@johnmorrisdotca/Record solves · 3 exports | 1.8 kB | |
@johnmorrisdotca/Replay player · 4 exports | 28.7 kB | |
@johnmorrisdotca/Cube elements · 9 exports | 30.8 kB | |
@johnmorrisdotca/Register cube tags · 2 exports | 30.7 kB | |
@johnmorrisdotca/Cuboid engine · 61 exports | 9.4 kB | |
@johnmorrisdotca/Cuboid drawing · 3 exports | 8.8 kB | |
@johnmorrisdotca/Cuboid player · 4 exports | 19.7 kB | |
@johnmorrisdotca/Cuboid elements · 4 exports | 20.3 kB | |
@johnmorrisdotca/Register cuboids · 1 exports | 20.3 kB | |
@johnmorrisdotca/Cube engine and views · 189 exports | 38.7 kB |
Guides
How-to
- Mount a cubeDraw a cube in a host element and choose its input, colours and React component.
- Replay a solveCheck a solve's notation, replay it with a player, set its timing and save it as a record.
- Use a cuboidChoose cuboid dimensions, match turns to the slice shape, and draw and replay a cuboid.
- Embed and share a cubePut a cube or a scrambling cube on a page with the builder, the custom elements or an iframe, and share the settings as a link.
- Input and motionChoose where keys go, how drags pick a layer, and how a scrambling cube is paced and stopped.
Explanation
- State and notationRead how a cube is stored as stickers, how turns are parsed, and which entry point holds what.
- The method and the guideGet beginner-method steps for 2×2 and 3×3, and follow a guide that reacts to real turns.