diff --git a/docs/image/core/b2/bbc-micro-keyboard.png b/docs/image/core/b2/bbc-micro-keyboard.png new file mode 100644 index 0000000000..3bc3368eb3 Binary files /dev/null and b/docs/image/core/b2/bbc-micro-keyboard.png differ diff --git a/docs/image/core/b2/iso-mapping-for-bbc-micro.png b/docs/image/core/b2/iso-mapping-for-bbc-micro.png new file mode 100644 index 0000000000..7348c4dde4 Binary files /dev/null and b/docs/image/core/b2/iso-mapping-for-bbc-micro.png differ diff --git a/docs/library/b2.md b/docs/library/b2.md new file mode 100644 index 0000000000..e8e2eb8ac9 --- /dev/null +++ b/docs/library/b2.md @@ -0,0 +1,149 @@ +# Acorn - BBC Micro (b2-libretro) + +## Background + +Emulate the BBC Micro, a series of microcomputers designed and built by Acorn Computers Limited in the 1980s for the Computer Literacy Project of the BBC. + +The b2-libretro core has been authored by: + +- Tom Seddon (b2) +- Zoltan Balogh (libretro core specific modifications) + +The b2 core is licensed under [GPL v3](https://github.com/zoltanvb/b2-libretro#licence). A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md). + +## Requirements + +No special requirements. To be tested yet on low end platforms. + +## Extensions + +Content that can be loaded by the b2 core have the following file extensions: + +- `.ssd/.dsd` - Floppy disk image + +RetroArch database(s) that are associated with the b2 core: + +- None yet + +## Features + +Frontend-level settings or features that the b2 core respects. + +| Feature | Supported | +|-------------------|:---------:| +| Restart | ✔ | +| Saves | ✕ | +| States | ✕ | +| Rewind | ✕ | +| Netplay | ✕ | +| Core Options | ✔ | +| RetroAchievements | ✕ | +| RetroArch Cheats | ✕ | +| Native Cheats | ✕ | +| Controls | ✔ | +| Remapping | - | +| Multi-Mouse | ✕ | +| Rumble | ✕ | +| Sensors | ✕ | +| Camera | ✕ | +| Location | ✕ | +| Subsystem | ✕ | +| [Softpatching](../guides/softpatching.md) | ✕ | +| Disk Control | ✔ | +| Username | ✕ | +| Language | ✕ | +| Crop Overscan | ✕ | +| LEDs | ✕ | + +## Directories + +No additional directories used, only content disk image is needed. + +## Geometry and timing + +- The b2 core's core provided FPS is 50 +- The b2 core's core provided sample rate is 250 kHz (to be optimized) +- The b2 core's base width is 768 +- The b2 core's base height is 288 +- The b2 core's max width is 768 +- The b2 core's max height is 576 (interlace mode) +- The b2 core's core provided aspect ratio is 4:3 + +## Usage + +Load any supported content file. Content type will be autodetected, and if possible, started: + +- If disk image name contains an executable file name in brackets (such as `[CHUCKIE]`), a `CHAIN` command will be issued shortly after initial booting +- If disk image name does not contain such indication, Shift key press will be simulated during boot to trigger autoboot function + +In case of multi-disk games, use the Disk Control menu to add the subsequent images and switch between them. + +## Core options + +The b2 core has the following option(s) that can be tweaked from the core options menu. + +- Emulated machine + - `B/Acorn 1770` + - `B/Watford 1770 (DDB2)` + - `B/Watford 1770 (DDB3)` + - `B/Opus 1770` + - `B/Opus CHALLENGER 256K` + - `B/Opus CHALLENGER 512K` + - `B+` + - `B+128` +- Autoboot (on|off) +- Keyboard assignments for each RetroPad button + +## Joypad mapping + +The analogue joysticks are mapped to the left analog stick and face button A for RetroArch player 1 and 2 slots. + +Joypad is fully assignable to keyboard keys in core options. + +## Keyboard + +Keyboard layout of the BBC Micro: +![](../image/core/b2/bbc-micro-keyboard.png) + +Most mappings are straightforward positionally from an ISO UK keyboard: + +- Dark green: natural mapping, both position and function matches nicely +- Light green: either position or function is slightly different +- Yellow: function is different +- Red: extra mapping +- Dark grey: keys intentionally reserved for RetroArch / OS functions + +![](../image/core/b2/iso-mapping-for-bbc-micro.png) + +Exceptions are marked in the following table: + +| RetroKeyboard Inputs | BBC Micro keyboard input | +|------------------------------|---------------------------| +| Keyboard F10 | f0 | +| Keyboard F11 | Break | +| Keyboard Pause | Break | +| Keyboard Backspace | Delete | +| Keyboard Backquote ` | Escape (alternative mapping) | +| Keyboard Equals = | ^ (caret) | +| Keyboard Oem 102 | \\ (backslash) | +| Keyboard Home | \\ (alternative mapping) | +| Keyboard Backspace | Delete | +| Keyboard Left Bracket [ | @ (at) | +| Keyboard Right Bracket ] | [ (left bracket) | +| Keyboard End | _ (underline) | +| Keyboard Quote ' | : (colon) | +| Keyboard Backslash \ | ] (right bracket) (shown as # in ISO map) | +| Keyboard Delete | Delete | +| Keyboard PgUp | Caps Lock | +| Keyboard PgDn | Shift Lock | +| Keyboard NumLock | Shift Lock | +| Keyboard Insert | Copy | + +## External Links + +- [Official b2-libretro core repository](https://github.com/zoltanvb/b2-libretro) +- [Libretro b2 Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/b2_libretro.info) +- [Report Libretro b2 Core Issues Here](https://github.com/zoltanvb/b2-libretro/issues) +- [Original b2 Implementation](https://github.com/tom-seddon/b2) +- [Complete BBC Micro Games Archive](https://www.bbcmicro.co.uk/) +- [Stardot forums](https://www.stardot.org.uk/forums/) - BBC Micro community diff --git a/mkdocs.yml b/mkdocs.yml index 64001990a5..4c28752081 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -109,6 +109,8 @@ nav: - '3DO Emulation': - 'The 3DO Company - 3DO (Opera)': 'library/opera.md' - '3DO Compatibility List': 'library/compatibility/3do.md' + - 'Acorn Emulation': + - 'Acorn - BBC Micro (b2)': 'library/b2.md' - 'Amstrad Emulation': - 'Amstrad - CPC (Caprice32)': 'library/caprice32.md' - 'Amstrad - CPC (CrocoDS)': 'library/crocods.md'