(Title)Link

// Copy the display name entry from the core info file and paste it here for the title. // https://github.com/libretro/libretro-super/tree/master/dist/info

Contribute to this documentationLink

DOCUMENTATION IS A WORK IN PROGRESS

In order to propose improvements to this document, visit its corresponding source page on github. Changes are proposed using "Pull Requests."

// Add (core-doc-filename).md to the end of the URL.

There is a To-Do list for libretro/docs here

You can submit suggestions or issues regarding documentation at the libretro/docs issue tracker or in our forum thread.

BackgroundLink

Awaiting description.

// Put background information for the core here.

RequirementsLink

// Optional section.

Awaiting description.

// Fill in hardware or software requirements for the core here.

How to install the (Core name) core:Link

// Fill in the (Core name).

  • Start up RetroArch. Inside the main menu, go to 'Online Updater'.

  • Just to make sure we have the latest info files, select 'Update Core Info FIles'. Wait until this is done. Then, select 'Core Updater'.

  • Browse through the list and select '(Title)'.

// Fill in the (Title). // Fill in the title screenshot

After this has finished downloading, the core should now be ready for use!

How to start the (Core name) core:Link

// Optional section. // This section is for cores that are predominantly ran by loading content.

  • Go back to RetroArch's main menu screen. Select 'Load Content'.

  • Browse to the folder that contains the content you want to run.

  • Select the content that you want to run.

  • If you are asked which core to select, choose '(Title)'.

// Fill in the (Title).

The content should now start running!

How to start the (Core name) core:Link

// Optional section. // This section is for cores that need files from RetroArch's content downloader.

  • You now need to obtain (Core name)'s data files. You can do this by going back to the previous menu screen. From there, select 'Content Downloader'.

// Fill in the (Core name).

  • Select '(Content directory name)', then select '(Game filename)'. This should download and extract this file to RetroArch's Downloads directory.

// Fill in the (Content directory name) and the (Game filename).

  • Go back to RetroArch's main menu screen. Select 'Load Content', then 'Downloads'.

  • Select the '(Content directory name)' directory, then select '(Game filename)'.

// Fill in the (Content directory name) and the (Game filename).

  • If you are asked which core to select, choose '(Title)'.

// Fill in the title.

The content should now start running!

How to start the (Core name) core:Link

// Optional section. // This section is for cores that don't need any content to be started.

  • Go back to RetroArch's main menu screen. Select 'Load Core', then '(Core name)'.

// Fill in the (Core name).

  • Now, select 'Start Core'.

The content should now start running!

AuthorsLink

// Copy the author entry from the core info file and paste it here. Link is optional. // https://github.com/libretro/libretro-super/tree/master/dist/info

See alsoLink

// Optional section.

// Add links to related core docs here. // https://docs.libretro.com/meta/see_also/

LicenseLink

A summary of the licenses behind RetroArch and its cores have found here.

The (Core name) core is licensed under

// Fill in the (Core name) // Copy the license entry from the core info file and a url to license information and paste it here. //(https://github.com/libretro/libretro-super/tree/master/dist/info)

ExtensionsLink

// Optional section.

Content that can be loaded by the (Core name) core have the following file extensions:

// Fill in the (Core name).

  • .(extension)

// Copy the exntension entry from the core info file and paste it here. // https://github.com/libretro/libretro-super/tree/master/dist/info)

DatabasesLink

// Optional section.

RetroArch database(s) that are associated with the (Core name) core:

// Fill in the (Core name).

// Copy the database entry from the core info file and paste it here. Also, paste in the link for the database. // https://github.com/libretro/libretro-super/tree/master/dist/info // https://github.com/libretro/libretro-database/tree/master/rdb

BIOSLink

// Optional section.

Required or optional firmware files go in RetroArch's system directory.

Filename Description md5sum
optional.bin Description - Optional
required.bin Description - Required

// Copy the firmware information from the core info file and paste it here ( // https://github.com/libretro/libretro-super/tree/master/dist/info)--

FeaturesLink

RetroArch-level settings or features that the (Core name) core respects.

// Fill in the (Core name).

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 -
Disk Control -
Username -
Language -
Crop Overscan -
LEDs -

