Skip to content

Commit af6da0f

Browse files
committed
Synchronise user guide with master
1 parent aa6c896 commit af6da0f

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/user guide.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,17 @@ Normally the bot runs your code for 30 seconds, and then takes 3 second video cl
1818

1919
You can add an emoji to the end of your tweet to send a command to the bot. These are not included in the program sent to the BBC Micro emulator, and should not be in your code in Owlet. Because the [emulator is very fast](https://github.com/scarybeasts/beebjit) a 3 hour emulation only takes a few seconds. Although the emulation is fast the video capture at the end is real-time - the 🎬 is the same as leaving a real BBC Micro running for 3 hours and then afterwards taking a look at the screen for 3 seconds.
2020

21-
*Note - GXR graphics functions are **not available** in the 🚀 or 🎬 modes!*
2221

23-
🚀 The rocket emoji instructs the bot to run a 3 hour emulation and then capture a screenshot
22+
Bot execution modes
2423

25-
🎬 The clapper board is runs like rocket but then captures a 3 second video
24+
| Emoji | Pre render | GXR | Output. |
25+
| ----------- | ----------- | ----| ----------- |
26+
| None | 30 sec | Yes | 3 sec video |
27+
| 🎬 | 3 hours* | No | 3 sec video |
28+
| 🚀 | 3 hours* | No | screen shot |
2629

27-
🗜️ The clamp icon is no longer used. It was used to show a tweet was base2048 encoded, but this is now autodetected.
30+
31+
\* The bot runs 3 hours equivalent 6502 execution in just a few seconds thanks to Beebjit!
2832

2933
### Unexpected behavior with 🎬 mode animations
3034

@@ -89,19 +93,14 @@ As with the original implementation each BBC BASIC keyword is represented in mem
8993
Note that some byte values must be ORed with 0x100 in order to map to a valid Unicode character that can be used in the editor or in a tweet. For byte tokens this is done automatically in Owlet, and the BBC Micro emulator ANDs all character codepoints with 0xFF to return them to single byte values.
9094

9195

92-
### base2048 encoding
96+
### base2048 encoding [deprecated for Mastodon due to larger post length]
9397

9498
[Base2048](https://github.com/qntm/base2048) is a Unicode encoding optimized for transmitting binary data through Twitter. Using base2048 gives you an extra 100 characters of BBC BASIC code in a tweet, bringing it to ~384 characters in total. However our Hello World tweet will no longer be human readable:
9599

96100
```
97101
༣Ȝǁঐ౭चؼ๗ԪʢࠁನȤ3
98102
```
99103

100-
The [Owlet Editor](https://bbcmic.ro) will automatically encode any tweet as base2048 if it is over 280 characters in length. It will only encode when you hit the `share` button and send as a tweet. You can also decode in Owlet with the `Expand` button.
101-
102-
*Every reply tweet from BBC Micro Bot includes a link to source which allows you to decode base2048 into BBC BASIC.*
103-
104-
105104
## Advanced minification techniques
106105

107106
### VDU and graphics commands

0 commit comments

Comments
 (0)