-
Notifications
You must be signed in to change notification settings - Fork 51
2. Addon Settings
Zach Morris edited this page Jan 4, 2025
·
7 revisions
The following sections describe what each setting in IAGL does.
If your looking for the quickest way to setup the addon, see here
| Setting | Help | Additional Notes |
|---|---|---|
| Play History | Define how many games to save in last played history | |
| If game already exists locally | Define the action to take if a game file is found to exist locally | Defaults to not re-download and use locally available files if present. |
| Download folder size limit | Define the size of the download / cache size. The folder is purged when the size limit is reached. |
Defaults to no cache (only keep the files required to run the current game) |
| Setting | Help | Additional Notes |
|---|---|---|
| Front page display | Define the start page for IAGL | Defaults to a page allowing you to choose where to go |
| Favorites display | Define the start page for IAGL Favorites | Defaults to a page allowing you to choose where to go |
| Games are presented as | Kodi provides several skin options for Movies, TV Shows, and Games. See wiki for more info | IAGL will set the meda type for games as set. This provides certain skin view types depending on the Kodi skin you’re using. This defaults to “TV Shows” so that additional skin views are available |
| Use clean game title | Remove tags from a game title for display. Ex: Mario (USA) becomes Mario | This option will strip the extra information contained in parenthesis or brackets that is commonly used for game collection titles. Keep in mind that if you enable this option, several games that have the same title may appear on screen. For example: Mario (USA) and Mario (Japan) would both be displayed as Mario. Recommend enabling 1G1R filtering if this option is selected to reduce the appearance of duplicates. |
| Games per page | Define how many games are listed per page | Some game lists have thousands of games within. You can limit the total number of games per page with this option. |
| Always filter list to 1 Game 1 Rom Set | If possible, game lists will be pre-filtered to a 1G1R set | If a game list has multiple versions of each game, it will attempt to filter them to only show One Game. This option is not avialable for every game list. In the event the game list doesn’t support 1G1R it will default to show all games https://www.romcenter.com/wiki/doku.php?id=1g1r |
| Append game list name to search and random results | When enabled, the name of the game list will be appended to search results | When generating a search result across multiple game lists, this option is helpful to identify the source |
| Append game list name when browsing by playlist | When enabled, the name of the game list will be appended to the game name in the playlist | When generating a random result across multiple game lists, this option is helpful to identify the source |
| Unhide game lists | When selected, previously hidden game lists can be unhidden | If you have hidden game lists in the past, select this action to unhide them if necessary |
| Setting | Help | Additional Notes |
|---|---|---|
| Kodi thumbnail art equates to | Select the game artwork to be displayed as the thumbnail art | Kodi thumbnail can be either a game ‘Title Screen’ or ‘Gameplay Screenshot’ |
| Kodi landscape art equates to | Select the game artwork to be displayed as the landscape art | Kodi landscape art can be either a game ‘Title Screen’ or ‘Gameplay Screenshot’ |
| Setting | Help | Additional Notes |
|---|---|---|
| Game list clearlogo equates to | Select the artwork displayed for the game list clearlogo | Kodi game list logos can be the platforms logo, an image of the console, or an image of the controller |
| Game list fanart equates to | Select the artwork displayed for the game list fanart | Kodi fanart can be either a colage of games from that list, or a wallpaper/fanart |
| Setting | Help | Additional Notes |
|---|---|---|
| Operating System | Select your operating system | Select the OS that your computer is running and/or the flavor of Retroarch installed. For *elec/debian/pi select Linux |
| Retroarch App Location | Select the path to the retroarch executable | Browse to the Retroarch application that will be used for external launching |
| Retroarch CFG Location | Select the path to the retroarch config file | Point to the Retroarch configuration file that retroarch is using. This can be found in Retroarch in the Main Menu>Configuration File. IAGL will query this file for additional information |
| Manually set Retroarch directories | IAGL will by default detect directories from RA config, you can manually override this function | In the event that permissions restrict pointing to the configuration file, you can manually override the settings IAGL would automatically query. |
| Retroarch Core Directory | IAGL will by default detect directories from RA config, you can manually override this function | If override is selected, point to the directory Retroarch stores emulator cores |
| Retroach Info Directory | IAGL will by default detect directories from RA config, you can manually override this function | If override is selected, point to the directory Retroarch stores info files |
| Retroarch CFG Location as string | Alternatively enter the path to the retroarch.cfg file exactly as it appears in Retroarch | For android systems, permissions within the OS restrict the ability to browse and point to the retroarch configuration file. The path to the file is still needed for external launch commands. Manually type the path into this field if necessary. |
| Retroarch Cores directory as string | Alternatively enter the path to the Cores directory exactly as it appears in Retroarch directory configuration | For android systems, permissions within the OS restrict the ability to browse and point to the retroarch core directory. The path to the core directory is still needed for external launch commands. Manually type the path into this field if necessary. |
| Setting | Help | Additional Notes |
|---|---|---|
| If no user Launch Command is present | Select what Kodi will do when no launch command (retroplayer addon or external emulator) is set | By default, IAGL will attempt to launch a game with a default core if the user has not setup an option. You can change this behavior with this setting – either prompt the user for setup, or stop |
| Game launcher selection method | Select what Kodi will do when selecting a game launcher (Windows, Linux and OSX only) | By default, IAGL will guide the user through selecting an emulator and options for external launching. If you want to hard set the options and remove the guided method, you can set a method here. |
| Suspend Kodi IO on launch | Suspend Kodi Input and Audio when using External Launcher | By default, Kodi will suspend IO (audio output and controller input) when externally launching. Some systems still register input if Kodi is in the background and this prevents that from occuring. You can turn this off if needed (not recommended) |
| Stop media on launch | Stop Kodi media playing before External Launch | By default, Kodi will stop any audio or video from playing if a game is externally launched. You can turn this option off if needed. |
| Use StartAndroidActivity | Leave as default if unsure | By default, Kodi will use StartAndroidActivity builtin activity launcher for Android systems. It is not recommended you change this. |
| Waiting for return | Kodi is busy / waiting for return to Kodi after External Launch | By default, Kodi will show a busy dialog and wait for the external process to exit after a game has been externally launched. |
| Append linux app to start launch command | systemd-run/flatpak is used for specific linux/elec systems. Only enable if your system requires it. | For certain linux/elec operating systems, retroarch is launched using a helper program such as flatpack or systemd-run. When this option is enabled, IAGL will append the helper program the start of the launch command. |
| Setting | Help | Additional Notes |
|---|---|---|
| Dolphin | Select the path to the Dolphin application (optional) | Additional emulators available for setup beyond Retroach. Point to the application with this option. Only available for non-Android systems (Android additional emulators are pre-included in the IAGL database) |
| MAME | Select the path to the MAME application (optional) | Additional emulators available for setup beyond Retroach. Point to the application with this option. Only available for non-Android systems (Android additional emulators are pre-included in the IAGL database) |
| Project 64 | Select the path to the Project 64 application (optional) | Additional emulators available for setup beyond Retroach. Point to the application with this option. Only available for non-Android systems (Android additional emulators are pre-included in the IAGL database) |
| ePSXe | Select the path to the ePSXe application (optional) | Additional emulators available for setup beyond Retroach. Point to the application with this option. Only available for non-Android systems (Android additional emulators are pre-included in the IAGL database) |
| Demul | Select the path to the Demul application (optional) | Additional emulators available for setup beyond Retroach. Point to the application with this option. Only available for non-Android systems (Android additional emulators are pre-included in the IAGL database) |
| FS-UAE | Select the path to the FS-UAE application (optional) | Additional emulators available for setup beyond Retroach. Point to the application with this option. Only available for non-Android systems (Android additional emulators are pre-included in the IAGL database) |
| Setting | Help | Additional Notes |
|---|---|---|
| archive.org Email | Some games require login. Enter your archive.org email address | Enter the email address associated with your archive.org account |
| archive.org Password | Some games require login. Enter your archive.org password | Enter the password for your archive.org account. Note that Kodi stores these passwords in plaintext in the userdata folder! |
| Check login credentials | Test the entered email and password to check your ability to login | Use this function to test your credentials |
| Setting | Help | Additional Notes |
|---|---|---|
| Download Threads | IAGL uses multi-threading to download files from archive.org. More threads does not necessarily mean faster downloads. Do not recommend changing unless you’re an expert. | |
| Use alternate default download folder | Enables use of an alternate downloads folder | By default, IAGL uses an internal Kodi userdata folder to download game files to. This folder is monitored for size and purged if the size is larger than the selected limit (see general settings). If you would like to change the default folder that IAGL uses to download, this will enable that option. Note however, that IAGL does NOT monitor or delete files from this alternate folder for security. You must manually manage this folder. In addition, newer Android operating systems do not allow external emulators to share files from the internal Kodi userdata. For that reason, if you want to use external emulators in Android, you MUST use this option and point to a shared data directory that both Kodi and Retroarch/other external emulator have access to (for example /Android/Downloads/) |
| Alternate default download folder | When selected, all downloads will go to an alternate folder. | See above |
| Organize default download folder using system folders | When enabled, IAGL will download game files to a folder corresponding to the originating game list. This is enabled by default. |
| Setting | Help | Additional Notes |
|---|---|---|
| Enable Netplay | Enable retroarch netplay (Windows, Linux, OSX only), use context menu to launch with netplay | For external launching with Retroarch on Linux/Windows/Mac systems, you can also enable the ability to play games via Netplay. Netplay commands are not available on Android systems. |
| Show Netplay Lobby | When enabled, the netplay lobby will be displayed on the IAGL front page | When enabled, the Retroarch Lobby is browseable from the IAGL front page. |
| Netplay launch action | Select the default action when joining a netplay game | By default IAGL will join a netplay session using the information from the Retroarch lobby. In cases where you’re gaming with another computer on your local LAN, you can change this behavior to either auto connect to a local IP or prompt the user |
| Netplay Username Type | Select integration for netplay player name | Select how to enter the username that will be displayed when using Netplay |
| Discord User Account ID | Discord enables automated netplay matches (IAGL: https://discord.gg/DyxADcp) | If selected, IAGL will utilize discord to auto identify a netplay game and announce what games are available to play. Use this action to enter your discord user ID. Discord user ID can be found by selecting the User settings gear, then select the burger menu near your username, and select Copy ID. |
| Current Discord User | If your Discord ID was entered as listed above, your username will be displayed here. | |
| Player Name | Player names will be published in the Retroarch Lobby | If you don’t want to use Discord, you can manually set a username here. Note automatic game matching is not available in this mode. |
| Netplay Port | Define the netplay IP port to connect through (leave blank for default) | If you want to override the port used for netplay, you can enter one here. Leave blank in most use cases. |
| Check frames | Define number of netplay sync frames (leave blank for default) | If you want to override the number of frames used for netplay, you can enter one here. Leave blank in most use cases. |
| Default Localhost IP | Define a default netplay hostname / IP (useful for local network netplay, leave blank for default) | If you want to connect to a user on your local LAN instead of the address presented in the Retroarch Lobby, you can enter the local IP of the host machine here. |
| Setting | Help | Additional Notes |
|---|---|---|
| Only show rooms that can be entered | Filtering options for what is displayed in the Netplay lobby | |
| Only show rooms that are using libretro | Filtering options for what is displayed in the Netplay lobby | |
| Only show rooms that are using IAGL | Filtering options for what is displayed in the Netplay lobby | |
| Show rooms that have a password | Filtering options for what is displayed in the Netplay lobby | |
| Show rooms that have a spectator password | Filtering options for what is displayed in the Netplay lobby | |
| Show rooms using MITM servers | Filtering options for what is displayed in the Netplay lobby | |
| Filter the lobby rooms based on creation time | Filtering options for what is displayed in the Netplay lobby. By default all games are listed, but you can limit this by games started within a certain timeframe if desired. |
| Setting | Help | Additional Notes |
|---|---|---|
| Reset IAGL database to default settings | When selected, the database will be reset to default settings | Advanced option to nuke the database and start fresh |
| Set all game lists to be launched with Kodi | Quickly set all game lists to Kodi retroplayer | Advanced option to quickly set all game lists to be launched with Kodi/Retroplayer |
| Set all game lists to be externally launched | Quickly set all game lists to external launching | Advanced option to quickly set all game lists to be launched externally with Retroarch |
| Backup current database | Backup the current IAGL database and all user settings | Advanced option to backup the current database (and all contained settings/favorites/etc) to a (sqlite) file. |
| Restore database from backup | Restore the current addon database from a backup | Advanced option to restore the addon using a backup created with the option above. |
| View IAGL db stats | Lists current stats for IAGL db | Advanced option to view stats on the current IAGL database. |
| Execute setup wizard | Run the wizard to quickly change settings for your game lists. This can be rerun at any time | Advanced option to re-run the wizard that automatically runs when the addon is first installed. |
| Support | Donate to Archive.org |