// Use ✔ or ✕ // Leave it as - if unsure.

DirectoriesLink

The (Core name) core's directory name is '(Directory name)'

// Fill in the (Core name) and the (Directory name). // The (Directory name) is the name of the directory the core creates in RetroArch's save and state directories.

The (Core name) core saves/loads to/from these directories.

// Fill in the (Core name).

RetroArch's Home directory

  • retroarch-core-options.cfg (Core-options)

RetroArch's Config directory

  • (Core name).cfg (Core Overrides)
  • 'content-name'.cfg (Game Overrides)
  • 'content-name'.opt (Game-options)

RetroArch's Input Remapping directory

  • (Core name).rmp (Core Remap)
  • 'content-name'.rmp (Game Remap)

RetroArch's Video Shader directory

  • (Core name).'shader-preset-extension' (Core Shader Preset)
  • 'content-name'.'shader-preset-extension' (Game Shader Preset)

RetroArch's Save directory

  • . ()

RetroArch's State directory

  • . ()

RetroArch's System directory

  • . ()

Loaded content's directory

  • . ()

Appdata directory

  • . ()

Documents directory

  • . ()

// Add a list of directories/files the core uses.

Geometry and timingLink

// Optional section.

  • The (Core name) core's core provided FPS is (FPS)
  • The (Core name) core's core provided sample rate is (Rate)
  • The (Core name) core's core provided aspect ratio is (Ratio)

// Fill in the (Core name) and the FPS, sample rate, aspect ratio info.

UsageLink

// Optional section. // Explain how to use the core if further explaination is needed.

Core optionsLink

// Optional section.

The (Core name) core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded.

// Fill in the (Core name).

Settings with (Restart) means that core has to be closed for the new setting to be applied on next launch.

  • Core Option [option-string] (Setting1/Setting2)

    Awaiting description.

Core Option - Setting

// Fill in core options. // Add core option screenshots if needed.

ControllersLink

The (Core name) core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):

// Fill in the (Core name).

User # - # device typesLink

  • None - Input disabled.
  • (Device name) - (Device type) - Optional description.

// Fill in (Device name).

// Fill in (Device type) /// Possible device types //// None //// Joypad //// Analog //// Keyboard //// Mouse //// Lightgun //// Pointer

Other controllersLink

// Optional section. // This section is for cores that have controllers that cannot be manually selected through RetroArch's Controls menu.

  • (Device name) - (Device type) - Optional description.

Rumble supportLink

// Optional section. // This section is for cores that have rumble support

Rumble only works in the (Core name) core when

// Fill in the (Core name).

  • The content being ran has rumble support.
  • The joypad input driver being used has rumble support. (e.g. Xinput)
  • The joypad device being used has rumble support.

// Explain how to activate rumble.

Multitap supportLink

// Optional section. // This section for cores that have an opton to activate mutlitap in supported games.

// Explain how to activate multitap.

Controller tablesLink

JoypadLink

User # Remap descriptors RetroPad Inputs (Device name) Inputs
Action 1 -
Action 2 -
Action 3 -
Action 4 -
Action 5 -
Action 6 -
Action 7 -
Action 8 -
Action 9 -
Action 10 -
Action 11 -
Action 12 -
Action 13 -
Action 14 -
Action 15 -
Action 16 -
Action 17 X -
Action 18 Y -
Action 19 X -
Action 20 Y -

KeyboardLink

