"romjacket is the worst coder on earth"
-Anonymous on 4chan /emugen
SkeletonKey functions both as a ROM launcher and as a backend configuration tool for HTPC frontends.
As a configuration tool, skeletonKey can deploy a ROM-library that meets the expectations of users who desire a means to maintain the integrity of settings and assets indipendently of a frontend or emulator.
Nearly every skeletonKey option has a mouse-over tool-tip . Operational feedback appears in the statusbar at the bottom of the window.
After skeletonKey is installed, a "systems ROOT" is defined and emulators are detected.
Identified systems found in the "systems ROOT" are automatically assigned to detected emulators.
If retroArch is not detected, a quick-setup wizard can automatically install retroArch with several cores.
RetroArch is tightly integrated into skeletonKey with an exhaustive set of options and exclusive features for netplay. By default the most compatible core is selected as the skeletonkey's primary association for most of retroarch's supported systems. The GUI interface for retroArch is dynamic, responding after any changes made during gameplay.
RetroArch's "core_assets_directory" should be assigned to the [Systems ROOT] folder.
content_history_path (history file) should also be shared with skeletonKey.
An emulator-preset can be specified to override any assocation from the command-line.
SkeletonKey accepts the option
-run= followed by the nickname of the emulator preset followed by the path to the rom. Any options specified by the preset are respected.
SkeletonKey launched from the command line without this option functions identically to drag'n drop.
skeletonKey.exe -run=NickName "C:\Library\Console Name\Rom Name\rom file.rom"
**Nicknames must not contain spaces**
-clearrjwill reset the ROM-Jacket system presets and queue
-clearcfgwill reset the per-game settings for all skeletonkey presets (not ROM-Jackets)
-clearsetwill reset the skeletonkey program settings
-clearrawill reset global retroarch settings
-clearexewill reset emulator executable settings
-clearscrapewill delete scraped art and assets
!qto the end of your clear command will override and assume yes on all deletion queries.
-resetcommand to reset the while keeping credentials for github.
-gituser=USERNAMEyour git username (must be the first argument).
-gitpass=PASSWORDyour git password (must be the 2nd argument).
-gittoken=TOKEN-STRINGyour git authentication token (must be the 3rd argument).
Skeletonkey can be run from a thumbdrive or other portable drive. Many users may desire to transfer an existing skeletonKey installation to a portable drive and the portable utility should facilitate the conifiguration migration.
The Portable.bat file should be run from the portable device when first starting skeletonKey from a portable drive on a new computer or if the drive letter of the portable device has changed.
Migration options for the portable utility include localization of items to the drive for playlists and simple search & replace. Retroarch and skeletonKey's other emulators' per-game settings are updated to reflect the new portable skeletonKey location.
If you already have skeletonKey and retroArch intalled, copy the folders to your portable drive and run the Portable.bat in the skeletonKey folder on the portable drive.
A deployment tool is available for users who wish to publish a skeletonKey. SKey-Deploy.exe can be compiled to build, maintain and deploy a skeletonKey source-code versioning project, website and binaries.
The settings tab is for the location for your systems, emulators, playlists and other environment-options.
SkeletonKey will automatically load any per-game settings previously created and create settings for the currently selected title upon launch if none are found.
By default, ROMs are [categorically] stored by system-name in the
..[Systems ROOT]\[SYSTEM NAME] folder.
Repository ROMs will be downloaded to the corresponding system-name which follows the no-intro naming nomenclature.
By default, all emulators will be installed to the Emulator Directory. Upon assigning a directory to the Emulators Directory, skeletonKey will search subdirectories for previously installed known emulators not currently identified or manually assigned.
Options are categorized by type. The Launch tab is responsive and will populate options for the currently selected supported emulator. Any previous settings for the currently selected ROM are loaded.
The Launch menu items persist across emulator settings populated in the Main tab. These items are at the top of the window and are necessary to browse directories, navigate playlists and launch a ROM.
The Global-Launch-Menu includes:
The folder/playlist toggle will toggle this dropdown between playlist files and the current system libraries. System Lists contain any folders found in the Systems ROOT directory, but this can be filtered to display only detected and created systems.
Changing the system will automatically change the emulator/core dropdown to the associated nickname and populate the tab with options for that system's associated emulator.
Right-Click on this dropdown to configure it.
The switches toggle will expose options & arguments fields for emulators. These are pre-packed with many options and arguments, however spaces should be observed when plugging in your own switches.
The ROM currently in ROM-List will be launched by the emulator/core in the EMU-List.
A quick-launch selection set of all assigned presets and known compatible presets will appear in a dropdown menu
This menu can also be accessed via right-clicking on the LAUNCH button.
The editable dropdown menu contains a list of all ROMs in the current system/playlist dropdown menu.
If the auto-load setting is enabled, whenever a new ROM is selected, the configuration files for that ROM will have values populate the tab.
A new configuration will be generated in the ROMs' configuration folder if one is not found.
\...\skeletonkey\cfg\Microsoft - DOS\msds_dosbox\TMNT\dosbox.conf).
The EMU list is a core/emulator dropdown which contains a list of all cores, all nicknames for system-associations, and all emuators.
Changing the core/emulator dropdown will populate the Main tab with options for the emulator/core (if supported) and any load existing settings the title may have.
Right-Clicking on this menu enables assignment and configuration.
Clears all current launch options. Right-click on this to delete ROM settings for the emultor in the EMU List.
These options are dynamically loaded for each emulator. Settings changed by the user at run-time should load and populate the GUI after lauching.
Drag & Drop a ROM into the Main tab and with the Auto-Launch option enabled, skeletonKey will detect the ROM and launch it using the system's associated core/emulator, or bring forth the core/emulator dropdown if undetected or Auto-Launch is disabled.
The "find" button can be found in the lower right hand corner of the tab and will expand the search fields.
skeletonKey can search for ROMs in your "Systems" directories or playlists.
Selecting a title will repopulate the System-List & make it active in the ROM list.
A right-click menu allows for a single ROM to be launched by any installed emulator or it's directory opened by windows explorer. Additionally, multiple files can be selected and added to the current playlist.
SkeletonKey can be used to quickly install emulators, frontends, retroArch and utilities. The Install Tab is also used to associate skeletonKey's systems with emulators and retroArch cores when using skeletonKey as a launcher.
RetroArch and components can be installed separately or as a single package (stable). The "RetroArch" list item includes all components needed by retroArch. The most recent nightly build as well as the stable version are available. A core-upate button will check for cores with updates to upgrade en-masse.
Drag & Drop BIOS files or a BIOS pack (.7z .zip .rar) to automatically install them to their proper places in supported emulators directories.
SkeletonKey can install hundreds of emulators. Supported emulators can be configured indipendently (for per-game settings too!!!) as they are launched by skeletonKey and as emulators assigned to ROM-Jackets.
Selecting "Systems" from the dropdown menu will allow users to define directories containing ROMs for over 100 systems. ROM directories specified outside of the systems directory will be linked (junctioned) into it with the supported system's name.
The Associations section of the Install tab can be used to change the association of a system to a core, an emulator or nickname.
Skeletonkey can detect and assign emulators or a designated retroArch core to a system/s, however it may be desireable to create and configure systems and associations manually. A unique system-identifier or "nickname" can be created to create custom systems and associated emulator-presets.
Associating an emulator to a system creates a unique set of preferences for the emulator and assigns this set a nickname which can also be assigned to other systems. Right clicking on the System List or emu/core dropdowns will bring up menus to quickly configure or associate systems with emulators and cores.
The default association defines how skeletonKey will automatically launch ROMs categorically, however multiple nicknames/emulators can be assigned to a system to populate quick-launch/right-click.
In addition to these assigned emulators, an emulator can be assigned to a recognized extension for each system.
Assigning an extension to an emualator will override the default association for ROMs of the selected system, however emulators assigned to extensions need not populate in the assigned-emulators list.
Systems are defined in part by file-extensions exclusive to the system. (eg: nestopia.exe [and retroarch's nestopia_libretro.dll core] by default are to assigned to the NES) & (eg: ONLY the Nintendo Entertainment System uses the .nes file-extension)
Because an emulator may have multiple system-assocations, a unique "system identifier" nickname can be created to define exclusive paramaters.
Options, arguments, quotes, ROM-paths and the extension can be adjusted to suit an emulator's needs.
Spaces are observed for options, arguments and command-lines.
The charachter must be escaped or it will be converted to a space.
[CUSTMARG] are special tags assigned to MAME and other emulators which allow the passing of overriding options and arguments at runtime via the "switches" checkbox in the Global-Launch-Menu or Repository-Systems-Menu.
!!!!Enabling the "switches" override will deactivate preset options such as auto-system and ROM-type detection!!!!
Many MAME systems and several supported emulators options and arguments are available as presets for custom options & arguments.
SkeletonKey can retain emulator settings for each game (configuration files, save-states, battery-saves/nvram) under supported emulators. Any changes that are made during gameplay will be saved.
SkeletonKey copies and moves these configuration files back and forth between the emulator's folder and the per-game configuration folder before and after the emulator runs.
Configuration files are stored inside a folder of the ROM's name. A folder for each system can be located in the skeletonKey installation folder under the "cfg" directory. EG:
\...\skeletonKey\cfg\System - Name\emulator\ROM Title\config.ini
For retroArch, per-game settings are stored in
retroarch-folder\config\core name\ROM Title.cfg
ROMs dropped to the desktop icon which are not identified as belonging exclusively to a core/emulator will bring up a menu allowing users to quickly select a core/emulaor preset.
Many emulators require these runtimes
This installs the XBox 360 Joystick drivers from Microsoft. These are needed for Windows Vista and 7.
The SCP Wrapper is a driver for bluetooth Sony Dualshock joysticks.
This is the most reliable and easiest way for DS3/4 users to use their joysticks in Windows 7/8x-10.
DS4Windows is a Sony DualShock 4 driver for windows. It is installed however the configuration of this driver is left to the user.
For systems windowsXP->windows 8.x, skeletonKey can automatically install this program through the command-line which will NOT install the included toolbar or any additional software. Windows 10 users who need Daemon Tools should download and install it separately. Consider alternatives.
The Daemon Tools program is needed for the SSF Sega Saturn emulator, the UNZ FM-Towns emulator and may be required for any emulator which cannot directly read cd/dvd image files. Mounting disc images with Daemon Tools is desireable for users who wish to switch disks reliably or have disc-images in formats unreadable by an emulator.
Open the Daemon Tools program.
If you do not have a SCSI drive in the list, add a SCSI drive.
Right click on the new drive icon.
select Device Paramaters
Uncheck Auto insert notification
RoM-Jacket libraries requires a joystick-to-keyboard-remapper for a seamless HTPC gaming frontend.
Xpadder is a very reliable and enhanced keyboard remapper. Presets are ubiquitous and abundant and skeletonKey has hundreds for many emulators ready to go for xinput devices.
Antimicro is opensource and extremely versitile.Antimicro is the preferred keyboard remapper by default.
Up to 16 Joysticks are supported (through multiaps). Each core can also have input_remaps.
Joystick options are dynamic and respond to the currently selected input-remap system.
Skeletonkey can read and utilize retroArch playlist files natively. Drag and Drop ROMs to dynamically add files to playlists. Each playlist is unique to the frontend it is created for however skeletonkey can convert retroArch to/from emulationStation playlists.
Each item added to the playlist contains the name of the ROM, the path of the ROM, the crc hash of the ROM, the core/emulator name, path assignment, & the name of the playlist.
The core/emulator dropdown is assigned to the selected items when they are added to the playlist.
A template config file can be specified for the retroArch's per-game configuration files, otherwise current skeletonKey settings are used.
Right-Clicking in the Playlist-Menu will allow selected items to change the core/emulator assignment for selected items.
The playlist database is a compiled collection of all playlists which allows netplay-matches and searching for ROMs in very large libraries very fast.
SkeletonKey can create and edit gamelist.xml files which can be to used cull ROM directories and display custom playlists. The existing es_systems.cfg will be loaded and inherited systems' directories will become available. Several options exist to populate gamelist.xml files with artwork and ROM metadata.
Like emulationStation's es_systems.cfg, emulationStation gamelists are xml files which contain standard metadata tags. Absolute paths to assets such as images and video files are accepted, however relative paths are also accepted, making the entire frontend portable across platforms (*nix/apple/windows). Assets can be arranged & named uniquely, however skeletonKey propagates assets to an emulationStation deployment which follows a local-layout.
Box-Art files: ~/downloaded_images/[ROM_TITLE]-image.png
Marquee images: ~/downloaded_images/[ROM_TITLE]-marquee.png
Thumbnail images: ~/downloaded_images/[ROM_TITLE]-thumb.png
Marquee images: ~/downloaded_images/[ROM_TITLE]-marquee.png
Video snaps: ~/downloaded_images/[ROM_TITLE]-video.mp4
Options to download into a ROM-Jacket, manual overrides and extraction settings for compressed files
Most options available in the Main tab's Launch-menu are available.
Enabling the "Download Only" option will allow multiple files to be selected and queued.
MAME ROM-sets can also be easily accessed, although these often contain ROMs which are incompatible with other emulators.
The global-prefix can be overridden to an ftp or http host, allowing for dynamic custom repositories. eg:
Files in the skeletonkey\gam folder contain
.gam files which contain the relative path to global-prefix followed by a pipe (
| ) followed by the game-title or name of the ROM. eg:
A full http url path to the ROM file in a
.gam file will override and ignore the global-prefix.
The Frontends tab contains configuration options for many different cabinet and couch-gaming frontends.
Asset-Management is the primary component of skeletonKey. Deploying a frontend means creating a unique data-structure, and because the arrangement and naming of assets and artwork vary from emulator to frontend, skeletonKey opts to prioritize a local-storage system (ROM-Jackets) to enable migration and deployment indipendently of any proprietary layout or scheme needed by a frontend.
SkeletonKey has a repository of photographic icons, full-HD images and large logos for 100 systems and can also "scrape" artwork from a multitude of hosts. Several databases are searched to obtain an array of image-types, video-snaps and metadata for thousands of titles spanning arcade, computer & console-systems.
Selecting "Systems" in the Media interface will enable icons, logos, backdrops, videos and other media to be downloaded for selected systems. Alternatively, sets of these items can be downloaded. Themes for these items can be selected using the "Artwork Theme" dropdown.
Selecting "Jackets" in the Media interface will enable items to be downloaded for the selected ROM-Jackets.
Selecting "ROMs" in the Media interface will enable ROM-paths to be defined for supported systems.
Caveats: Python must be installed and in the $path to download videos from youtube.
XMB is retroArch's premiere GUI with thumnail support.
Using skeletonKey users can easily see which thumnails have been downloaded and copy any image to match the names corresponding to the unmatched ROMs .
EmulationStation is a lightweight frontend that has metadata, boxart and video-snap capabilities.
SkeletonKey can configure emulationStation to use Jackets (batchscript launchers), mirrors (shortcuts), ROM files or any combination of these types of elements. Additionally, skeletonKey can load existing configuration files (es_systems.cfg), gamelist files (gamelist.xml) to add, remove, edit and reorder games and systems.
Mirrored Links are Windows shortcuts.
Leveraging Windows shortcuts allows for easy customization of frontends. As these files can be moved, copied and deleted without affecting launchers or ROM-Jackets, creating custom playlists is as easy as navigating Windows Explorer.
Each Mirrored file can be assigned an icon found
Advanced Emulator Launcher (AEL) & Advanced Launcher (AL)
Configure Cores and create core-configuration overrides.
It is recommended (not required) for retroArch netplay users to create playlists containing all ROMs on their computer that they wish to play online. .
In the Main tab, settings such as delay-frames, port number and file-server port can be adjusted.
In the Archive tab, users can select any ROM from the archive to host.
In the Netplay Tab, refreshing the hosts will populate the lobby with currently hosted ROMs. If the ROM is not located on disk, enabling the "web-lookup" option will select a ROM from the Archve tab and enable connection options.
RoM-Jackets are folders which contain a ROM, any individual settings it may have for emulators, artwork, assets and a launcher to maintain files contained in the jacket indipendently from other titles for any given system or emulator.
Subdirectories for common emulator files such as save-states, battery/memory-saves, screenshots, manuals, and videos are created for each jacket.It is advantageous to create RoM-Jackets for libraries where
Each jacket's batch-script-launcher copies its emulator-configuration files to the emulator directory before launching and any changes made to the emulator during gameplay will back to the jacket after exiting the emulator.
For those interested in developing for the RoM-Jacket spec, a few principles should be observed:
Launchers should be executable natively by the operating system, make no changes to the system environment and any augmenting behavior beyond the emulator should be disabled unless specifically detected
(ie: the launcher should require no user interaction irrespective of any errors the script may encounter).
Titles which contain many files and folders (DOS Titles) should be placed inside a subdirectory of the Jacket.
When a system is loaded into the Jacket tab, the ROMs and Jackets contained within the system's directory will populate and can be filtered into the list on the left side of the tab. Settings in the Jacket tab can be saved for each system. Each system has a default emulator associated with it which will populate with previously slected options or a configuraiton which is designed to be compatible with a very low-spec PC.
Jackets are created for ROMs using the title or file-name of ROMs.
ROM-Jackets are individuated by default, however the abundance of releases a title may have seen throughout the world is multiplied by versions the developer released and again multiplied by ROM-dumps. Subsequently many ROM-collections and system-libraries are simply too large and unwieldy for practical purposes. In the interest of bringing forth functional libraries it may be desireable to consolidate each title without regard for region or version.
This will consolidate ROMs containing the same base-name, grouping each ROMs regional counterparts and multi-disc ROMs together into a single jacket.
The base-name is the ROM's filename without any text in parenthesis or brackets.
eg: region, disk-number, rom-revision, & any other superflous information is pruned to the game title.
Folder: Game Title\
Grouped ROMFILE: Game Title (USA)[version].rom
Gropued ROMFILE: Game Title (JAPAN)[v-2].rom
Grouped ROMFILE: Game Title (Disk B).rom
Grouped ROMFILE: Game Title (1 of 2)].rom
Grouped ROMFILE: Game Title (PAL).rom
Effectively, this will help eliminate the need to scroll through many different versions of games in a library and will help wrangle multi-disc games. This is the preferred method of folder-generation for users wishing to tame their library and generate friendly-names for their frontend. Launchers created for each consolidated jacket will be named with the base-name and the first alphabetical or [!] ROM will be launched by default.
This will simply jacketize each ROM using the name of the file without the extension.
Folder: Game Title (USA)[v-1]\
ROMFILE: Game Title (USA)[v-1].rom
Folder: Game Title (USA)[v-1.01]\
ROMFILE: Game Title (USA)[v-1.01].rom
Folder: Game Title (USA)[v-1.11]\
ROMFILE: Game Title (USA)[v-1.11].rom
Folder: Game Title (EUR)[b]\
ROMFILE: Game Title (EUR)[b].rom
Several sub-directories to house assets are automatically created for each jacket. Custom subdirectories can also be created.
Archives found within a system's directory can be extracted into in a couple of ways:
Before: Each archive is extracted prior to any jacket is created. Extracted files are not jacketized.
After: Each archive is jacketized and then extracted into the jacket.
After archives are extracted they can be stored in skeletonKey's tmp directory, deleted, or kept in the jacket.
The default settings for each emulator are designed for low-powered specification settings, however many consoles offer a variety of settings which you may change when configuring a console individually.
Unless explicitly specified at creation-time, the launcher will launch the first alphabetically named ROM in the Jacket.
Drag'n'drop and the command-line may usually be used to specify and override an alternative.
>C:\Games\console\System - Name\Game\Game(name).bat "Z:\NetworkDrive\Sample\ROM.bin"
Each ROM retains all unique emulator configuration files.
All settings, quick-saves, save-files & snapshots for the emulator are saved in the ROM-directory.
The ROM's configuration for the emulator is copied to the proper location upon execution of the launcher.
It should be noted that skeletonKey's Launcher settings have their own set of per-game settings which operate indipendently from RoM-Jackets (even when using the same ROM file).
Some consoles use the same emulator and these consoles should use either Per-Game or Global settings (not both).
All games using the assigned emulator have configurations and settings governed and maintained by the emulator.
All settings, quick-saves, save-files & snapshots for the emulator are saved in locations set by the emulator in its default state and any changes made to a game's settings in the console's set will be respected by all games using the global option.
Any and all changes made to the emulator's settings will affect all other games.
Any multi-system emulator must be using a global option for all systems.
Applications can be designated to run both before the emulator is launched and after the emulator exits. An option exists to allow the launcher to wait for the command to complete until proceeding, or continue to execute immedietlely after it is launched.
Command line options can be set for any command. Additionally, keywords can be entered which will be parsed by the launcher at runtime. These include:
[ROMPATH]: This will designate the directory path of the ROM.
[ROMF]: This will designate the ROM filename.
[ROM]: This will designate the name of the ROM file without the extention. (useful for MAME)
[EMUL]: This will designate the directory path of the emulator.
[EMUZ]: This will designate the emulator execuatble.
Paradigm: Adding pre/post commands is intuitive, however it is possible to add a command inbetween commands after a set has already been assigned. To do this, select the command which will preceed your new command and then press the add-command button
Each supported system has one or more emulators preconfigured for them. The default emulator will automatically be assigned with compatible settings, however any program can be assigned to any system.
These fields pre-populate with the currently selected emulator's preset commands. These commands are designed to maintain the Jacket's assets and will typically copy files back and forth between the Jacket and the emulator's directory.
Similar to "Pre-Command / Post-Command" these are commands which run before the emulator launches and after the emulator exits, however these commands execute before the "Pre-Commands / Post-Commands" respectively. You may enter any windows batch-script commands in these fields and likewise, keywords will be parsed.
ROM-Jackets can be deployed to suit the needs of a particular system which include requirements such as Disk-Grouping, however standardized naming has generally fit a modality allowing for simple identifiers to disregard and group (regional) and [developer-version] titles so that a library may be navigated using universal conventions.
Many systems and emulators require unique and proprietary directory structures, naming schemes and locations and in such cases junction-linked files are jacketized.
The BSL can override settings defined by ROM-Jacket launchers and provides a convenient way to enable custom tools to accomodate new HTPC frontends. The BSL will execute the ROM-Jacket launcher while assisting the visibility and state of other assets.
Typically, a frontend will assign an emluator to a directory containing a set of ROMs with a list of supported extensions. (eg: nestopia.exe will open all .nes, .zip, and .fds files in the NES folder)
In this case the BSL.exe is used as the "emulator" where ".bat" or ".lnk" is the extension for any ROM-Jacket library.
Xpadder and Antimicro programs are currently supported.
Creating an executable is a feature unique to skeletonKey where ROMs are compiled into a portable executable. The ROM, any additional files specified by the user, an emulator and special configuration files are compiled and saved to the location of your designation.
Creating one requires an emulator executable and at least one ROM file.
Selecting an emulator preset will download the emulator and extract it to the
Add ROMs to your executable by dragging and dropping ROM files to the list on the left. Alternatively, you may use the "Add" button which will allow you to select them via skeletonKey's file-browser. ROM files are copied to the
Enabling the keymapper will download and extract antimicro into the
3 profiles (Player1.amgp, Player2.amgp & Select.amgp) are included in the
Select.amgp is loaded before the emulator to enable ROM selection with the directional pad if more than one ROM is included.
All files found in the
...skeletonKey\executable directory will be included in the executable.
A user-defined extraction-directory option will override the system's temp directory create a desktop shortcut to the executable for the current user. (
%%S specifies that the extraction directory is the location of the exectuable)
Question: I'm having trouble with a feature. Can you Help?
Answer: Create an issue on Github.com and I'll respond.
Question: Does this work in linux?
Answer: Everything seemed to be fine in a WINEbox I tested this in, even netplay. I'm very interested in extending functionality through programmable shell-script launchers, and at some point I may rebase/refactor to allow for unix-paths, but I have no intention of porting skeletonKey to other platforms.
Question: I want to see a feature implemented or do something with skeletonKey it cannot currently do.
Answer: Donate and I WILL feel compelled to realize your needs.