libretro/docs
1
0
Fork 0
mirror of https://github.com/libretro/docs.git synced 2024-11-27 10:40:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/libretro/docs

Browse Source
This commit is contained in:
Hedonium 2018-03-09 12:36:11 -05:00
commit 98f45fd9f6
3 changed files with 194 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

163
docs/library/mame_2010.md Normal file
View File

@ -0,0 +1,163 @@
# Arcade (MAME 2010)
## Background
MAME 2010 is a port of MAME 0.139 for libretro, originally sourced from https://github.com/mamedev/mame/releases/download/mame0139/mame0139s.zip
The OSD code is inspired by other MAME ports :
- mame2003: https://github.com/libretro/mame2003-libretro
- ps3 mame0.125: http://www.volny.cz/molej/ps3/mame_ps3.htm
- mame4droid: http://code.google.com/p/imame4all/source/browse/
### Author/License
MAME 2010 code is copyright [Nicola Salmoria and the MAME team]((http://mamedev.org/)) and distributed under a [Non-Commercial MAME license](https://raw.githubusercontent.com/libretro/mame2010-libretro/master/docs/license.txt).
A summary of the licenses behind RetroArch and its cores have found [here](https://docs.libretro.com/tech/licenses/).
## Extensions
Content that can be loaded by MAME 2010 have the following file extensions:
- `.zip`
- `.7z`
- `.chd`
## Databases
RetroArch database(s) that are associated with the MAME 2010 core:
- [MAME 2010](https://github.com/libretro/libretro-database/blob/master/rdb/MAME%202010.rdb?raw=true)
## BIOS
BIOS files should either be placed in the same folder as the Arcade romset ZIP file, or should be incorporated into the Arcade romset ZIP file itself in a "Full Non-Merged" romset format.
## Features
Frontend-level settings or features that the (Core name) core respects.
| Feature | Supported |
|-------------------|:---------:|
| Restart | ✔ |
| Screenshots | ✔ |
| 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
MAME 2010 requires the folllowing directories exist, and will create them if they are missing:
- libretro system folder/mame2010/: location for cheat.zip cheats file
- libretro system folder/mame2010/artwork: MAME bezels and overlay files
- libretro system folder/mame2010/crosshairs: custom crosshair images
- libretro system folder/mame2010/fonts: custom fonts
- libretro system folder/mame2010/samples: audio sample zip files needed by some games
- libretro saves folder/mame2010/cfg: automatically-generated MAME configuration files
- libretro saves folder/mame2010/comment: MAME debugger comment files
- libretro saves folder/mame2010/ctrlr: MAME controller customization files
- libretro saves folder/mame2010/image: game image content
- libretro saves folder/mame2010/ini: MAME.ini files
- libretro saves folder/mame2010/input: Recorded input files
- libretro saves folder/mame2010/memcard: Save folder for emulated memcard device memory
- libretro saves folder/mame2010/nvram: Save folder for emulated nvram device memory
## Core options
The MAME 2010 core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded. Settings with (Restart) means that core has to be closed for the new setting to be applied on next launch.
- **Mouse supported** (disabled|enabled)
- **Video approach 1 Enabled** (disabled|enabled)
- **Hide game info screen** (disabled|enabled)
- **Hide warning screen** (disabled|enabled)
- **Core provided aspect ratio** (DAR|PAR)
- **Enable autofire** (disabled|button 1|button 2|R2 to button 1 mapping|R2 to button 2 mapping)
- **Set autofire pulse speed** (medium|slow|fast)
- **Set frameskip** (0|1|2|3|4|automatic)
- **Set sample rate** (Restart)** (48000Hz|44100Hz|32000Hz|22050Hz)
- **Set brightness** (default|+1%|+2%|+3%|+4%|+5%|+6%|+7%|+8%|+9%|+10%|+11%|+12%|+13%|+14%|+15%|+16%|+17%|+18%|+19%|+20%|-20%|-19%|-18%|-17%|-16%|-15%|-14%|-13%|-12%|-11%|-10%|-9%|-8%|-7%|-6%|-5%|-4%|-3%|-2%|-1%)
- **Set contrast** (default|+1%|+2%|+3%|+4%|+5%|+6%|+7%|+8%|+9%|+10%|+11%|+12%|+13%|+14%|+15%|+16%|+17%|+18%|+19%|+20%|-20%|-19%|-18%|-17%|-16%|-15%|-14%|-13%|-12%|-11%|-10%|-9%|-8%|-7%|-6%|-5%|-4%|-3%|-2%|-1%)
- **Set gamma** (default|+1%|+2%|+3%|+4%|+5%|+6%|+7%|+8%|+9%|+10%|+11%|+12%|+13%|+14%|+15%|+16%|+17%|+18%|+19%|+20%|-20%|-19%|-18%|-17%|-16%|-15%|-14%|-13%|-12%|-11%|-10%|-9%|-8%|-7%|-6%|-5%|-4%|-3%|-2%|-1%)
- **Use external hiscore.dat** (disabled|enabled)
## Controllers
MAME 2010 supports keyboard use and up to four joypads.
RetroPad MAME Equivalent
RETRO_DEVICE_ID_JOYPAD_START [KEY_START]
RETRO_DEVICE_ID_JOYPAD_SELECT [KEY_COIN]
RETRO_DEVICE_ID_JOYPAD_A [KEY_BUTTON_1]
RETRO_DEVICE_ID_JOYPAD_B [KEY_BUTTON_2]
RETRO_DEVICE_ID_JOYPAD_X [KEY_BUTTON_3]
RETRO_DEVICE_ID_JOYPAD_Y [KEY_BUTTON_4]
RETRO_DEVICE_ID_JOYPAD_L [KEY_BUTTON_5]
RETRO_DEVICE_ID_JOYPAD_R [KEY_BUTTON_6]
RETRO_DEVICE_ID_JOYPAD_L2 [KEY_TAB]
RETRO_DEVICE_ID_JOYPAD_R3 [KEY_F3]
RETRO_DEVICE_ID_JOYPAD_L3 [KEY_F2]
RETRO_DEVICE_ID_JOYPAD_UP [KEY_JOYSTICK_U]
RETRO_DEVICE_ID_JOYPAD_DOWN [KEY_JOYSTICK_D]
RETRO_DEVICE_ID_JOYPAD_LEFT [KEY_JOYSTICK_L]
RETRO_DEVICE_ID_JOYPAD_RIGHT [KEY_JOYSTICK_R]
#### Lightgun
To be written for MAME 2010
| RetroLightgun Inputs | (Device name) Inputs |
|--------------------------------------------------------|---------------------------|
| ![](../image/retromouse/retro_mouse.png) Gun Crosshair | - |
| Gun Trigger | - |
| Gun Reload | - |
| Gun Aux A | - |
| Gun Aux B | - |
| Gun Aux C | - |
| Gun Start | - |
| Gun Select | - |
| Gun D-pad Up | - |
| Gun D-pad Down | - |
| Gun D-pad Left | - |
| Gun D-pad Right | - |
## External Links
- [MAME 2010 Github Repository](https://github.com/libretro/mame2010-libretro)
- [MAMEdev](http://mamedev.org/)
- [MAME 2010 Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/mame2010_libretro.info)
- [MAME 2010 README](https://github.com/libretro/mame2010-libretro/blob/master/README.md)
- [Report MAME 2010 Issues Here](https://github.com/libretro/mame2010-libretro/issues)
### See also
- MAME 2000
- [MAME 2003](https://docs.libretro.com/library/mame2003.md)
- MAME 2014
- MAME 2016
- MAME

50
docs/library/sameboy.md
View File

@ -10,6 +10,7 @@ SameBoy is an extremely accurate open source Gameboy (DMG) and Gameboy Color (CG
- Includes open source DMG and CGB boot ROMs
- Real time clock emulation
- Extremely high accuracy
- Link-cable emulation
### Author/License
@ -97,17 +98,21 @@ The SameBoy core saves/loads to/from these directories.
### Geometry and timing
- The SameBoy core's core provided FPS is (FPS)
- The SameBoy core's core provided FPS is 59.7275 FPS
- The SameBoy core's core provided sample rate is 48000 Hz
- The SameBoy core's core provided aspect ratio is (Ratio)
- The SameBoy core's core provided aspect ratio is 10:9 in single mode, varies in dual mode
## Link
Link cable emulation is supported via the Subsystem API.
Link cable emulation is supported in single-cart mode and in dual-cart mode.
To use it in single-cart mode enable the **Single cart dual mode** option under options and reload the content
There are two ways to access the Subsystem API.
!!! note
The savefile for the second slot in this mode will be named 'gamename.srm.2'
**One way is to access the Subsystem API through RetroArch's GUI like this.**
To use it in dual-cart mode you have to load content via the Subsystem API which you can achieve via the GUI or via CLI
**Load content via Subsystem API from GUI**
First, we load the first GameBoy ROM through '2 Player Game Boy Link' in RetroArch's Main Menu.
@ -125,7 +130,12 @@ Then, we start the content by selecting 'Start GameBoy' In RetroArch's Menu Menu
![](../image/core/sameboy/start.png)
**The other way is to launch RetroArch with commandline like this.**
!!! warning
You have to load any game in the core for the '2 Player Game Boy Link' entries to show up, this is a RetroArch limitation, not a core limitation
!!! warning While loading the same game in this mode should work some users reported issues while linking them, you should use single cart mode for that scenario
**Load Content via Subsystem API from CLI**
```
retroarch -L {path to sameboy core} {path to first GameBoy ROM} --subsystem gb_link_2p {path to second GameBoy ROM}
@ -139,11 +149,11 @@ Settings with (Restart) means that core has to be closed for the new setting to
### Regular Options
- **Dual Game Boy Mode (restart)** [sameboy_dual] (**disabled**|enabled)
- **Single cart dual mode (reload)** [sameboy_dual] (**disabled**|enabled)
Emulate two Game Boy games at the same time.
- **Color Correction** [sameboy_color_correction_mode] (**off**|correct curves|emulate hardware|preserve brightness)
- **Color correction** [sameboy_color_correction_mode] (**off**|correct curves|emulate hardware|preserve brightness)
Only for Gameboy Color games.
@ -161,27 +171,27 @@ Settings with (Restart) means that core has to be closed for the new setting to
??? note "Color Correction - preserve brightness"
![](..\image\core\sameboy\color_brightness.png)
- **High Pass Filter** [sameboy_high_pass_filter_mode] (**off**|accurate|remove dc offset)
- **High-pass filter** [sameboy_high_pass_filter_mode] (**off**|accurate|remove dc offset)
Awaiting description.
- **Emulated Model** [sameboy_model] (**Game Boy Color**|Game Boy Advance|Auto|Game Boy)
- **Emulated model** [sameboy_model] (**Game Boy Color**|Game Boy Advance|Auto|Game Boy)
Select what console/model the content is being ran on. May activate special in-game content.
### Dual Mode Options
- **Dual Game Boy Mode (restart)** [sameboy_dual] (**disabled**|enabled)
- **Single cart dual mode (reload)** [sameboy_dual] (**disabled**|enabled)
Emulate two Game Boy games at the same time.
This core option is enabled by default and is hidden from view when the 2 Player Game Boy Link Subsystem API is used.
- **Link Cable Emulation** [sameboy_link] (**enabled**|disabled)
- **Link cable emulation** [sameboy_link] (**enabled**|disabled)
Enable in-game Game Boy link cable functions.
- **Screen Layout** [sameboy_screen_layout] (**top-down**|left-right)
- **Screen layout** [sameboy_screen_layout] (**top-down**|left-right)
Configure the layout of the two emulated Game Boys.
@ -189,35 +199,35 @@ Settings with (Restart) means that core has to be closed for the new setting to
Select which Game Boy will output audio.
- **Emulated Model for Game Boy #1** [sameboy_model_1] (**Game Boy Color**|Game Boy Advance|Auto|Game Boy)
- **Emulated model for Game Boy #1** [sameboy_model_1] (**Game Boy Color**|Game Boy Advance|Auto|Game Boy)
Select what console/model the content is being ran on for Game Boy #1.
May activate special in-game content.
- **Emulated Model for Game Boy #2** [sameboy_model_2] (**Game Boy Color**|Game Boy Advance|Auto|Game Boy)
- **Emulated model for Game Boy #2** [sameboy_model_2] (**Game Boy Color**|Game Boy Advance|Auto|Game Boy)
Select what console/model the content is being ran on for Game Boy #2.
May activate special in-game content.
- **Color Correction for Game Boy #1** [sameboy_color_correction_mode_1] (**off**|correct curves|emulate hardware|preserve brightness)
- **Color correction for Game Boy #1** [sameboy_color_correction_mode_1] (**off**|correct curves|emulate hardware|preserve brightness)
Only for Gameboy Color games.
Select color correction for Game Boy #1.
- **Color Correction for Game Boy #2** [sameboy_color_correction_mode_2] (**off**|correct curves|emulate hardware|preserve brightness)
- **Color correction for Game Boy #2** [sameboy_color_correction_mode_2] (**off**|correct curves|emulate hardware|preserve brightness)
Only for Gameboy Color games.
Select color correction for Game Boy #2.
- **High Pass Filter for Game Boy #1** [sameboy_high_pass_filter_mode_1] (**off**|accurate|remove dc offset)
- **High-pass filter for Game Boy #1** [sameboy_high_pass_filter_mode_1] (**off**|accurate|remove dc offset)
Awaiting description.
- **High Pass Filter for Game Boy #2** [sameboy_high_pass_filter_mode_2] (**off**|accurate|remove dc offset)
- **High-pass filter for Game Boy #2** [sameboy_high_pass_filter_mode_2] (**off**|accurate|remove dc offset)
Awaiting description.
@ -278,4 +288,4 @@ Rumble only works in the SameBoy core when
- [Nintendo - Game Boy / Color (TGB Dual)](https://docs.libretro.com/library/tgb_dual/)
- [Nintendo - Game Boy Advance (mGBA)](https://docs.libretro.com/library/mgba/)
- [Nintendo - SNES / Famicom (higan Accuracy)](https://docs.libretro.com/library/higan_accuracy/)
- [Nintendo - SNES / Famicom (nSide Balanced)](https://docs.libretro.com/library/nside_balanced/)
- [Nintendo - SNES / Famicom (nSide Balanced)](https://docs.libretro.com/library/nside_balanced/)

1
mkdocs.yml
View File

@ -106,6 +106,7 @@ pages:
- 'PocketCDG': 'library/pocketcdg.md'
- Multi System Cores:
- 'Arcade (MAME 2003)': 'library/mame_2003.md'
- 'Arcade (MAME 2010)': 'library/mame_2010.md'
- Misc Cores:
- '3D Engine': 'library/3d_engine.md'
- 'The 3DO Company - 3DO (4DO)': 'library/4do.md'