To Do

Meta

  • Move on to updating the RetroPie wiki when Libretro documentation is finished. https://github.com/RetroPie/RetroPie-Setup/wiki
  • Move on to updating the Emulation General when Libretro documentation is finished. http://emulation.gametechwiki.com/index.php/Main_Page
  • Setup a way for others to translate Libretro/Docs to other languages.
  • Encourage others to submit documentation to Libretro/Docs.
  • Spread the word about Libretro/Docs; monitor it's acknowledgement on other sites https://www.google.com/search?source=hp&q=libretro+docs
  • Produce and upload official tutorials to the Libretro Youtube channel https://www.youtube.com/user/Libretro/
  • Create a documentation guide for those who are new to the project.
  • Improve libretro/docs readability.

Specifications / Technical

  • Complete RetroPad documentation https://docs.libretro.com/specs/retropad/
  • Complete controller API documentation https://docs.libretro.com/specs/api/#input-device-abstraction
  • Add Subsystem API documentation https://docs.libretro.com/specs/api/

Licenses

  • Add a license file to Neko Project II repository

Guide

  • .cue and .m3u guide
  • RetroArch cheats guide
  • Video and Audio filters guide
  • .chd guide
  • Logging/Debug guide
  • md5 guide
  • crc guide
  • add icon info to playlist guide

Assets needed

  • RetroKeyboard images
  • RetroMouse images
  • RetroLightgun images
  • RetroPointer images (Mouse and Touch)

