Skip to content
Christian Jungerius edited this page Nov 8, 2022 · 7 revisions

ROM Collections is as the name already implies a collection of ROMs or games within AKL. You can compose the collection by using one or multiple scanners or you can import or reference existing ROMs/games from other collections. The ability to associate multiple scanners to your collection makes it possible to have diverse collections. You can associate different sources or file directories with your collections, but treat the contents as one set. Just like the category the collection also has a range of metadata and assets to give the collection more detail. Associate one or multiple launchers to your collection to make the ROMs or games in the collection executable with those launchers.
You can create ROM collections based on a certain console or you might want collections based on a popular franchise. The choice is yours.

- ROOT
    |   
    | - Franchises  
    |      |  - Sonic   
    |      |  - Mario   
    |  
    | - Nintendo
    |      |  - NES
    |      |  - SNES

Create new ROM Collection

Open AKL and navigate to the location where you like to add the new ROM Collection.

  1. Open up the context menu and choose "Add new ROM collection".
  2. Choose either to create the collection at the location you are at or under the library item you are currently on.
  3. Choose the platform of the collection.
  4. Enter the name of the collection.
  5. Select assets/artwork directory. (This is the location on your storage where all the images or assets for this collection are saved).
  6. AKL will process your input and render the new views. Once completed it will update your screen and you can find your newly create collection.

Edit ROM Collection

Each of the entities or library items in AKL has certain metadata and assets associated. These can be changed after creation the give all the needed details about each entity. Depending on the kodi skin it will be displayed in a certain way on your screen. In the case of ROM collections you can also apply launchers and scanners to further complete your collection.
Go to the collection and open up the context menu to be able to change all the details.

Edit metadata

You can change metadata details like the name, year and genre for each collection. Follow these steps.

  1. Go to the collection you like to edit and open up the context menu.
  2. Choose "Edit ROM collection".
  3. Choose "Edit Metadata ...".
  4. Choose which metadata to edit.

Import/Save NFO file

You can import a NFO file that contains all the needed metadata for this entity.

Edit assets

You can change the assets of the collection, like the icon, banner and the fanart. Depending on the support by the skin, you can view all of these assets when you select or hover on this particular collection. Follow these steps to change the assets.

  1. Go to the collection you like to edit and open up the context menu.
  2. Choose "Edit ROM collection".
  3. Choose "Edit Assets/Artwork ...".
  4. Choose which asset to edit.

After selecting the asset to edit you will have similar steps as already described under Selecting an asset under Category -> Edit Assets.

More options

Choose default Asset/Artwork

This option gives you to opportunity to switch asset types with eachother when being rendered for the view. In the case a skin only supports showing the Icon asset of the library item, but you want to show the clearlogo asset instead, then you can use this option to link the original clearlogo asset to the icon asset. AKL will swap the actual value or path when rendering the view.

ROM Collection status

This shows and changes the status flag for this particular collection. When the view is rendered all library items will have a finished/unfinished status flag which points to this particular value. Depending on skin support you can filter on them or it will show a particular image on top of the icons indicating the status.

Export ROM collection XML configuration

This will export the collection details to a XML file. You can use that for backing up or copying configurations between different Kodi instances.

Delete ROM collection

Deletes this particular ROM collection. Will not delete any of scanned files/ROMS.

Add new Launcher

With this menu option you can associate a new launcher with this collection. The launcher is the actual application or script that will be executed once you select a ROM in this collection. For more details read the paragraph about Launching further below.

Clone this wiki locally