Skip to content

Commit

Permalink
docs: Guide for charset and attatch side for peripherals
Browse files Browse the repository at this point in the history
  • Loading branch information
SammyForReal committed Dec 17, 2023
1 parent f9dc6ee commit 2b1187b
Show file tree
Hide file tree
Showing 8 changed files with 64 additions and 3 deletions.
53 changes: 53 additions & 0 deletions docs/guides/charset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Using the charset via Create displays

CC: Tweaked has a special charset. It's based of a combination of different standards actually. The problem however is, that Minecraft and Create doesn't use this charset. While other mods barely handle this problem and grant the Computer raw access to the displays, CC:C Bridge converts the characters to something displayable.

## Legacy Formatting is disabled

While this works for of the characters easily, some can't be converted, like the section symbol (`§`), as [Notch's legacy text formatting system](https://minecraft.wiki/w/Formatting_codes) uses it. _(Players in Minecraft actually can't type it in game as well at any time!)_

## The CCCCset (CC:C Charset)

Because of this, some characters have been replaced. **They convert from and to Create or CC either direction to ensure an easy way to process symbols on any side.**

This is how the charset looks like on monitors and displays outside of CC:

```
|0 1 2 3 4 5 6 7 8 9 A B C D E F
-+--------------------------------
0| ☺ ☻ ♥ ♦ ♣ ♠ ● ○ ♂ ♀ ♪ ♬
1|▶ ◀ ↕ ‼ ¶ ░ ▬ ↨ ⬆ ⬇ ➡ ⬅ ∟ ⧺ ▲ ▼
2| ! " # $ % & ' ( ) * + , - . /
3|0 1 2 3 4 5 6 7 8 9 : ; < = > ?
4|@ A B C D E F G H I J K L M N O
5|P Q R S T U V W X Y Z [ \ ] ^ _
6|` a b c d e f g h i j k l m n o
7|p q r s t u v w x y z { | } ~ ▒
8|⠀ ⠁ ⠈ ⠉ ⠂ ⠃ ⠊ ⠋ ⠐ ⠑ ⠘ ⠙ ⠒ ⠓ ⠚ ⠛
9|⠄ ⠅ ⠌ ⠍ ⠆ ⠇ ⠎ ⠏ ⠔ ⠕ ⠜ ⠝ ⠖ ⠗ ⠞ ⠟
A|▓ ¡ ¢ £ ¤ ¥ ¦ █ ¨ © ª « ¬ ­ ® ¯
B|° ± ² ³ ´ µ ¶ · ¸ ¹ º » ¼ ½ ¾ ¿
C|À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï
D|Ð Ñ Ò Ó Ô Õ Ö × Ø Ù Ú Û Ü Ý Þ ß
E|à á â ã ä å æ ç è é ê ë ì í î ï
F|ð ñ ò ó ô õ ö ÷ ø ù ú û ü ý þ ÿ
```

The charsets are equal to each other by about ~98%.
The 'blit' characters _(from \\128 to \\159)_ have been untouched, although they don't really work on Flip Displays and Nixie Tubes. They do work on Vanilla displays like Signs and Lecterns however.

### Differences

Those are the main differences that have been made to the chars:

- **\\016** (`§`) in CC changes to **\\u2591** (``) in Create
- **\\160** (` `) in CC changes to **\\u2591** (``) in Create
- **\\167** (`§`) in CC changes to **\\u2591** (``) in Create

As the pattern here gives it away, this mainly affects the symbols used for legacy formatting and the dithered blocks used by Create.
This makes it possible to make the same progressbars as Create uses them.

## Example

The line `Power: ███▓░░░` in Create would convert to `Power: §§§ §§§` in CC. Keep in mind, that the second row of `§` is **\\016** and not **\\167** like the first row.
Same goes the other way around as well.
4 changes: 3 additions & 1 deletion docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ Here are some guides that might be helpful.
| Title | Description |
|-------|-------------|
| [**Wrenches and You**](wrenches.md) | Learn more about what is possible with Wrenches. |
| [**Using Animatronics: The Analog Way**](positioningAnimatronicAnalog.md) | Want to integrate the Animatronic in your buildings without knowing how to use a Computer? |
| [**Using Animatronics: The Analog Way**](positioningAnimatronicAnalog.md) | Want to integrate the Animatronic in your buildings without knowing how to use a Computer? |
| [**Animating Animatronics using Blockbench**](positioningAnimatronicsBlockbench.md) | Blockbench can make it _much_ easier to have many different animations. |
| [**Using the charset via Create displays**](charset.md) | Blockbench can make it _much_ easier to have many different animations. |
1 change: 1 addition & 0 deletions docs/peripherals/AnimatronicPeripheral.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The transition from one pose to a new one is fully automatic - and rusty.
|-|-|
| Peripheral | v1 |
| Attach name | `"animatronic"` |
| Attach side | only `"top"` |

---

Expand Down
1 change: 1 addition & 0 deletions docs/peripherals/RedRouterBlockPeripheral.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The sides are configured similarly to the turtle, where `"left"` is **relative t
|-|-|
| Peripheral | v1 |
| Attach name | `"redrouter"` |
| Attach side | all |

### Events

Expand Down
1 change: 1 addition & 0 deletions docs/peripherals/ScrollerBlockPeripheral.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The peripheral uses Create's `NumberBehaviour` selection screen. _(The same one
|-|-|
| Peripheral | v2 |
| Attach name | `"scroller"` |
| Attach side | only `"back"` |

### Events

Expand Down
1 change: 1 addition & 0 deletions docs/peripherals/SourceBlockPeripheral.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The peripheral acts similar to a normal [Terminal](https://tweaked.cc/module/ter
|-|-|
| Peripheral | v1.1 |
| Attach name | `"create_source"` |
| Attach side | all |

### Events

Expand Down
1 change: 1 addition & 0 deletions docs/peripherals/TargetBlockPeripheral.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The peripheral only has some implementations from the [Window API](https://tweak
|-|-|
| Peripheral | v1.1 |
| Attach name | `"create_target"` |
| Attach side | all |

---

Expand Down
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ site_name: CC:C Bridge
site_description: The documentation for the CC:C Bridge mod.
site_author: Tweaked Programs

copyright: Copyright © 2023 Sammy L. Koch
copyright: Copyright © 2023-2024 Sammy L. Koch

nav:
- Home:
Expand All @@ -16,9 +16,10 @@ nav:
- Animatronic: peripherals/AnimatronicPeripheral.md
- Guides:
- guides/index.md
- Wrenches and You: guides/wrenches.md
- "Wrenches and You": guides/wrenches.md
- "Using Animatronics: The Analog Way": guides/positioningAnimatronicAnalog.md
- "Animating Animatronics using Blockbench": guides/positioningAnimatronicsBlockbench.md
- "Using the charset via Create displays": guides/charset.md

site_url: https://cccbridge.tweaked-programs.cc/
repo_name: tweaked-programs/cccbridge
Expand Down

0 comments on commit 2b1187b

Please sign in to comment.