All cores

  • Fully document every libretro core https://github.com/libretro/libretro-super/tree/master/dist/info
  • Should core docs also document every BIOS variant? End-users may ask which BIOS revision lets them see a specific screen. (something similar to this http://www.smspower.org/Development/BIOSes)
  • All core docs need update-to-date controller diagrams. (like this https://github.com/libretro/docs/blob/master/docs/library/images/Controllers/4do_retropad.png)
  • Update all the core docs whenever the Core Template doc has been updated.

// ✔ = Completed or near completion

// ️〰️ = Unfinished

// ✕ = Not started

// ❗❗❗ = Attention needed

Cores

[〰️] 3D Engine

  • Fill in the core provided aspect ratio.
  • Complete core option descriptions.
  • Improve the background section. I believe the 3D Engine core is two older libretro core combined? (https://github.com/libretro/instancingviewer-libretro-gl) and (https://github.com/libretro/modelviewer-location-libretro)

[✔] 4DO

[✔] 2048

[!!!] Atari800

  • Need help with documentation.

[✔] Beetle bsnes

[✔] Beetle Cygne

[✔] Beetle GBA

[✔] Beetle Handy

[✔] Beetle NeoPop

[✔] Beetle PC-FX

[〰️] Beetle PCE FAST

  • Add BIOS md5s
  • Complete Horizontal Overscan (352 Width Mode Only) core option description.
  • Complete (CD) CDDA Volume % core option description
  • Complete (CD) ADOCM Volume % core option description
  • Complete (CD) PSG Volume % core option descriotion
  • Complete Turbo Delay core option description
  • Complete P1/P2/P3/P4/P5 Turbo I/II core option descriptions.

[✔] Beetle PSX

[✔] Beetle PSX HW

[✔] Beetle Saturn

  • Test RetroArch cheats support.

[✔] Beetle SGX

[〰️] Beetle VB

  • Combine the anagylph and palette core option screenshots into one image.

[〰️] blueMSX

  • Add core base height
  • Add core base width
  • Add core max height
  • Add core max width
  • ADd core provided aspect ratio.
  • Add Sound YM2413 Enable core description.
  • Add RetroPad Keyboard Map inputs

[✔] bnes

[〰️] bsnes-mercury Accuracy

  • Needs Crop overscan core option screenshots

[〰️] bsnes-mercury Balanced

  • Needs Crop overscan core option screenshots

[〰️] bsnes-mercury Performance

  • Needs Crop overscan core option screenshots

[✔] bsnes Accuracy

[✔] bsnes Balanced

[〰️] bsnes C++98 (v085)

  • Add core provided aspect ratio.

[✔] bsnes Peformance

[〰️] Caprice32

  • Add core provided fps.
  • Add core provided sample rate.
  • Add core provided aspect ratio.
  • Complete Status Bar core option description.
  • Complete Drive core option description.
  • Complete Retro joy0 core option description.

[〰️] ChaiLove

  • Add core provided aspect ratio

[〰️] Citra

[〰️] Citra Canary/Experimental

[〰️] Craft

[〰️] CrocoDS

  • Complete Speed hack core option description.

[〰️] DeSmuME 2015

  • Complete pointer mode l-analog core option description.
  • Complete pointer mode r-analog core option description.
  • Complete Emulated pointer deadzone percent core option description.
  • Complete Emulated pointer acceleration modifier percent core option description.
  • Complete Enable Edgemark core option description.

[〰️] DeSmuME

  • Complete pointer mode l-analog core option description.
  • Complete pointer mode r-analog core option description.
  • Complete Emulated pointer deadzone percent core option description.
  • Complete Emulated pointer acceleration modifier percent core option description.
  • Complete Enable Edgemark core option description.
  • Complete core option descriptions.

[〰️] Dinothawr

  • Add core provided fps.
  • Add core provided sample rate.
  • Add core provided aspect ratio.

[✕] Dolphin

[〰️] DOSBox

  • Add internal sample rate.
  • Improve core otpion descriptions.

[✔] Dummy Core

[✔] Dungeon Crawl Stone Soup

[〰️] EasyRPG

  • Add core provided aspect ratio
  • Add core provided fps

[〰️] EightyOne

  • Add core provided aspect ratio.
  • Add screenshots for the High Resolution core option.

[!!!] Emux CHIP-8

  • Can't complete documentation, core doesn't start.

[〰️] Emux GB

  • Add internal FPS.
  • Add internal sample rate.
  • Add core provided aspect ratio.

[〰️] Emux NES

  • Add core provided FPS.
  • Add core provided sample rate.
  • Add core provided aspect ratio.

[〰️] Emux SMS

  • Add core provided fps.
  • Add core provided sample rate
  • Add provided aspect ratio.

[✕] FB Alpha

[✕] FB Alpha 2012

[✕] FB Alpha 2012 CPS-1

[✕] FB Alpha 2012 CPS-2

[✕] FB Alpha 2012 CPS-3

[✕] FB Alpha 2012 Neo Geo

[〰️] FCEUmm

  • Combine aspect ratio screenshots into one image
  • Combine palette core options screenshots into one image like this
  • Combine Crop Overscan core options screenshots into one image
  • Combine crosshair core option screenshots into one image

[✔] FFmpeg

[〰️] fMSX

  • Add core provided aspect ratio.
  • Complete core option descriptions.

[〰️] FreeIntv

  • First and only standalone libretro emulator core for Mattel Intellivision
  • Uses a unique onscreen keyboard to get around the keypad limitations of the RetroPad abstraction
  • More information https://sourceforge.net/projects/freeintv/ and http://neocomputer.org/projects/freeintv/

[✕] FreeJ2ME

[✕] Frodo

[〰️] Fuse

  • Complete BIOS section
  • Add fps
  • Add base width
  • Add base height
  • Add max width
  • Add max height
  • Add aspect ratio
  • Improve core option descriptions.

[〰️] Gambatte

  • Complete GameBoy Link Mode core option description.
  • Combine palette screenshots into one image.
  • Complete Network core option descriptions.
  • Add core provided FPS
  • Add core provided sample rate
  • Add core provided aspect ratio

[✔] Game Music Emu

[✔] Gearboy

[〰️] Gearsystem

[〰️] Genesis Plus GX

  • Complete BIOS md5
  • Test Multi-Mouse support.
  • Complete Mega Drive / Genesis FM core option description.
  • Complete Audio filter core option description.
  • Complete Low-pass filter % core option description.

[✔] gpSP

[✔] GW

[✔] Handy

[〰️] Hatari

  • Add Keyboard inputs

[〰️] higan Accuracy

  • Add core provided fps
  • Add core provided sample rate
  • Add core provided aspect ratio

[✔] Imageviewer

[〰️] Lutro

  • Add core provided aspect ratio.

[✕] MAME

[✕] MAME 2000

[〰️] MAME 2003

[✕] MAME 2003 Midway

[✕] MAME 2003-Plus

[✕] MAME 2009

[✕] MAME 2010

[✕] MAME 2014

[✕] MAME 2016

[✔] melonDS

[〰️] Mesen

  • Add core provided fps.
  • Add core base width
  • Add core base height
  • Add core max width
  • Add core max height
  • Add HD Pack Before-After screenshots.
  • Add NTSC Filter core option screenshots.
  • Add Palette core option screenshots.
  • Add Vertical Overscan core option screenshots.
  • Add Horizontal Overscan core option screenshots.
  • Add Aspect Ratio core option screenshots.
  • Add Sprite Limit core option screenshots.
  • Add Screen Rotation core option screenshots.

[✕] MESS 2014

[〰️] Meteor

  • Complete compatibility section

[〰️] mGBA

  • Add core provided FPS.
  • Add core provided aspect ratio
  • Complete description for Idle loop removal core option.

[✕] mpv

[〰️] Mr.Boom

  • Complete core option descriptions.
  • Add a 'How to join a game' guide
  • Add a powerup explanation section.
  • Add a endscreen explanation section.

[〰️] Mupen64Plus

  • Add internal sample rate
  • Add core provided aspect ratio.
  • Complete core option descriptions.
  • Complete compatibility section.

[✕] Mupen64Plus GLES3

[〰️] Neko Project II

  • Complete core option descriptions.
  • Document np2.cfg
  • Add a disk switching guide
  • Find out what the .bmp files are.
  • Add license info.
  • Core info file is missing BIOS info.
  • Complete BIOS section.
  • Complete joypad section
  • Complete keyboard section

[〰️] Neko Project II Kai

  • Complete core option descriptions.
  • Document np2.cfg
  • Add a disk switching guide
  • Find out what the .bmp files are.

[〰️] Nestopia UE

  • Complete Game Genie Sound Distortion core option description.
  • Complete RAM Power-on State core option description.
  • Combine palette screenshots into one image.

[〰️] nSide Balanced

  • Add core provided fps
  • Add core provided sample rate
  • Add core provided aspect ratio

[✔] NXEngine

[✔] O2EM

[✔] OpenLara

[!!!] P-UAE

  • Need outside help with the documentation, loading .uae files don't seem to work on Windows x64

[✕] ParaLLEl N64

[✕] PCem

[〰️] PCSX ReARMed

  • Complete core option descriptions.
  • Explain what the default setting for the Pad Type core options does.
  • Add negcon inputs to controllers table

[!!!] PCSX ReARMed [Interpreter]

  • Not making a doc for this, the regular PCSX ReARMed doc is enough.

[✔] PicoDrive

[✔] PocketCDG

[✔] PokeMini

[✔] PPSSPP

[✔] PrBoom

[✔] ProSystem

[〰️] PX68k

  • Add keyboard inputs. https://raw.githubusercontent.com/libretro/px68k-libretro/master/libretro/keyboard.c
  • Complete Use Analog core option description.
  • Complete P1 Joypad Type core option description.
  • Complete P2 Joypad Type core option description.
  • Complete ADPCM Volume core option description.
  • Complete OPM Volume core option description.

[✔] QuickNES

[✔] Redream

[〰️] Reicast

[!!!] RemoteJoy

  • Not documentating. Core doesn't work at all and most likely no one uses it.

[〰️] Remote RetroPad

  • Complete background section.
  • Complete usage section.
  • Complete Port core option description.
  • Complete IP address part 1 core option description.
  • Complete IP address part 2 core option description.
  • Complete IP address part 3 core option description.
  • Complete IP address part 4 core option description.

[〰️] SameBoy

  • Add core provided fps
  • Add core provided aspect ratio
  • Complete core option descriptions.

[〰️] ScummVM

  • Add keyboard table.

[✔] Snes9x

[〰️] Snes9x 2002

  • Complete compatibility section.

[〰️] Snes9x 2005

  • Complete Video Mode core option description.
  • Add core provided aspect ratio FPS.
  • Add core provided sample rate.

[〰️] Snes9x 2005 Plus

  • Complete Video Mode core option description.
  • Add core provided aspect ratio FPS.
  • Add core provided sample rate.

[✔] Snes9x 2010

[〰️] Stella

  • Add core provided FPS

[✕] TempGBA

[〰️] TGB Dual

  • Add core provided aspect ratio.
  • Add netplay usage section.
  • Explain what the Next Audio Mode/Prev Audio Mode inputs do.
  • Complete compatbility section.

[〰️] The Powder Toy

  • Add core base width
  • Add core base height
  • Add core max width
  • 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

[✕] UME 2014

[!!!] Uzem

  • Can't complete documentation, core doesn't start. https://github.com/libretro/libretro-uzem/issues/2

[✔] VBA-M

[✔] VBA Next

[〰️] vecx

[✔] VeMUlator

[✕] VICE C64

[✕] VICE C128

[✕] VICE PLUS4

[✕] VICE VIC20

[!!!] Video Processor

  • Complete documentation when core is fixed.

[✔] Virtual Jaguar

[〰️] XRick

  • Core info file does not have an author entry.

[✔] Yabause