diff options
| author | Sebastiano Tronto <sebastiano@tronto.net> | 2023-10-31 19:17:42 +0100 |
|---|---|---|
| committer | Sebastiano Tronto <sebastiano@tronto.net> | 2023-10-31 19:17:42 +0100 |
| commit | d65ce8e86b517ef3f7d48cf5ded1101444e05b2b (patch) | |
| tree | 6ac473a067fa06dbd64691adf2ddaafd8adc6e06 /doc/CUBE_TEXT.md | |
| parent | bc2e6b8a8d5a6eccd2c2ac433e8a307ee356f14e (diff) | |
| download | nissy-core-d65ce8e86b517ef3f7d48cf5ded1101444e05b2b.tar.gz nissy-core-d65ce8e86b517ef3f7d48cf5ded1101444e05b2b.zip | |
Reorganized documentation
Diffstat (limited to 'doc/CUBE_TEXT.md')
| -rw-r--r-- | doc/CUBE_TEXT.md | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/doc/CUBE_TEXT.md b/doc/CUBE_TEXT.md deleted file mode 100644 index b9234fc..0000000 --- a/doc/CUBE_TEXT.md +++ /dev/null | |||
| @@ -1,37 +0,0 @@ | |||
| 1 | # Textual representation of the cube | ||
| 2 | |||
| 3 | The functions readcube() and writecube() use different formats to read | ||
| 4 | and write a cube to text. Not all formats are supported for both input | ||
| 5 | and output. | ||
| 6 | |||
| 7 | ## H48 - standard format for h48 (read, write) | ||
| 8 | |||
| 9 | Each edge is represented by two letters denoting the sides it belongs to | ||
| 10 | and one number denoting its orientation (0 oriented, 1 mis-oriented). | ||
| 11 | Similarly, each corner is represented by three letters and a number | ||
| 12 | (0 oriented, 1 twisted clockwise, 2 twisted counter-clockwise). | ||
| 13 | Edge orientation is relative to the F / B axis, corner orientation is | ||
| 14 | relative to the U / D axis. | ||
| 15 | |||
| 16 | The pieces are ordered such that the solved cube looks like this: | ||
| 17 | |||
| 18 | UF0 UB0 DB0 DF0 UR0 UL0 DL0 DR0 FR0 FL0 BL0 BR0 | ||
| 19 | UFR0 UBL0 DFL0 DBR0 UFL0 UBR0 DFR0 DBL0 | ||
| 20 | |||
| 21 | Whitespace (including newlines) between pieces is ignored when reading | ||
| 22 | the cube, and a single whitespace character is added between pieces | ||
| 23 | when writing. | ||
| 24 | |||
| 25 | The cube after the moves R'U'F looks like this: | ||
| 26 | |||
| 27 | FL1 BR0 DB0 UR1 UF0 UB0 DL0 FR0 UL1 DF1 BL0 DR0 | ||
| 28 | UBL1 DBR1 UFR2 DFR2 DFL2 UBL2 UFL2 DBL0 | ||
| 29 | |||
| 30 | ## SRC - representation of the object in C code for cube_array (write) | ||
| 31 | |||
| 32 | The exact format depends on the internal cube representation. It is | ||
| 33 | guaranteed that, if OUT is the output in this format, the line | ||
| 34 | |||
| 35 | cube_t cube = OUT; | ||
| 36 | |||
| 37 | is interpreted correctly by h48. | ||
