Emulation/docs
1
0
Fork 0
mirror of https://github.com/libretro/docs.git synced 2024-06-16 03:17:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #98 from felinben/master

Browse source 
Add docs for new core: Theodore
This commit is contained in:
Twinaphex 2018-05-01 04:24:09 +02:00 committed by GitHub
parent 8ec81ef548 6fac509eb6
commit 2c7f544c3b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 169 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/image/core/theodore/to8d_keyboard.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 30 KiB

BIN
docs/image/core/theodore/to8d_os.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 42 KiB

160
docs/library/theodore.md Normal file
View file

@ -0,0 +1,160 @@
# Thomson - TO8D (Theodore)
## Background
Theodore is a Thomson TO8D system emulator based on the Daniel Coulom's DCTO8D emulator. The Thomson TO8 is a home computer introduced by French company Thomson SA in 1986. The Thomson TO8D is an improved version that includes a built-in 3.5" floppy drive.
The Theodore core has been authored by
- Thomas Lorblanchès
The Theodore core is licensed under
- [GPLv3](https://github.com/Zlika/theodore/blob/master/LICENSE)
A summary of the licenses behind RetroArch and its cores have found [here](https://docs.libretro.com/tech/licenses/).
## Requirements
None
## BIOS
The Theodore core does not feature BIOS use.
## Extensions
Content that can be loaded by the Theodore core have the following file extensions:
- .fd (floppy disk)
- .sap (floppy disk)
- .k7 (tape)
- .rom (cartridge)
- .m7 (cartridge)
## Features
Frontend-level settings or features that the Theodore 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](https://docs.libretro.com/guides/softpatching/) | - |
| Disk Control | - |
| Username | - |
| Language | - |
| Crop Overscan | - |
| LEDs | - |
### Directories
The Theodore core's internal core name is 'theodore'
**Frontend's System directory**
| File | Description |
|:------------:|:-----------:|
| theodore.cfg | Config file |
### Geometry and timing
- The Theodore core's base width is 672 pixels
- The Theodore core's base height is 432 pixels
## Usage
![](../image/core/theodore/to8d_os.jpg)
Click the top yellow rectangle on the right-hand side.
## Core options
The Theodore core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded.
- **Floppy write protection** [theodore_floppy_write_protect] (disabled|**enabled**)
- **Tape write protection** [theodore_tape_write_protect] (disabled|**enabled**)
- **Dump printer data to file** [theodore_printer_emulation] (**disabled**|enabled)
## User 1 device types
The Theodore core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):
- None - Input disabled
- **RetroPad** - Joypad
- RetroPad w/ Analog - Joypad
## Other devices
- Light pen - The TO8 light pen inputs are mapped to the mouse
## Joypad
| RetroPad Inputs | User 1 input descriptors |
|----------------------------------------|-----------------------------|
| ![](../image/retropad/retro_a.png) | "Fire" button |
| ![](../image/retropad/retro_b.png) | Start button |
| ![](../image/retropad/retro_x.png) | Virtual keyboard: go up |
| ![](../image/retropad/retro_y.png) | Virtual keyboard: go down |
| ![](../image/retropad/retro_start.png) | Virtual keyboard: keystroke |
On controllers without Y/X keys, select can also be used to roll the virtual keyboard up. The order of the keys in the virtual keyboard is: digits (0->9) then letters (A->Z) then "Enter".
## Keyboard
![](../image/core/theodore/to8d_keyboard.jpg)
| RetroKeyboard Inputs | Theodore Inputs |
|------------------------------|---------------------------|
| Keyboard Tab | STOP |
| Keyboard Left Control | CNT |
| Keyboard Caps Lock | CAPSLOCK |
| Keyboard Left Alt | ACC |
| Keyboard Home | HOME |
| Keyboard Up | UP |
| Keyboard Down | DOWN |
| Keyboard Right | RIGHT |
| Keyboard Left | LEFT |
| Keyboard Insert | INS |
| Keyboard Delete | DEL |
| Keyboard F1 | F1 |
| Keyboard F2 | F2 |
| Keyboard F3 | F3 |
| Keyboard F4 | F4 |
| Keyboard F5 | F5 |
| Keyboard F6 | Shift + F1 |
| Keyboard F7 | Shift + F2 |
| Keyboard F8 | Shift + F3 |
| Keyboard F9 | Shift + F4 |
| Keyboard F10 | Shift + F5 |
## Mouse
| RetroMouse Inputs | Theodore Inputs |
|-------------------------------------------------------|---------------------------|
| ![](../image/retromouse/retro_mouse.png) Mouse Cursor | Light pen cursor |
| ![](../image/retromouse/retro_left.png) Mouse 1 | Selection |
## External Links
- [Libretro Theodore Github Repository](https://github.com/Zlika/theodore)
- [Report Libretro Theodore Core Issues Here](https://github.com/Zlika/theodore/issues)
- [Libretro Theodore Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/theodore_libretro.info)
- [Official DCTO8D Website](http://dcto8.free.fr/)

3
docs/meta/core_list.md
View file

@ -120,6 +120,7 @@
- TempGBA
- TGB Dual
- The Powder Toy
- Theodore
- TyrQuake
- UME 2014
- Uzem
@ -134,4 +135,4 @@
- Video Processor
- Virtual Jaguar
- XRick
- Yabause
- Yabause

5
docs/meta/todo.md
View file

@ -580,6 +580,11 @@ Add core max height
- Add core max height
- Add core provided aspect ratio.
### [〰️] Theodore
- Feature: more tests required
- Geometry/timing: FPS, sample rate, aspect ratio, max width/weight
### [〰️] TyrQuake
- Complete expansion pack section.

1
docs/tech/licenses.md
View file

@ -177,6 +177,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
| TempGBA | [GPLv2](https://github.com/libretro/TempGBA-libretro/blob/master/copyright) | |
| [TGB Dual](../library/tgb_dual.md) | [GPLv2](https://github.com/libretro/tgbdual-libretro/blob/master/docs/COPYING-2.0.txt) | |
| [The Powder Toy](../library/the_powder_toy.md) | [GPLv3](https://github.com/libretro/ThePowderToy/blob/master/LICENSE) | |
| [Theodore](../library/theodore.md) | [GPLv3](https://github.com/Zlika/theodore/blob/master/LICENSE) | |
| [TyrQuake](../library/tyrquake.md) | [GPLv2](https://github.com/libretro/tyrquake/blob/master/gnu.txt) | |
| UME 2014 | [MAME (Non-commercial)](https://github.com/libretro/mame2014-libretro/blob/master/docs/license.txt) | Non-commercial |
| [Uzem](../library/uzem.md) | [GPLv3](https://github.com/Uzebox/uzebox/blob/master/gpl-3.0.txt) | |

1
mkdocs.yml
View file

@ -88,6 +88,7 @@ pages:
- 'Magnavox - Odyssey2 / Phillips Videopac+ (O2EM)': 'library/o2em.md'
- 'Sharp - X68000 (PX68k)': 'library/px68k.md'
- 'ScummVM': 'library/scummvm.md'
- 'Thomson - TO8D (Theodore)': 'library/theodore.md'
- 'Uzebox (Uzem)': 'library/uzem.md'
- 'GCE - Vectrex (vecx)': 'library/vecx.md'
- 'Bandai - WonderSwan/Color (Beetle Cygne)': 'library/beetle_cygne.md'