|
| 1 | +# :material-layers-plus: Adding Games to KNULLI |
| 2 | + |
| 3 | +KNULLI has a few options for adding games and the option you choose will depend on the device you have and its available functionality *(For example, some devices do not have networking capabilites so those devices will not be able to use the network transfer option)*. To create the default set of game directories on your device, choose the 'CREATE GAME DIRECTORIES' option in the System Settings menu. |
| 4 | + |
| 5 | +This page will aim to document all possible options and indicate when you might use a given one over another. |
| 6 | + |
| 7 | +!!! note "For details on which specific files each system requires please see the corresponding pages in the systems section of this wiki." |
| 8 | + |
| 9 | +## Storage Modes |
| 10 | + |
| 11 | +KNULLI has support for using internal and external storage (microsd) for games. To make games available in the OS we provide different features based on the capability of the filesystem that you are using. To support our storage modes KNULLI nests games into a directory on your games card called "roms". All games found in this path will be available in the OS. |
| 12 | + |
| 13 | +### Merged Storage |
| 14 | + |
| 15 | +When using a microsd that is formatted as Ext4 (Linux), KNULLI will present users with the ability to merge both the internal and external storage together allowing users to use both devices to store games. This mode has two preferences, external (default), and internal. |
| 16 | + |
| 17 | +* Preference External |
| 18 | + * This mode will save anything written to `/userdata/roms` to your external microsd (`/userdata/games-external/roms`). |
| 19 | +* Preference Internal |
| 20 | + * This mode will save anything written to `/userdata/roms` to your internal storage (`/userdata/games-internal/roms`). |
| 21 | + |
| 22 | +> Note: *Merged Storage is disabled by default.* |
| 23 | +
|
| 24 | +### Simple Storage |
| 25 | + |
| 26 | +When Merged Storage is disabled, or when you are using ExFAT or FAT32, KNULLI will mount your external card to `/userdata/games-external` and make the content of `/userdata/games-external/roms` available at /userdata/roms. |
| 27 | + |
| 28 | +### Troubleshooting |
| 29 | + |
| 30 | +* It is possible to create a conflict which will prevent games from being displayed in EmulationStation. This can usually be resolved by executing `/usr/bin/cleanup_overlay`. Note: This will reboot your device. |
| 31 | +* If no game folders appear in /userdata/roms after running `CREATE GAME DIRECTORIES`, make sure you have a `roms` directory on your microsd. |
| 32 | + |
| 33 | +## Option 1: Network Transfer |
| 34 | + |
| 35 | +Network transfer can be used on any device that can connect to the internet (this includes devices with native networking capabilites and ones where networking can be added through an external dongle). |
| 36 | + |
| 37 | +This option first requires you to set up networking on your device. Please see [Networking](../../configure/networking) for details. Once you have completed those steps make note of your IP Address in the Network Settings menu. |
| 38 | + |
| 39 | +In addition to your IP you will also need your root password. This can be found in the Main Menu by pressing ++"START"++ in EmulationStation and navigating to `System Settings`. You will see your root password under the `Authentication` header. |
| 40 | + |
| 41 | +!!! note "By default the root password is set up to rotate to a unique string of characters after every reboot. You can leave it like this and make note of the current password, or you can turn it off and set it to something that will persist." |
| 42 | + |
| 43 | +### HTTP |
| 44 | + |
| 45 | +Enabling Simple HTTP Server in Network settings lets you upload and download files by entering your device's IP address in any browser on the local network (or on VPN IP, see VPN section for details). The username is `root` and the password can be found in `Root Password` in the main menu. |
| 46 | + |
| 47 | +### SMB |
| 48 | + |
| 49 | +- Windows: |
| 50 | + - open a Windows Explorer window, and type in `\\[YOUR IP ADDRESS]`; replace `[YOUR IP ADDRESS]` with the IP Address seen in the Network Settings menu. |
| 51 | + - You will be prompted for a username and password. |
| 52 | + - The username is `root` and your password will be the value from `Root Password` in the System Settings menu. |
| 53 | +- MacOS: |
| 54 | + - open Finder and select `Go > Connect to Server` from the top menu. |
| 55 | + - In the address bar that appears, type `smb://[YOUR IP ADDRESS]`; replace `[YOUR IP ADDRESS]` with the IP Address seen in the Network Settings menu. |
| 56 | + - You will be prompted for a username and password. |
| 57 | + - For name enter `root` and your password will be the value from `Root Password` in the System Settings menu. |
| 58 | + |
| 59 | +### FTP |
| 60 | + |
| 61 | +Using your FTP program of choice; set up an SFTP connection to the IP Address seen in the Network Settings menu. Make sure the Port is set to `22`. The username is `root` and your password will be the value from `Root Password` in the System Settings menu. |
| 62 | + |
| 63 | +### After connecting |
| 64 | + |
| 65 | +- You will see a list of folders after you have connected via network. |
| 66 | +- Open the `roms` folder and you will see a list of folders where games and bios files can be placed. *(Please see the systems section of the wiki for details on where each system's files should be placed)* |
| 67 | +- After you have added your games you can get them to display in EmulationStation by pressing ++"START"++ to open the Main Menu, then open `Game Settings` then select `Update Gamelists` under the Tools header. |
| 68 | + |
| 69 | +## Option 2: SD Card |
| 70 | + |
| 71 | +Games can also be added via an SD card. There are 2 primary methods for this depending on your device. |
| 72 | + |
| 73 | +### If your device has 2 SD card slots |
| 74 | + |
| 75 | +- With your device turned off; insert a FAT32/ExFAT/ext4 formated SD card into slot 2 of your device. |
| 76 | +- Turn your device on. |
| 77 | +- When KNULLI completes its boot process, create your game directories by selecting the `Create Game Directories` option in `System Settings`. |
| 78 | +- Now you can turn off your device, remove your SD card from slot 2 and open it on your PC. |
| 79 | +- You PC will display a list of folders, open the `roms` directory and you will see a list of folders for each system where you can place your games and bios files. |
| 80 | +- Add your games and place your SD card back into slot 2 and boot up KNULLI. |
| 81 | + |
| 82 | +If your device does not see your SD card (or write the needed folders to it) please open `System Settings` and make sure `Autodetect Games Card` is turned on (located under the Hardware/Storage header) then reboot your device. |
| 83 | + |
| 84 | +### If your device has 1 SD card slot |
| 85 | + |
| 86 | +!!! warning "This option is only for devices where you have installed KNULLI to the internal drive of the device. In this scenario an SD card can be used directly for storage" |
| 87 | + |
| 88 | +- With KNULLI installed to your internal drive press ++"START"++ to open the Main Menu, then open `System Settings` and turn on `Autodetect Games Card` under the Hardware/Storage header. |
| 89 | +- Turn your device off |
| 90 | +- Insert a FAT32/ExFAT/ext4 formated SD card into your device. |
| 91 | +- Turn your device on |
| 92 | +- When KNULLI completes its boot process, create your game directories by selecting the `Create Game Directories` option in `System Settings`. |
| 93 | +- Now you can turn off your device, remove your SD card and open it on your PC. |
| 94 | +- You PC will display a list of folders, open the `roms` directory and you will see a list of folders for each system where you can place your games and bios files. |
| 95 | +- Add your games and place your SD card back into your device and boot up KNULLI. |
| 96 | + |
| 97 | +## Option 3: External USB Drive |
| 98 | + |
| 99 | +KNULLI has a built in File Manager and you can use it to access connected USB drives and transfer files. |
| 100 | + |
| 101 | +1. Connect your USB Drive to your device |
| 102 | +2. Open the Tools system and select File Manager |
| 103 | +3. Navigate up to `/` and then select `media` - you should see your drive listed after opening media |
| 104 | +4. Open your drive and you should see its contents |
| 105 | +5. From here you can navigate to the file(s) you would like to copy and then navigate back to the `userdata/roms` directory and paste your copied files in the approrpiate folder. |
| 106 | + |
| 107 | +## Option 4: Linux OS |
| 108 | + |
| 109 | +KNULLI' storage drive is formated as ext4 which can be read natively by linux operating systems. Plugging in your SD card into an linux OS will enable you to browse the directories and add files directly. |
0 commit comments