RetroKeyboard Inputs (Device name) Inputs
Keyboard Backspace -
Keyboard Tab -
Keyboard Clear -
Keyboard Return -
Keyboard Pause -
Keyboard Escape -
Keyboard Space -
Keyboard Exclaim ! -
Keyboard Double Quote " -
Keyboard Hash # -
Keyboard Dollar $ -
Keyboard Ampersand & -
Keyboard Quote ' -
Keyboard Left Parenthesis ( -
Keyboard Right Parenthesis ) -
Keyboard Asterisk * -
Keyboard Plus + -
Keyboard Comma , -
Keyboard Minus - -
Keyboard Period . -
Keyboard Slash / -
Keyboard 0 -
Keyboard 1 -
Keyboard 2 -
Keyboard 3 -
Keyboard 4 -
Keyboard 5 -
Keyboard 6 -
Keyboard 7 -
Keyboard 8 -
Keyboard 9 -
Keyboard Colon : -
Keyboard Semicolon ; -
Keyboard Less than < -
Keyboard Equals = -
Keyboard Greater than > -
Keyboard Question ? -
Keyboard At @ -
Keyboard Left Bracket [ -
Keyboard Backslash \ -
Keyboard Right Bracket ] -
Keyboard Caret ^ -
Keyboard Underscore _ -
Keyboard Backquote ` -
Keyboard a -
Keyboard b -
Keyboard c -
Keyboard d -
Keyboard e -
Keyboard f -
Keyboard g -
Keyboard h -
Keyboard i -
Keyboard j -
Keyboard k -
Keyboard l -
Keyboard m -
Keyboard n -
Keyboard o -
Keyboard p -
Keyboard q -
Keyboard r -
Keyboard s -
Keyboard t -
Keyboard u -
Keyboard v -
Keyboard w -
Keyboard x -
Keyboard y -
Keyboard z -
Keyboard Delete -
Keyboard Keypad 0 -
Keyboard Keypad 1 -
Keyboard Keypad 2 -
Keyboard Keypad 3 -
Keyboard Keypad 4 -
Keyboard Keypad 5 -
Keyboard Keypad 6 -
Keyboard Keypad 7 -
Keyboard Keypad 8 -
Keyboard Keypad 9 -
Keyboard Keypad Period . -
Keyboard Keypad Divide / -
Keyboard Keypad Multiply * -
Keyboard Keypad Minus - -
Keyboard Keypad Plus + -
Keyboard Keypad Enter -
Keyboard Keypad Equals = -
Keyboard Up -
Keyboard Down -
Keyboard Right -
Keyboard Left -
Keyboard Insert -
Keyboard Home -
Keyboard End -
Keyboard Page Up -
Keyboard Page Down -
Keyboard F1 -
Keyboard F2 -
Keyboard F3 -
Keyboard F4 -
Keyboard F5 -
Keyboard F6 -
Keyboard F7 -
Keyboard F8 -
Keyboard F9 -
Keyboard F10 -
Keyboard F11 -
Keyboard F12 -
Keyboard F13 -
Keyboard F14 -
Keyboard F15 -
Keyboard Num Lock -
Keyboard Caps Lock -
Keyboard Scroll Lock -
Keyboard Right Shift -
Keyboard Left Shift -
Keyboard Right Control -
Keyboard Left Control -
Keyboard Right Alt -
Keyboard Left Alt -
Keyboard Right Meta -
Keyboard Left Meta -
Keyboard Right Super -
Keyboard Left Super -
Keyboard Mode -
Keyboard Compose -
Keyboard Help -
Keyboard Print -
Keyboard Sys Req -
Keyboard Break -
Keyboard Menu -
Keyboard Power -
Keyboard € -
Keyboard Undo -
Keyboard Unmapped -
Keyboard Unknown -

MouseLink

RetroMouse Inputs (Device name) Inputs
Mouse Cursor -
Mouse 1 -
Mouse 2 -
Mouse 3 -
Mouse 4 -
Mouse 5 -
Wheel Up -
Wheel Down -
Wheel Left -
Wheel Right -

PointerLink

RetroPointer Inputs (Device name) Inputs
or Pointer Position -
or Pointer Pressed -

LightgunLink

RetroLightgun Inputs (Device name) Inputs
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 -
RetroLightgun Inputs (Device name) Inputs
Gun Crosshair -
Gun Trigger -
Gun Cursor -
Gun Turbo -
+ Gun Start -
+ Gun Pause -

// DEPRECATED LIGHTGUN TABLE

// Fill out the device type tables that will be used.

CompatibilityLink

// Optional section.

// Paste in a link to a compatibility list. - (Core name) Compatibility List

// Or write up a compatibility description. Awaiting description.

// Or make a compatibility table. | Game | Issue | |------|-------| | | |

// Put relevant links here.