Skip to content

Commit a74a250

Browse files
authored
Merge pull request #68 from ojwb/doc-updates
Doc updates
2 parents 4bc5ef7 + 832aeca commit a74a250

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

docs/user guide.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Bot execution modes
3232

3333
### Unexpected behavior with 🎬 mode animations
3434

35-
We use the beebjit `-fast` parameter to achive very fast emulation in the accelerated modes, the only downside being some unexpected 'relativistic' effects if your code relies on external timers. In this mode CPU time is accelerated several thousandfold and decoupled from timing of BBC Micro peripherals and timers which remain emulated in real-time. This means flashing colours in the palette, and `*FX 19` or `INKEY` based timing will not work well!
35+
We use the beebjit `-fast` parameter to achieve very fast emulation in the accelerated modes, the only downside being some unexpected 'relativistic' effects if your code relies on external timers. In this mode CPU time is accelerated several thousandfold and decoupled from timing of BBC Micro peripherals and timers which remain emulated in real-time. This means flashing colours in the palette, and `*FX 19` or `INKEY` based timing will not work well!
3636

3737
If your code waits for an external timer based event like VSYNC the video will appear to freeze. It's recommended to use `FOR ... NEXT` loop based delays in code you intend to run with 🎬 mode for that reason. The emulator takes a screenshot every 40,000 emulated 6502 cycles (which is the same period as VSYNC) and so resulting animation will still look [pretty much the same on a real machine](https://twitter.com/bbcmicrobot/status/1356755101587697669?s=20).
3838

@@ -49,7 +49,7 @@ The [Owlet Editor](https://bbcmic.ro) is designed specifically for creative codi
4949

5050
## Reducing code size
5151

52-
One of the fun and challenging aspects of the bot is you need to squeeze your code down in size - code golf! Techniques to do this have evolved over time, many pioneered by [Rheolism](https://botsin.space/@rheolism). Here we outline some fundamental approaches, this is by no means comprehensive.
52+
One of the fun and challenging aspects of the bot is you need to squeeze your code down in size - code golf! Techniques to do this have evolved over time, many pioneered by [Rheolism](https://oldbytes.space/@rheolism). Here we outline some fundamental approaches, this is by no means comprehensive.
5353

5454
```
5555
10 PRINT "HELLO WORLD"
@@ -89,12 +89,14 @@ Note that some byte values must be ORed with 0x100 in order to map to a valid Un
8989

9090
### base2048 encoding [deprecated for Mastodon due to larger post length]
9191

92-
[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. For this reason we no longer support base2048 on the Mastodon bot.
92+
[Base2048](https://github.com/qntm/base2048) is a Unicode encoding optimized for transmitting binary data through Twitter. Using base2048 allowed an extra 100 characters of BBC BASIC code in a tweet, bringing the total to ~384 characters. However our Hello World tweet would no longer be human readable:
9393

9494
```
9595
༣Ȝǁঐ౭चؼ๗ԪʢࠁನȤ3
9696
```
9797

98+
For this reason and because the Mastodon bot supports 512 characters we no longer support base2048.
99+
98100
## Advanced minification techniques
99101

100102
### VDU and graphics commands
@@ -123,4 +125,4 @@ PRINT D?A
123125
NEXT
124126
```
125127

126-
In this example the first value returned would be 116, the ASCII value for the letter `t`. You can create a Twitter-friendly byte string to use in a `REM` from comma separated data with the [VDU to string tool](https://8bitkick.github.io/vdu/)
128+
In this example the first value returned would be 116, the ASCII value for the letter `t`. You can create a Mastodon-friendly byte string to use in a `REM` from comma separated data with the [VDU to string tool](https://8bitkick.github.io/vdu/)

test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ function Tests(since_id){
8181
},
8282
{
8383
name: "MENTIONS", // Test mention and hashtag removal
84-
text: "<span class=\"h-card\"><a href=\"https://mastodon.me.uk/@bbcmicrobot\" class=\"u-url mention\">@<span>BBCMicroBot</span></a></span> <span class=\"h-card\"><a href=\"https://mastodon.nz/@rheolism\" class=\"u-url mention\">@<span>RhEolisM</span></a></span> <a href=\"https://mastodon.me.uk/tags/bbcmicrobot\" class=\"mention hashtag\" rel=\"tag\">#<span>bbcmicrobot</span></a> 1V.279;0;0;0;0;12:PRINTCHR$141\"Hello\"'CHR$141\"Hello\"CHR$21\n",
84+
text: "<span class=\"h-card\"><a href=\"https://mastodon.me.uk/@bbcmicrobot\" class=\"u-url mention\">@<span>BBCMicroBot</span></a></span> <span class=\"h-card\"><a href=\"https://oldbytes.space/@rheolism\" class=\"u-url mention\">@<span>RhEolisM</span></a></span> <a href=\"https://mastodon.me.uk/tags/bbcmicrobot\" class=\"mention hashtag\" rel=\"tag\">#<span>bbcmicrobot</span></a> 1V.279;0;0;0;0;12:PRINTCHR$141\"Hello\"'CHR$141\"Hello\"CHR$21\n",
8585
mediaType: "image/png",
8686
checksum: "10e6285dc55ec5ddab8470e8f038725db2d0ffbc"
8787
},

0 commit comments

Comments
 (0)