diff --git a/docs/_inc/images/play/add-games/004-smb-map-network-drive.png b/docs/_inc/images/play/add-games/004-smb-map-network-drive.png new file mode 100644 index 00000000..01039b6b Binary files /dev/null and b/docs/_inc/images/play/add-games/004-smb-map-network-drive.png differ diff --git a/docs/_inc/images/play/add-games/005-smb-map-network-drive.png b/docs/_inc/images/play/add-games/005-smb-map-network-drive.png new file mode 100644 index 00000000..2c48d60c Binary files /dev/null and b/docs/_inc/images/play/add-games/005-smb-map-network-drive.png differ diff --git a/docs/_inc/images/play/add-games/006-smb-map-network-drive.png b/docs/_inc/images/play/add-games/006-smb-map-network-drive.png new file mode 100644 index 00000000..e05bbfd2 Binary files /dev/null and b/docs/_inc/images/play/add-games/006-smb-map-network-drive.png differ diff --git a/docs/play/add-games.de.md b/docs/play/add-games.de.md deleted file mode 100644 index 0b0e0815..00000000 --- a/docs/play/add-games.de.md +++ /dev/null @@ -1,153 +0,0 @@ -# :material-layers-plus: Spiele zu KNULLI hinzufügen - -!!! info "Anders als viele andere CFWs formattiert KNULLI die *SHARE*-Partition standardmäßig mit ext4. Das Dateisystem ext4 ist unter Windows nicht lesbar, d.h. du wirst deine Spiele möglicherweise nicht auf die gleiche Weise hinzufügen können, wie du es von anderen CFWs gewohnt bist. Der Grund dafür ist, dass einige Spiele aus der [PortMaster](../../systems/portmaster)-Bibliothek auf das ext4-Dateisystem angewiesen sind, da sie symbolische Links und große Swap-Dateien einsetzen, die von Windows-Dateisystemen nicht unterstützt werden. Es ist möglich, die Partition nach dem ersten Bootvorgang stattdessen [mit exFAT zu formatieren](#die-share-partition-mit-exfat-formatieren). Du solltest dir allerdings darüber im Klaren sein, dass einige PortMaster-Spiele dann nicht mehr funktionieren werden." - -Es gibt verschiedene Möglichkeiten, um Spiele auf dein KNULLI-Gerät zu laden. Welche Möglichkeiten für dich geeignet sind, hängt davon ab, welche Funktionen auf deinem Gerät zur Verfügung stehen. Wenn dein Gerät beispielsweise keine geeignete Hardware hat, um einem Netzwerk beizutreten, kannst du natürlich keine Daten via Netzwerk übertragen. Außerdem spielt es natürlich eine Rolle, welches Gerät dir als Datenquelle zur Verfügung steht. - -## Datenstruktur - -Bevor du anfängst, deine Spiele hinzuzufügen, solltest du dir die Zeit nehmen, um zu verstehen, wie die Datenstruktur von KNULLI funktioniert. Dies ist *besonders wichtig*, wenn du bereits Erfahrungen mit anderen CFWs gesammelt hast und deine Daten migrieren möchtest. - -### Der `/userdata`-Ordner. - -Du kannst KNULLI sowohl mit einer einzelnen SD-Karte als auch mit zwei getrennten SD-Karten verwenden. Intern benutzt KNULLI einen Ordner namens `/userdata`, um alle deine Daten (Spiele, Screenshots, Bezels, Speicherstände, Konfigurationen, Themes etc.) darin abzulegen. Wenn du KNULLI mit einer einzelnen SD-Karte verwendest, wird der `/userdata`-Ordner immer auf die *SHARE*-Partition deiner primären SD-Karte zeigen. Wenn du ein Gerät mit mehr als einem SD-Karten-Slot hast und eine zweite SD-Karte verwenden möchtest, wird `/userdata` **stattdessen** auf die Partition der zweiten SD-Karte zeigen. - -!!! info "Du kannst zwischen einzelner und zweiter SD-Karte wechseln, in dem du den Schritten im Abschnitt [Eine zweite SD-Karte verwenden](#eine-zweite-sd-karte-verwenden) folgst. In dem du zwischen internem und externem Speicher hin- und her schaltest, legst du für KNULLI fest, wohin `/userdata` zeigen soll." - -Im Verzeichnis `/userdata` befinden sich weitere Unterordner, in denen du Spiele und weitere Dateien ablegen kannst. Nach der ersten Installation wird KNULLI diese Ordner automatisch anlegen und befüllen. Die wichtigsten Ordner für dich sind folgende: - -* `/userdata` (entspricht entweder deiner *SHARE*-Partition auf der primären SD-Karte oder der Hauptpartition auf der zweiten SD-Karte) - * `/bios` ist der Ordner, in dem du BIOSe ablegen kannst. - * `/cheats` ist der Ordner, in dem du Cheats ablegen kannst. - * `/decorations` ist der Ordner, in dem du deine Bezels ablegen kannst. - * `/music` ist der Ordner, in dem du MP3s und OGG-Dateien ablegen kannst, die in EmulationStation als Hintergrundmusik abgespielt werden können. (Die Songs sollten eine Samplerate von 44100Hz haben und eine Bitrate von maximal 256 kb/s.) - * `/roms` ist der Ordner, in dem du deine Spiele ablegen kannst. Der Ordner enthält bereits diverse Unterordner für verschiedene Systeme. Leg deine Spiele einfach in die passenden Ordner der Systeme, für die das jeweilige Spiel entwickelt wurde. - * `/snes` ist der Ordner, in dem du deine SNES-Spiele ablegen kannst. - * `/gb` ist der Ordner, in dem du deine Gameboy-Spiele ablegen kannst. - * `/ports` ist der Ordner, in dem du deine Ports (inklusive [PortMaster](../../systems/portmaster) ablegen kannst. - * ... - * `/saves` ist der Ordner, in dem deine gespeicherten Spielstände abgelegt werden. - * `/screenshots` ist der Ordner, in dem deine gespeicherten Screenshots abgelegt werden. - * `/system` ist der Ordner, der deine Einstellungen enthält. Du solltest hier keine Änderungen vornehmen, wenn du nicht weißt, was du tust. Es kann aber nicht schaden, von diesem Ordner regelmäßige Backups anzufertigen. - * `/theme-customizations` ist der Ordner, in dem du Anpassungen an deinen Themes vornehmen kannst. - * `/themes` ist der Ordner, in dem du deine Themes ablegen kannst. - -!!! info "KNULLI sucht ausschließlich im dafür vorgesehenen Ordner `roms` nach Spielen. Spiele, die außerhalb des dafür vorgesehenen Ordners abgelegt werden, werden von KNULLI nicht erkannt." - -!!! info "KNULLI ist ein Linux-System. Anders als Windows unterscheiden Linux-Systeme zwischen *Groß- und Kleinschreibung* in Datei- und Ordnernamen. Du solltest deswegen darauf achten, dich an die erwartete Groß- und Kleinschreibung zu halten, wenn du deine Dateien migrierst." - -!!! info "Für Details bzgl. der Dateien, die das jeweilige System benötigt, besuche bitte die entsprechenden Seiten im Abschnitt [Systeme](/../systems) in diesem Wiki." - -### Eine zweite SD-Karte verwenden - -Wenn du KNULLI auf einem Gerät installierst, das über zwei SD-Karten-Slots verfügt, kannst du den zweiten Slot für eine zweite SD-Karte nutzen, die dann anstelle der *SHARE*-Partition genutzt werden kann: - -* Stelle sicher, dass die zweite SD-Karte mit ext4 oder exFAT formatiert ist. (Du musst sie nicht neu formatieren, wenn sie bereits mit ext4 oder exFAT formatiert ist.) -* Steck die zweite SD-Karte in den dafür vorgesehenen Slot während das Gerät ausgeschaltet ist. -* Boote KNULLI, öffne das Hauptmenü mit dem ++"Start"++-Button und gehe zu *System settings*. -* Im Abschnitt *Storage* kannst du das *Storage device* auswählen. - * Stelle von *Internal* (der "interne" Speicher ist die *SHARE*-Partition deiner KNULLI-SD-Karte) auf den Namen deiner zweiten SD-Karte, z.B. *SHARE - 25.6G*. -* Reboote KNULLI, um die Änderungen wirksam zu machen, drücke dazu den ++"Start"++-Button und gehe im Hauptmenü zu *Quit* und wähle dort *Restart system*. -* Beim Neustart wird KNULLI auf deiner zweiten SD-Karte automatisch alle Ordner und Dateien anlegen, die du normalerweise im [`/userdata`-Ordner](#der-userdata-ordner) bzw. auf der *SHARE*-Partition findest. -* Wenn die zweite SD-Karte mit exFAT formatiert ist, kannst du die Karte aus dem Slot nehmen, nachdem du das Gerät heruntergefahren hast, und über deinen Computer mit Daten füllen. - -!!! info "Ältere Alpha-Versionen von KNULLI haben auf der zweiten SD-Karte einen Ordner namens `batocera` angelegt. In diesen Versionen hat der [`/userdata`-Ordner](#der-userdata-ordner) noch auf den `batocera`-Ordner gezeigt. Um Kompatiblität mit aktuellen KNULLI-Releases sicherzustellen, kannst du einfach den gesamten Inhalt des `batocera`-Ordners auf die oberste Ebene deiner zweiten SD-Karte verschieben." - -## Option 1: Netzwerkübertragung - -Netzwerkübertragung kann mit jedem Gerät genutzt werden, das mit dem Internet oder einem lokalen Netzwerk verbunden werden kann. (Das schließt nicht nur Geräte ein, die von sich aus W-LAN- oder kabelnetzwerkefähig sind, sondern auch Geräte, an die man einen externen USB-Dongle anschließen kann.) - -Um Netzwerkübertragung zu nutzen, musst du als erstes die Netzwerkverbindungen deines Geräts einrichten. Im Abschnitt [Netzwerkverbindungen](../../configure/networking) findest du Details dazu. Um Daten an dein Gerät via Netzwerk übertragen zu können, benötigst du - -* den Hostnamen und/oder die IP-Adresse deines Geräts. -* das Root-Passwort, wenn erweiterte Sicherheitsmaßnahmen aktiviert sind, wie im Abschnitt [Netzwerkverbindungen](../../configure/networking) beschrieben. - -### Windows-Netzwerk (SMB) - -KNULLI unterstützt, wie viele andere Betriebssysteme, das Windows-Netzwerkprotokoll SMB. Um Daten via SMB an dein Gerät zu übertragen, hast du verschiedene Möglichkeiten, je nachdem, welche Art von Computer du für die Übertragung nutzt. - -Nachdem du dich erfolgreich eingeloggt hast, kannst du den Netzwerkordner `share` sehen. Dieser Ordner entspricht deinem aktuellen [`/userdata`-Ordner](#der-userdata-ordner). Hier kannst du deine Daten (Spiele etc.) in den dafür vorgesehenen Ordnern ablegen. - -#### Windows - -Auf Windows-Computern ist SMB direkt in den *Windows-Explorer* integriert. - - - - - - - - -
- -

Schritt 1a: Finde dein KNULLI-Gerät im Abschnitt Netzwerk in deinem Windows Explorer.

- 		- -

Schritt 1b: Finde dein KNULLI-Gerät, indem du \\KNULLI in der Adressleiste des Windows Explorers eingibst.

- 		- -

Schritt 2: Öffne den share-Ordner deines KNULLI-Geräts, um auf den Inhalt des /userdata-Ordners zuzugreifen.

- 		- -

Schritt 3: Öffne den roms-Ordner deines KNULLI-Geräts, um auf die Unterordner für die verschiedenen Systeme zuzugreifen (z.B. SNES).

-
- -!!! danger "Problemlösungen" - - - Der Gerätename im Windows-Explorer entspricht dem **hostname** deines Geräts. Wenn `KNULLI` nicht funktioniert, solltest du in den *Network Settings* deines Geräts nachsehen, welchen **hostname** dein Gerät eingetragen hat. Du kannst anstelle des **hostname** auch die **IP-Adresse** deines Gerätes verwenden, wenn du die Adresse direkt in die Adressleiste eintippst. - - Du wirst möglicherweise nach Benutzername und Passwort gefragt, wenn die erweiterten Sicherheitseinstellungen aktiv sind. - - Der Benutzername ist `root`, das Passwort wird dir als *Root password* im Bereich *Security* der *System settings* angezeigt. - -#### macOS - -- Öffne Finder und wähle *Gehe zu* und dann *Mit Server verbinden* aus dem Hauptmenü. -- In der Adressleiste, die jetzt erscheint, musst du `smb://[IP-ADRESSE]` eingeben (ersetze `[IP-ADRESSE]` mit deiner IP-Adresse). -- Du wirst möglicherweise nach Benutzername und Passwort gefragt, wenn die erweiterten Sicherheitseinstellungen aktiv sind. - - Der Benutzername ist `root`, das Passwort wird dir als *Root password* im Bereich *Security* der *System settings* angezeigt. - -### FTP - -Mit einem FTP-Programm deiner Wahl kannst du eine SFTP-Verbindung zu deinem KNULLI-Gerät aufbauen. Dazu benötigst du den Hostnamen oder die IP-Adresse des Geräts. Stelle sicher, dass als Port `22` eingestellt ist. Der Benutzername lautet `root`, das Passwort wird dir als *Root password* im Bereich *Security* der *System settings* angezeigt. - -### HTTP - -!!! warning "Dieser Abschnitt ist noch in Bearbeitung. Es tut uns leid, wir arbeiten dran! :smile: Bis es soweit ist kannst du uns via [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB) kontaktieren - vielleicht können wir dir dort helfen!" - -### Nach der Übertragung - -Wenn du deine Daten vollständig übertragen hast, solltest du auf deinem KNULLI-Gerät mit dem ++"Start"++-Button das Hauptmenü öffnen und unter *Game settings* die Option *Update gamelists* wählen. KNULLI wird dann alle ROM-Ordner neu scannen und ggf. hinzugefügte Spiele identifizieren, damit du sie über EmulationStation starten kannst. - -## Option 2: SD-Karte - -Spiele können via SD-Karte hinzugefügt werden. - -### Geräte mit nur einer SD-Karte - -Wie im Abschnitt [Datenstruktur](#datenstruktur) beschrieben, ist die *SHARE*-Partition von KNULLI standardmäßig mit ext4 formatiert und daher unter Windows nicht lesbar. Wenn Netzwerkübertragung nicht möglich ist und du keinen Linux-Computer zur Verfügung hast, gibt es allerdings Lösungen, um doch direkt mit Windows auf die Speicherkarte zuzugreifen. - -#### Die Share-Partition mit exFAT formatieren - -!!! warning "Bevor du die *SHARE*-Partition mit exFAT formatierst, solltest du dir bewusst machen, dass sich einige Spiele aus der [PortMaster](../../systems/portmaster)-Bibliothek auf einem exFAT-Laufwerk nicht ausführen lassen. Einige Ports verwenden symbolische Verknüpfungen und sehr große Swap-Dateien, beides wird von exFAT nicht unterstützt." - -Es ist möglich, die *SHARE*-Partition mit dem Dateisystem exFAT zu formatieren, um die Partition über ein Kartenlesegerät mit Windows lesen und beschreiben zu können. exFAT hat allerdings Nachteile bei der Performance und ist limitiert in der zulässigen Dateigröße. Manche Spiele, insbesondere einige Ports, lassen sich nicht ausführen, wenn die *SHARE*-Partition mit exFAT formatiert ist. - -Um die Partition trotzdem mit exFAT zu formatieren, öffne das KNULLI-Hauptmenü mit dem ++"Start"++-Button und wähle unter *System settings* und *Frontent developer options* die Option *Format a disk*. Dort kannst du auswählen, ob du die Partition mit ext4 oder exFAT formatieren möchtest. - - -#### Drittanbieter-Software - -Es gibt Software von Drittanbietern, mit denen man auch unter Windows/MacOS auf Linux-Partitionen zugreifen kann: - -* Paragon EXTFS für Windows/Mac ist ein kostenpflichtiges Tool, das häufig empfohlen wird und ext2/3/4 unterstützt. -* DiskGenius für Windows ist ein Tool, von dem eher abgeraten wird, erfahrungsgemäß beschädigt das Tool häufiger Partitionen und ihren Dateninhalt. - -!!! danger "Der Einsatz von Drittanbieter-Software wird von uns generell **nicht** empfohlen. Wenn du dich damit auskennst, kannst du versuchen, mit diesem Lösungsansatz zu experimentieren. Du solltest dir aber im Klaren sein, dass du das Risiko eingehst, einen Datenverlust zu erleiden." - -### Geräte mit einer zweiten SD-Karte - -Wenn dein Gerät über einen Slot für eine zweite SD-Karte verfügt, kannst du einfach eine zweite SD-Karte an deinem Computer mit exFAT formatieren. Anschließend kannst du sie in KNULLI einrichten wie im Abschnitt [Eine zweite SD-Karte verwenden](#eine-zweite-sd-karte-verwenden) beschrieben. - -## Option 3: Linux - -Wenn du Zugriff auf einen Computer hast, der mit Linux betrieben ist, kannst du deine normale Speicherkarte auch dann lesen und bespielen, wenn sie in ext4 formatiert ist. Steck deine SD-Karte einfach in den Kartenleser deines Linux-Computers um direkten Zugriff auf die Speicherkarte zu erhalten. diff --git a/docs/play/add-games.md b/docs/play/add-games.md deleted file mode 100644 index 570dd117..00000000 --- a/docs/play/add-games.md +++ /dev/null @@ -1,152 +0,0 @@ -# :material-layers-plus: Adding Games to KNULLI - -!!! info "Unlike many other CFWs, KNULLI formats the *SHARE* partition to ext4 by default. The ext4 filesystem is not readable by Windows, so by default, you will not be able to add games in the same way you might be used to from other CFWs. However, some games from the [PortMaster](../../systems/portmaster) library only work on ext4 filesystems because they rely on symbolic links and large swap files. It is possible to [reformat the partition to exFAT](#reformat-the-share-partition-to-exfat) *after first boot*, however, you should be aware that some PortMaster games might not work on your device if you choose to reformat to exFAT." - -KNULLI has a few options for adding games. Depending on the capabilites of your device, you will have to determine which option to choose. For example, some devices do not have networking capabilites, so with those devices you will not be able to use the network transfer options. Additionally, you might have to consider the computer you will use as a data source, since some options are restricted to specific operating systems. - -## Data storage on KNULLI devices - -Before you start adding your games, please take the time to understand how data storage is structured on KNULLI. This might be helpful, *especially* when you already have experience with other CFWs and want to migrate your data. - -### The `/userdata` folder - -KNULLI supports single and dual SD card setups. Internally, KNULLI has a folder called `/userdata` where all your data (games, screenshots, bezels, saves, configurations, themes, etc.) will be stored. On a single-SD-card setup, the `/userdata` folder will always point to the *SHARE* partition of your primary SD card. If you have a device with more than one SD card slot and choose to create a dual-SD-card setup, the `/userdata` folder will point to the main partition of your secondary SD card **instead**. - -!!! info "You can switch between single/dual SD card mode by following the steps in the section about [Using a second SD card](#using-a-second-sd-card). Basically, by switching between internal/external storage, you just tell KNULLI which drive/partition `/userdata` should point to." - -Inside the `/userdata` folder, you will find subfolders where you can store your games and other files. After installing for the first time, KNULLI will create and populate all these folders automatically. The most important folders for you to know are the following: - -* `/userdata` (corresponds to either the *SHARE* partition of your primary SD card or the main partition of the secondary SD card) - * `/bios` is the folder where you can store your BIOSes. - * `/cheats` is the folder where you can store your cheats. - * `/decorations` is the folder where you can store your decorations/bezels. - * `/music` is the folder where you can store MP3 and OGG files to have them play as background music on EmulationStation. (The songs should have a sample rate of 44100Hz and a bitrate of 256kb/s max.) - * `/roms` is the folder where you can store your games. Inside the folder you will find subfolders for all supported systems. Simply place your game files into the folders of the system the game was made for, e.g. - * `/snes` is the folder where your SNES games should be stored. - * `/gb` is the folder where your Gameboy games should be stored. - * `/ports` is the folder where your ports (including [PortMaster](../../systems/portmaster) should be stored. - * ... - * `/saves` is the folder where your savegames will be stored. - * `/screenshots` is the folder where your screenshots will be stored. - * `/system` is the folder where your settings will be stored. You should not change anything in here, unless you are absolutely sure that you know what you are doing. However, it can't hurt to include this folder in your backups. - * `/theme-customizations` is the folder where your theme customizations will be stored. - * `/themes` is the folder where your themes will be stored. - -!!! info "KNULLI only scans for games in the subfolders of the `roms` folder. Games which are stored anywhere else will not be recognized as such." - -!!! info "KNULLI is a Linux system which is *case-sensitive*. Consequently, you should pay attention to capital letters when renaming folders or migrating folders from other systems/devices." - -!!! info "For details about the files which are required/supported for each system, have a look into the [Systems](/../systems) section of the wiki." - -### Using a second SD card - -!!! warning "Please be aware that you may not be able to run certain games from the [PortMaster](../../systems/portmaster) library if your secondary SD card is formatted to exFAT. Some ports rely on symlinks and large swap files which are not supported by the exFAT file system." - -If you use KNULLI on a device which has a second SD card slot, you may use the second slot for a secondary SD card, which can be used instead of the *SHARE* partition: - -* Make sure that the second SD card is formatted to ext4 or exFAT. (You don't have to reformat it if it already is formatted to ext4 or exFAT.) -* Insert the second SD card into the second SD card slot while the device is turned off. -* Boot KNULLI, open the main menu by pressing the ++"Start"++ button and choose *System settings*. -* Find the *Storage* section where you can choose your *Storage device*. - * Switch fom *Internal* (the "internal" storage is the *SHARE* partition of your KNULLI SD card) to the name of your second SD card, e.g., *SHARE - 25.6G*. -* Reboot KNULLI to apply the changes by pressing the ++"Start"++ button and choosing *Restart system* in the *Quit* section. -* During reboot, KNULLI will automatically populate the second SD card with all the folders and files you would usually find in the [userdata folder](#the-userdata-folder)/*SHARE* partition. -* If your second SD card is formatted to exFAT, you can now take the card out of the device when it is shut off. You can put the card in your computer to access it and populate it with your data. - -!!! info "Older alpha versions of KNULLI created a subfolder `batocera` on your SD card and made the [userdata folder](#the-userdata-folder) point to that `batocera` folder. However, more recent versions got rid of the `batocera` folder entirely. To maintain compatibility with current KNULLI releases, simply move the entire contents of the `batocera` folder to the top level of your second SD card." - -## Option 1: Network transfer - -Network transfer can be used on any device which can be connected to the internet or a local network. (This includes devices with native networking capabilites and ones where networking can be added through an external dongle.) - -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, you will need - -* the hostname and/or IP address of your device. -* the root password, if additional security measurements are in place, as explained in the [Networking](../../configure/networking) section. - -### Windows networks (SMB) - -Like many other operating systems, KNULLI supports SMB, the Windows network protocol. Depending on the type of computer you have, there are different options to transfer your games and other data via SMB. - -After you successfully logged in, you will be able to access the `share` partition as a network drive. The network drive corresponds to your current [`/userdata` folder](#the-userdata-folder). Here, you can put all your data (games, etc.) in the respective folders. - -#### Windows - -On every Windows computer, SMB is integrated into the *Windows Explorer*. - - - - - - - - -
- -

Step 1a: Find your KNULLI device in the Network section of your Windows Explorer.

- 		- -

Step 1b: Find your KNULLI device by typing \\KNULLI in the address bar of your Windows Explorer.

- 		- -

Step 2: Open the share folder of your KNULLI device to find the contents of the /userdata folder.

- 		- -

Step 3: Open the roms folder of your KNULLI device to find the subfolders for each systems (e.g., SNES).

-
- -!!! danger "Troubleshooting" - - - The name of the device corresponds to the **hostname** set it your KNULLI device. If `KNULLI` does not work, check the current **hostname** in the *Network Settings* of your KNULLI device. you can also use the **IP address** of your device when typing directly into the address bar. - - If additional security measurements are in place, you will be prompted for your credentials. - - The expected username is `root`, the password is the **root password** shown in the *Security* section of the *System Settings*. - -#### macOS - -- Open finder, select *Go* and then *Connect to Server* from the top menu. -- In the address bar that appears, type either `smb://[HOSTNAME]` or `smb://[IP-ADDRESS]` into the address bar (replace `[HOSTNAME]` with the hostname or `[IP-ADDRESS]` with the IP address of your device). -- If additional security measurements are in place, you will be prompted for your credentials. - - The expected username is `root`, the password is the *Root password* shown in the *Security* section of the *System settings*. - -### FTP - -Using your FTP program of choice; set up an SFTP connection to the IP address to your KNULLI device. You will need hte hostname or the IP address of the device. Make sure the port is set to `22`. The expected username is `root` and the expected password is the *Root password* you will find in the *Security* section of the *System settings*. - -### HTTP - -!!! warning "This section is still under construction. Sorry, we're working on it! :smile: Until it's done, you might want to join us on [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB) to get in touch - maybe we can help you there!" - -### After transferring your data - -Once your data is completely transferred, make sure to update your gamelists to make the data available. You can do so by pressing ++"Start"++ to open the main menu, then open *Game settings* and select *Update gamelists*. KNULLI will rescan all game folders and identify all the games you added to make them available in EmulationStation. - -## Option 2: Accessing the SD card - -Under certain circumstances, games can be added directly to your SD card. - -### Devices with a single SD card - -As explained above, the *SHARE* partition is formatted to ext4 by default. Therefore, it is not accessible on Windows. However, if neither network transfer nor a Linux computer is available to you, there are options to access the SD card from Windows anyway. - -#### Reformat the share partition to exFAT - -!!! warning "Before reformatting the SD card to exFAT, please be aware that you may not be able to run certain games from the [PortMaster](../../systems/portmaster) library afterwards. Some ports rely on symlinks and large swap files which are not supported by the exFAT file system." - -It is possible to reformat the *SHARE* partition to exFAT, to make the partition accessible on Windows. To format the partition to exFAT anyway, open the KNULLI main menu by pressing ++"Start"++ and choose *Format a disk* in the *Frontent developer options* section of the *System settings*. You will be able to choose whether you want your partition formatted to ext4 or exFAT. - -#### Third party software - -Some third-party developers offer software solutions to access Linux file systems from Windows/MacOS: - -* Paragon EXTFS for Windows/Mac is a tool which is not free but it's highly recommended since it allows seamless access to ext2/3/4. -* DiskGenius on Windows is an tool which we cannot recommend since it performs badly and tends to corrupt the partition and its content. - -!!! danger "We generally do **not** recommend using third party software to access Linux file systems. If you know what you are doing, you may try this approach anyway. However, you should be aware that you risk data loss." - -### Devices with a second SD card - -If you have slot for a second SD card available, you can simply format a second SD card to exFAT on your computer and set it up as explained in the section [Using a second SD card](#using-a-second-sd-card). - -## Option 3: Linux - -If you have access to a Linux computer, you will be able to access the *SHARE* partition anyway, even if it is formatted to ext4. Simply plug your card into your Linux computer and you will be able to browse the directories and add files directly. diff --git a/docs/play/add-games/accessing-ext4.de.md b/docs/play/add-games/accessing-ext4.de.md new file mode 100644 index 00000000..48894dc3 --- /dev/null +++ b/docs/play/add-games/accessing-ext4.de.md @@ -0,0 +1,29 @@ +# :material-micro-sd: Auf die SD-Karte zugreifen + +!!! danger "Wichtig: Unbedingt lesen bevor du weitermachst!" + + Wir empfehlen **dringend**, dass du via [**Netzwerkübertragung**](../network-transfer) auf dein KNULLI-Gerät zugreifst. Bevor du versuchst, direkt auf deine SD-Karte zuzugreifen, solltest du sicherstellen, dass du die Warnung im Abschnitt [Spiele hinzufügen](..) gelesen und verstanden hast. + +Wie im Abschnitt [Datenstruktur](../game-storage) beschrieben, ist die *SHARE*-Partition von KNULLI standardmäßig mit ext4 formatiert und daher unter Windows nicht lesbar. Wenn Netzwerkübertragung nicht möglich ist, gibt es allerdings weitere Lösungen, um direkt auf die Speicherkarte zuzugreifen. + +## Option 1: Linux + +Wenn du Zugriff auf einen Computer hast, der mit Linux betrieben ist, kannst du deine normale Speicherkarte auch dann lesen und bespielen, wenn sie in ext4 formatiert ist. Steck deine SD-Karte einfach in den Kartenleser deines Linux-Computers um direkten Zugriff auf die Speicherkarte zu erhalten. + +## Option 2: Drittanbieter-Software + +Es gibt Software von Drittanbietern, mit denen man auch unter Windows/macOS auf Linux-Partitionen zugreifen kann: + +* Paragon EXTFS für Windows/macOS ist ein kostenpflichtiges Tool, das häufig empfohlen wird und ext2/3/4 unterstützt. +* DiskGenius für Windows ist ein Tool, von dem eher abgeraten wird, erfahrungsgemäß beschädigt das Tool häufiger Partitionen und ihren Dateninhalt. + +!!! danger "Der Einsatz von Drittanbieter-Software wird von uns generell **nicht** empfohlen. Wenn du dich damit auskennst, kannst du versuchen, mit diesem Lösungsansatz zu experimentieren. Du solltest dir aber im Klaren sein, dass du das Risiko eingehst, einen Datenverlust zu erleiden." + + +#### Die Share-Partition mit exFAT formatieren + +!!! danger "Important: Read this before you proceed!" + + Sei dir bewusst, dass **sehr viele** PortMaster-Spiele **not** oder nur **stark eingeschränkt** funktionieren werden, wenn du deine Speichermedien mit exFAT formatierst. Bitte lies die Warnung im Abschnitt [Spiele hinzufügen](..), bevor du mit dem Formatieren beginnst. + +Es ist möglich, deine Speichermedien mit exFAT zu formatieren, um direkt über Windows/macOS darauf zuzugreifen. Du solltest nicht versuchen, die Speichermedien direkt aus Windows/macOS heraus zu formatieren. Folge stattdessen der Anleitung im Abschnitt [Formatieren](../formatting), um deine Speichermedien mit dem integrierten KNULLI-Formatierer zu formatieren. diff --git a/docs/play/add-games/accessing-ext4.md b/docs/play/add-games/accessing-ext4.md new file mode 100644 index 00000000..5550c257 --- /dev/null +++ b/docs/play/add-games/accessing-ext4.md @@ -0,0 +1,28 @@ +# :material-micro-sd: Accessing the SD Card + +!!! danger "Important: Read this before you proceed!" + + We **strongly** suggest to use [**Network Transfer**](../network-transfer) to access to your KNULLI device. Before you attempt to access your SD card directly, please make sure to read the warning in the [Add Games](..) section. + +As explained above, the *SHARE* partition is formatted to ext4 by default. Therefore, it is not accessible on Windows. However, if network transfer is not available to you, there are other options to access the SD card directly. + +## Option 1: Linux + +If you have access to a Linux computer, you will be able to access the *SHARE* partition anyway, even if it is formatted to ext4. Simply plug your card into your Linux computer and you will be able to browse the directories and add files directly. + +## Option 2: Third Party Software + +Some third-party developers offer software solutions to access Linux file systems from Windows/MacOS: + +* Paragon EXTFS for Windows/Mac is a tool which is not free but it's highly recommended since it allows seamless access to ext2/3/4. +* DiskGenius on Windows is an tool which we cannot recommend since it performs badly and tends to corrupt the partition and its content. + +!!! danger "We generally do **not** recommend using third party software to access Linux file systems. If you know what you are doing, you may try this approach anyway. However, you should be aware that you risk data loss." + +## Option 3: Reformat to exFAT + +!!! danger "Important: Read this before you proceed!" + + Be aware, that **many** PortMaster games will **not** work properly from an exFAT-formatted drive. Read the warning in the [Add Games](..) section for a detailed explanation. + +It is possible to (re)format your file storages to exFAT, to make them accessible on your Windows/macOS computer. Please avoid formatting your storages directly from Windows/macOS. Instead, follow the instructions in the [Formatting](../formatting) to format with the built-in KNULLI formatter. diff --git a/docs/play/add-games/formatting.de.md b/docs/play/add-games/formatting.de.md new file mode 100644 index 00000000..12aa770b --- /dev/null +++ b/docs/play/add-games/formatting.de.md @@ -0,0 +1,29 @@ +# :material-folder-cog: Formatieren + +!!! danger "Wichtig: Unbedingt lesen bevor du weitermachst!" + + Wir empfehlen **dringend**, dass du via [**Netzwerkübertragung**](../network-transfer) auf dein KNULLI-Gerät zugreifst und das Dateisystem **ext4** beibehältst. Bevor du dich dazu entscheidest, deine Speicherkarten zu formatieren, solltest du sicherstellen, dass du die Warnung im Abschnitt [Spiele hinzufügen](..) gelesen und verstanden hast. + +## Bevor du formatierst + +* Sei dir bewusst, dass formatieren impliziert, dass **alle Daten** auf dem formatierten Speicher **unwiderruflich gelöscht** werden. +* Stelle sicher, dass du den **richtigen Speicher** auswählst, insbeosndere wenn du eine **zweite SD-Karte verwendest**! +* **Vermeide** nach Möglichkeit, direkt von deinem Windows/macOS/Linux-Computer zu formatieren und benutze **stattdessen** den **integrierten KNULLI-Formatierer**! + +## Verfügbare Dateisysteme + +Der integrierte KNULLI-Fomatierer bietet dir **drei** verschiedene Dateisysteme an. Allerdings werden nur **zwei** davon derzeit tatsächlich von KNULLI unterstützt: + +* **:material-check: ext4** ist ein Linux-Dateisystem, auf das **nicht** via Windows/macOS **zugegriffen** werden kann. Allerdings unterstützt ext4 **große Swap-Dateien** sowie **symbolische Links**. Dementsprechend können die meisten PortMaster-Spiele **ohne Einschränkungen** auf ext4-formatierten Speichermedien gespielt werden. +* **:material-check: exFAT** ist ein Windows/macOS-kompatibles Dateisystem, das von den meisten CFWs, Smartphones etc. verwendet wird. Leider unterstützt exFAT weder **große Swap-Dateien** noch **symbolische Links**. Viele PortMaster-Spiele können daher **nicht** oder **nur stark eingeschränkt** auf exFAT-formatierten Speichermedien gespielt werden. +* **:material-cancel: BTRFS** ist ein Dateisystem, das derzeit **NICHT VON KNULLI UNTERSTÜTZT WIRD**. + +## Formatieren + +Der integrierte KNULLI-Formatierer kann verwendet werden, um sowohl den internen Datenspeicher der primären SD-Karte (**internal**) als auch die optionale zweite SD-Karte (**external**) zu formatieren. + +Um deine Speichermedien mit dem Dateisystem deiner Wahl zu formatieren, solltest du das KNULLI-Hauptmenü öffnen, in dem du ++"Start"++ drückst. Dort wählst du zunächst *System Settings*, dann *Frontend Developer Options* und schließlich *Format a Disk*. Stelle sicher, dass du das richtige Speichermedium (*Device to Format*) und Dateisystem (*File System*) ausgewählt hast, bevor du mit *Format Now* die Formatierung auslöst. Die eigentliche Formatierung findet dann während des nächsten Bootvorganges statt, du solltest dein Gerät also neustarten, um die Formatierung abzuschließen. + +!!! info "Nach dem Formatieren" + + Nach dem Formatieren legt KNULLI für dich automatisch einen [`/userdata`-Ordner](../game-storage) an. diff --git a/docs/play/add-games/formatting.md b/docs/play/add-games/formatting.md new file mode 100644 index 00000000..1acdf927 --- /dev/null +++ b/docs/play/add-games/formatting.md @@ -0,0 +1,29 @@ +# :material-folder-cog: Formatting + +!!! danger "Important: Read this before you proceed!" + + We **strongly** suggest to use [**Network Transfer**](../network-transfer) to access to your KNULLI device and stick with the **ext4** file system. Before you attempt to format any of your SD cards, please make sure to read the warning in the [Add Games](..) section. + +## Before you format + +* Be aware that formatting implies that **all data** on the formatted storage will be **permanently deleted**. +* Make sure to choose the **correct disk** for formatting, especially if you have a **2-SD-card setup**! +* **Avoid** formatting directly from your Windows/macOS/Linux computer and use the **built-in KNULLI formatter instead**! + +## Available file systems + +The built-in KNULLI formatter offers **three** different filesystems. However, only **two** of them are currently supported by KNULLI: + +* **:material-check: ext4** is a Linux file system which **cannot be accessed** directly from Windows/macOS. However, ext4 supports **large swap files** and **symbolic links**. Therefore, PortMaster games **run perfectly** on ext4-formatted storages. +* **:material-check: exFAT** is a Windows/macOS-compatible file system which is used by most CFWs, Smartphones, etc. However, exFAT is **incapable** of handling **large swap files** and **symbolic links**. Therefore, many PortMaster games **cannot be played** on exFAT-formatted storages. +* **:material-cancel: BTRFS** is a file system which is currently **NOT SUPPORTED BY KNULLI**. + +## Formatting + +The built-in KNULLI formatter can be used to format both, the internal data storage on your primary SD card (**internal**) and the optional second SD card (**external**). + +To format your data storages to the file systems of your choice, open the KNULLI main menu by pressing ++"Start"++ and choose *Format a disk* in the *Frontent developer options* section of the *System settings*. Make sure to choose the correct *Device to Format* and the *File System* you want to format the device to. Be aware that you need to reboot your device to apply the formatting after you chose *Format now*. + +!!! info "After Formatting" + + After formatting, KNULLI will create and populate the [`/userdata` folder](../game-storage) for you. diff --git a/docs/play/add-games/game-storage.de.md b/docs/play/add-games/game-storage.de.md new file mode 100644 index 00000000..7f3e8052 --- /dev/null +++ b/docs/play/add-games/game-storage.de.md @@ -0,0 +1,35 @@ +# :material-folder-home: Speicherort für Spiele + +Bevor du anfängst, deine Spiele hinzuzufügen, solltest du dir die Zeit nehmen, um zu verstehen, wie die Datenstruktur von KNULLI funktioniert. Dies ist *besonders wichtig*, wenn du bereits Erfahrungen mit anderen CFWs gesammelt hast und deine Daten migrieren möchtest. + +## Der `/userdata`-Ordner + +Du kannst KNULLI sowohl mit einer einzelnen SD-Karte als auch mit zwei getrennten SD-Karten verwenden. Intern benutzt KNULLI einen Ordner namens `/userdata`, um alle deine Daten (Spiele, Screenshots, Bezels, Speicherstände, Konfigurationen, Themes etc.) darin abzulegen. Wenn du KNULLI mit einer einzelnen SD-Karte verwendest, wird der `/userdata`-Ordner immer auf die *SHARE*-Partition deiner primären SD-Karte zeigen. Wenn du ein Gerät mit mehr als einem SD-Karten-Slot hast und eine zweite SD-Karte verwenden möchtest, wird `/userdata` **stattdessen** auf die Partition der zweiten SD-Karte zeigen. + +!!! info "Interner und externer Speicher" + + Du kannst zwischen erster und zweiter SD-Karte wechseln, in dem du den Schritten im Abschnitt [Eine zweite SD-Karte verwenden](../second-sd-card) folgst. Indem du zwischen internem und externem Speicher hin- und her schaltest, legst du für KNULLI fest, wohin `/userdata` zeigen soll. + +Im Verzeichnis `/userdata` befinden sich weitere Unterordner, in denen du Spiele und weitere Dateien ablegen kannst. Nach der ersten Installation wird KNULLI diese Ordner automatisch anlegen und befüllen. Die wichtigsten Ordner für dich sind folgende: + +* `/userdata` (entspricht entweder deiner *SHARE*-Partition auf der primären SD-Karte oder der Hauptpartition auf der zweiten SD-Karte) + * `/bios` ist der Ordner, in dem du BIOSe ablegen kannst. + * `/cheats` ist der Ordner, in dem du Cheats ablegen kannst. + * `/decorations` ist der Ordner, in dem du deine Bezels ablegen kannst. + * `/music` ist der Ordner, in dem du MP3s und OGG-Dateien ablegen kannst, die in EmulationStation als Hintergrundmusik abgespielt werden können. (Die Songs sollten eine Samplerate von 44100Hz haben und eine Bitrate von maximal 256 kb/s.) + * `/roms` ist der Ordner, in dem du deine Spiele ablegen kannst. Der Ordner enthält bereits diverse Unterordner für verschiedene Systeme. Leg deine Spiele einfach in die passenden Ordner der Systeme, für die das jeweilige Spiel entwickelt wurde. + * `/snes` ist der Ordner, in dem du deine SNES-Spiele ablegen kannst. + * `/gb` ist der Ordner, in dem du deine Gameboy-Spiele ablegen kannst. + * `/ports` ist der Ordner, in dem du deine Ports (inklusive [PortMaster](../../../systems/portmaster) ablegen kannst. + * ... + * `/saves` ist der Ordner, in dem deine gespeicherten Spielstände abgelegt werden. + * `/screenshots` ist der Ordner, in dem deine gespeicherten Screenshots abgelegt werden. + * `/system` ist der Ordner, der deine Einstellungen enthält. Du solltest hier keine Änderungen vornehmen, wenn du nicht weißt, was du tust. Es kann aber nicht schaden, von diesem Ordner regelmäßige Backups anzufertigen. + * `/theme-customizations` ist der Ordner, in dem du Anpassungen an deinen Themes vornehmen kannst. + * `/themes` ist der Ordner, in dem du deine Themes ablegen kannst. + +!!! info "KNULLI sucht ausschließlich im dafür vorgesehenen Ordner `roms` nach Spielen. Spiele, die außerhalb des dafür vorgesehenen Ordners abgelegt werden, werden von KNULLI nicht erkannt. Wenn du nicht sicher bist, welche Spiele in welchen Ordner gehören, empfehlen wir dringend, dass du einen Blick ins [Batocera Wiki](https://wiki.batocera.org/systems) wirfst!" + +!!! info "KNULLI ist ein Linux-System. Anders als Windows unterscheiden Linux-Systeme zwischen *Groß- und Kleinschreibung* in Datei- und Ordnernamen. Du solltest deswegen darauf achten, dich an die erwartete Groß- und Kleinschreibung zu halten, wenn du deine Dateien migrierst." + +!!! info "Für Details bzgl. der Dateien, die das jeweilige System benötigt, besuche bitte die entsprechenden Seiten im Abschnitt [Systeme](/../systems) in diesem Wiki." diff --git a/docs/play/add-games/game-storage.md b/docs/play/add-games/game-storage.md new file mode 100644 index 00000000..f6291377 --- /dev/null +++ b/docs/play/add-games/game-storage.md @@ -0,0 +1,35 @@ +# :material-folder-home: Game Storage + +Before you start adding your games, please take the time to understand how data storage is structured on KNULLI. This might be helpful, *especially* when you already have experience with other CFWs and want to migrate your data. + +## The `/userdata` Folder + +KNULLI supports single and dual SD card setups. Internally, KNULLI has a folder called `/userdata` where all your data (games, screenshots, bezels, saves, configurations, themes, etc.) will be stored. On a single-SD-card setup, the `/userdata` folder will always point to the *SHARE* partition of your primary SD card. If you have a device with more than one SD card slot and choose to create a dual-SD-card setup, the `/userdata` folder will point to the main partition of your secondary SD card **instead**. + +!!! info "Internal and external storage" + + You can switch between single/dual SD card mode by following the steps in the section about [Using a second SD card](../second-sd-card). Basically, by switching between internal/external storage, you just tell KNULLI which drive/partition `/userdata` should point to. + +Inside the `/userdata` folder, you will find subfolders where you can store your games and other files. After installing for the first time, KNULLI will create and populate all these folders automatically. The most important folders for you to know are the following: + +* `/userdata` (corresponds to either the *SHARE* partition of your primary SD card or the main partition of the secondary SD card) + * `/bios` is the folder where you can store your BIOSes. + * `/cheats` is the folder where you can store your cheats. + * `/decorations` is the folder where you can store your decorations/bezels. + * `/music` is the folder where you can store MP3 and OGG files to have them play as background music on EmulationStation. (The songs should have a sample rate of 44100Hz and a bitrate of 256kb/s max.) + * `/roms` is the folder where you can store your games. Inside the folder you will find subfolders for all supported systems. Simply place your game files into the folders of the system the game was made for, e.g. + * `/snes` is the folder where your SNES games should be stored. + * `/gb` is the folder where your Gameboy games should be stored. + * `/ports` is the folder where your ports (including [PortMaster](../../../systems/portmaster) should be stored. + * ... + * `/saves` is the folder where your savegames will be stored. + * `/screenshots` is the folder where your screenshots will be stored. + * `/system` is the folder where your settings will be stored. You should not change anything in here, unless you are absolutely sure that you know what you are doing. However, it can't hurt to include this folder in your backups. + * `/theme-customizations` is the folder where your theme customizations will be stored. + * `/themes` is the folder where your themes will be stored. + +!!! info "KNULLI only scans for games in the subfolders of the `roms` folder. Games which are stored anywhere else will not be recognized as such. If you are unsure, which folder to choose for your games, we strongly suggest to have a look into the [Batocera Wiki](https://wiki.batocera.org/systems)!" + +!!! info "KNULLI is a Linux system which is *case-sensitive*. Consequently, you should pay attention to capital letters when renaming folders or migrating folders from other systems/devices." + +!!! info "For details about the files which are required/supported for each system, have a look into the [Systems](/../systems) section of the wiki." diff --git a/docs/play/add-games/index.de.md b/docs/play/add-games/index.de.md new file mode 100644 index 00000000..3cc4c0b7 --- /dev/null +++ b/docs/play/add-games/index.de.md @@ -0,0 +1,13 @@ +# :material-layers-plus: Spiele zu KNULLI hinzufügen + +Es gibt verschiedene Möglichkeiten, um Spiele auf dein KNULLI-Gerät zu laden. Welche Möglichkeiten für dich geeignet sind, hängt davon ab, welche Funktionen auf deinem Gerät zur Verfügung stehen. Wenn dein Gerät beispielsweise keine geeignete Hardware hat, um einem Netzwerk beizutreten, kannst du natürlich keine Daten via Netzwerk übertragen. Außerdem spielt es natürlich eine Rolle, welches Gerät dir als Datenquelle zur Verfügung steht. + +!!! danger "Wichtig: Unbedingt lesen bevor du loslegst!" + + Im Gegensatz zu vielen anderen CFWs verwendet KNULLI standardmäßig das **ext4**-Dateisystem für deine Spiele, Speicherstände, Konfigurationen etc. Wir haben diese Entscheidung **bewusst** gefällt, damit du die beste Out-Of-The-Box-Erfahrung mit **PortMaster** haben kannst. Derzeit funktioniert PortMaster **nicht** vollumfänglich mit KNULLI, wenn die Spiele auf Windows/macOS-kompatiblen exFAT-Partitionen abgelegt sind. (Du findest mehr Details zu diesem Thema im Abschnitt [PortMaster](../../../systems/portmaster).) + + Es ist möglich, auf die ext4-formatierten Partitionen/SD-Karten via **Linux** zuzugreifen. Allerdings ist es **nicht möglich**, von **Windows/macOS** direkt auf die Partitionen/SD-Karten zuzugreifen. Dementsprechend wird es dir nicht möglich sein, auf deine SD-Karte auf die gleiche Weise zuzugreifen, die du möglicherweise von anderen CFWs gewohnt bist. Um deine Dateien hinzuzufügen, empfehlen wir stattdessen die **Netzwerkübertragung**. Sobald du dein KNULLI-Gerät deinem W-LAN hinzugefügt hast (wie im Abschnitt [Netzwerkverbindungen](../../../configure/networking) beschrieben), wird dein KNULLI-Gerät im Bereich **Netzwerk** in deinem **Windows Explorer** auftauchen, wo du bequem und einfach per Drag-and-Drop deine Dateien ablegen kannst. (Eine genauere Erklärung findest du im Abschnitt [Netzwerkübertragung](network-transfer).) + + Uns ist klar, dass Netzwerkübertragung etwas langsamer ist, und damit die erste Einrichtung deines Gerätes etwas erschwert, gerade dann, wenn du den größten Teil deiner Spielebibliothek auf dein Gerät laden möchtest. Wir glauben allerdings auch, dass es den **Aufwand wert ist**. Die PortMaster-Bibliothek enthält circa **500 Spiele**, viele davon sind auf deinem Handheld **vollständig spielbar**, wenn du dich für ext4 entscheidest. + + Es gibt allerdings auch eine **opt-out**-Lösung. Wenn du dir absolut sicher bist, dass du keine PortMaster-Spiele spielen möchtest, kannst du **ganz einfach** mit dem Windows-kompatiblen **exFAT**-Dateisystem **neu formatieren**. (Eine Anleitung zum Formatieren findest du im Abschnitt [Formatieren](formatting). Sei dir aber bitte bewusst, dass PortMaster **nicht** vollumfänglich funktionieren wird, wenn du dich dazu entscheidest, deinen Speicher mit exFAT zu formatieren! diff --git a/docs/play/add-games/index.md b/docs/play/add-games/index.md new file mode 100644 index 00000000..9abb1d69 --- /dev/null +++ b/docs/play/add-games/index.md @@ -0,0 +1,13 @@ +# :material-layers-plus: Adding Games to KNULLI + +KNULLI has a few options for adding games. Depending on the capabilites of your device, you will have to determine which option to choose. For example, some devices do not have networking capabilites, so with those devices you will not be able to use the network transfer options. Additionally, you might have to consider the computer you will use as a data source, since some options are restricted to specific operating systems. + +!!! danger "Important: Read this before you start!" + + Unlike many other CFWs, KNULLI currently uses **ext4** as the default file system for your games, saves, configs, etc. We made this decision **purposely**, to give you the best out-of-the-box experience with **PortMaster**. Currently, PortMaster does **not** work properly with KNULLI on Windows/macOS-compatible exFAT partitions. (You can read more about this topic in the [PortMaster](../../../systems/portmaster) section.) + + It is possible to access the ext4-formatted partitions/SD cards with **Linux** systems. However, ext4 is **not accessible** from **Windows/macOS** directly. Consequently, you will not be able to access your SD card in the same way you might be used to from other CFWs. To add your files, we suggest that you use **network transfer** instead. Once you have added the device to your Wi-Fi (as explained in the [Networking](../../../configure/networking) chapter), your KNULLI device will show up in the **Network** section of your **Windows Explorer**, where you can drag-and-drop your files just as easily. (You will find a more detailed walkthrough in the [Network Transfer](network-transfer) section.) + + We know, that network transfer is a bit slower, which is an inconvenience during the initial setup when you are uploading the major part of your games. However, we also believe that it is **worth the effort**. The PortMaster library contains about **500 games**, a lot of them will be **fully playable** on your handheld device if you stick with ext4. + + There is an **opt-out** though. If you do not want to play PortMaster games anyway, you can **easily reformat** to the Windows-compatible **exFAT** format. (You will find instructions in the [Formatting](formatting) section.) Just be aware that PortMaster will **not** work properly if you choose to format to exFAT! diff --git a/docs/play/add-games/network-transfer.de.md b/docs/play/add-games/network-transfer.de.md new file mode 100644 index 00000000..7f04c409 --- /dev/null +++ b/docs/play/add-games/network-transfer.de.md @@ -0,0 +1,84 @@ +# :material-wifi-plus: Netzwerkübertragung + +Netzwerkübertragung kann mit jedem Gerät genutzt werden, das mit dem Internet oder einem lokalen Netzwerk verbunden werden kann. (Das schließt nicht nur Geräte ein, die von sich aus W-LAN- oder kabelnetzwerkefähig sind, sondern auch Geräte, an die man einen externen USB-Dongle anschließen kann.) + +Um Netzwerkübertragung zu nutzen, musst du als erstes die Netzwerkverbindungen deines Geräts einrichten. Im Abschnitt [Netzwerkverbindungen](../../../configure/networking) findest du Details dazu. Um Daten an dein Gerät via Netzwerk übertragen zu können, benötigst du + +* den Hostnamen und/oder die IP-Adresse deines Geräts. +* das Root-Passwort, wenn erweiterte Sicherheitsmaßnahmen aktiviert sind, wie im Abschnitt [Netzwerkverbindungen](../../../configure/networking) beschrieben. + +### Windows-Netzwerk (SMB) + +KNULLI unterstützt, wie viele andere Betriebssysteme, das Windows-Netzwerkprotokoll SMB. Um Daten via SMB an dein Gerät zu übertragen, hast du verschiedene Möglichkeiten, je nachdem, welche Art von Computer du für die Übertragung nutzt. + +Nachdem du dich erfolgreich eingeloggt hast, kannst du den Netzwerkordner `share` sehen. Dieser Ordner entspricht deinem aktuellen [`/userdata`-Ordner](../game-storage). Hier kannst du deine Daten (Spiele etc.) in den dafür vorgesehenen Ordnern ablegen. + +#### Windows + +Auf Windows-Computern ist SMB direkt in den *Windows-Explorer* integriert. + + + + + + + + +
+ +

Schritt 1a: Finde dein KNULLI-Gerät im Abschnitt Netzwerk in deinem Windows Explorer.

+ 		+ +

Schritt 1b: Finde dein KNULLI-Gerät, indem du \\KNULLI in der Adressleiste des Windows Explorers eingibst.

+ 		+ +

Schritt 2: Öffne den share-Ordner deines KNULLI-Geräts, um auf den Inhalt des /userdata-Ordners zuzugreifen.

+ 		+ +

Schritt 3: Öffne den roms-Ordner deines KNULLI-Geräts, um auf die Unterordner für die verschiedenen Systeme zuzugreifen (z.B. SNES).

+
+ +Falls du in Zukunft öfter auf dein KNULLI-Gerät zugreifen möchtest, kannst du dem Gerät sogar einen Laufwerksbuchstaben zuweisen, damit es im Bereich *Dieser PC* sichtbar wird. Wenn du das tust, kannst du dort sogar nachsehen, wieviel freier Speicher auf deiner SD-Karte verfügbar ist. + + + + + + + +
+ +

Schritt 1: Klick mit der rechten Maustaste auf den share-Ordner in deinem Windows Explorer und wähle Netzlaufwerk verbinden....

+ 		+ +

Schritt 2: Weise dem Netzlaufwerk einen Buchstaben zu und bestätige.

+ 		+ +

Schritt 3: Du wirst deinen share-Ordner jetzt als Netzlaufwerk im Abschnitt Dieser PC im Windows Explorer finden.

+
+ + +!!! danger "Problemlösungen" + + - Der Gerätename im Windows-Explorer entspricht dem **hostname** deines Geräts. Wenn `KNULLI` nicht funktioniert, solltest du in den *Network Settings* deines Geräts nachsehen, welchen **hostname** dein Gerät eingetragen hat. Du kannst anstelle des **hostname** auch die **IP-Adresse** deines Gerätes verwenden, wenn du die Adresse direkt in die Adressleiste eintippst. + - Du wirst möglicherweise nach Benutzername und Passwort gefragt, wenn die erweiterten Sicherheitseinstellungen aktiv sind. + - Der Benutzername ist `root`, das Passwort wird dir als *Root password* im Bereich *Security* der *System settings* angezeigt. + +#### macOS + +- Öffne Finder und wähle *Gehe zu* und dann *Mit Server verbinden* aus dem Hauptmenü. +- In der Adressleiste, die jetzt erscheint, musst du `smb://[IP-ADRESSE]` eingeben (ersetze `[IP-ADRESSE]` mit deiner IP-Adresse). +- Du wirst möglicherweise nach Benutzername und Passwort gefragt, wenn die erweiterten Sicherheitseinstellungen aktiv sind. + - Der Benutzername ist `root`, das Passwort wird dir als *Root password* im Bereich *Security* der *System settings* angezeigt. + +### FTP + +Mit einem FTP-Programm deiner Wahl kannst du eine SFTP-Verbindung zu deinem KNULLI-Gerät aufbauen. Dazu benötigst du den Hostnamen oder die IP-Adresse des Geräts. Stelle sicher, dass als Port `22` eingestellt ist. Der Benutzername lautet `root`, das Passwort wird dir als *Root password* im Bereich *Security* der *System settings* angezeigt. + +### HTTP + +!!! warning "Dieser Abschnitt ist noch in Bearbeitung. Es tut uns leid, wir arbeiten dran! :smile: Bis es soweit ist kannst du uns via [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB) kontaktieren - vielleicht können wir dir dort helfen!" + +### Nach der Übertragung + +Wenn du deine Daten vollständig übertragen hast, solltest du auf deinem KNULLI-Gerät mit dem ++"Start"++-Button das Hauptmenü öffnen und unter *Game settings* die Option *Update gamelists* wählen. KNULLI wird dann alle ROM-Ordner neu scannen und ggf. hinzugefügte Spiele identifizieren, damit du sie über EmulationStation starten kannst. diff --git a/docs/play/add-games/network-transfer.md b/docs/play/add-games/network-transfer.md new file mode 100644 index 00000000..5b563d06 --- /dev/null +++ b/docs/play/add-games/network-transfer.md @@ -0,0 +1,83 @@ +# :material-wifi-plus: Network Transfer + +Network transfer can be used on any device which can be connected to the internet or a local network. (This includes devices with native networking capabilites and ones where networking can be added through an external dongle.) + +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, you will need + +* the hostname and/or IP address of your device. +* the root password, if additional security measurements are in place, as explained in the [Networking](../../../configure/networking) section. + +### Windows networks (SMB) + +Like many other operating systems, KNULLI supports SMB, the Windows network protocol. Depending on the type of computer you have, there are different options to transfer your games and other data via SMB. + +After you successfully logged in, you will be able to access the `share` partition as a network drive. The network drive corresponds to your current [`/userdata` folder](../game-storage). Here, you can put all your data (games, etc.) in the respective folders. + +#### Windows + +On every Windows computer, SMB is integrated into the *Windows Explorer*. + + + + + + + + +
+ +

Step 1a: Find your KNULLI device in the Network section of your Windows Explorer.

+ 		+ +

Step 1b: Find your KNULLI device by typing \\KNULLI in the address bar of your Windows Explorer.

+ 		+ +

Step 2: Open the share folder of your KNULLI device to find the contents of the /userdata folder.

+ 		+ +

Step 3: Open the roms folder of your KNULLI device to find the subfolders for each systems (e.g., SNES).

+
+ +If you want to access your KNULLI device regularly, you can even assign a drive letter to make it show up in *This PC*. By doing so, you will even be able to see, how much space you have left on your SD card. + + + + + + + +
+ +

Step 1: Right-click the share folder in Windows Explorer and select Map network drive....

+ 		+ +

Step 2: Assign a drive letter and confirm.

+ 		+ +

Step 3: Find your KNULLI share folder as a network drive in This PC in Windows Explorer.

+
+ +!!! danger "Troubleshooting" + + - The name of the device corresponds to the **hostname** set it your KNULLI device. If `KNULLI` does not work, check the current **hostname** in the *Network Settings* of your KNULLI device. you can also use the **IP address** of your device when typing directly into the address bar. + - If additional security measurements are in place, you will be prompted for your credentials. + - The expected username is `root`, the password is the **root password** shown in the *Security* section of the *System Settings*. + +#### macOS + +- Open finder, select *Go* and then *Connect to Server* from the top menu. +- In the address bar that appears, type either `smb://[HOSTNAME]` or `smb://[IP-ADDRESS]` into the address bar (replace `[HOSTNAME]` with the hostname or `[IP-ADDRESS]` with the IP address of your device). +- If additional security measurements are in place, you will be prompted for your credentials. + - The expected username is `root`, the password is the *Root password* shown in the *Security* section of the *System settings*. + +### FTP + +Using your FTP program of choice; set up an SFTP connection to the IP address to your KNULLI device. You will need hte hostname or the IP address of the device. Make sure the port is set to `22`. The expected username is `root` and the expected password is the *Root password* you will find in the *Security* section of the *System settings*. + +### HTTP + +!!! warning "This section is still under construction. Sorry, we're working on it! :smile: Until it's done, you might want to join us on [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB) to get in touch - maybe we can help you there!" + +### After transferring your data + +Once your data is completely transferred, make sure to update your gamelists to make the data available. You can do so by pressing ++"Start"++ to open the main menu, then open *Game settings* and select *Update gamelists*. KNULLI will rescan all game folders and identify all the games you added to make them available in EmulationStation. diff --git a/docs/play/add-games/second-sd-card.de.md b/docs/play/add-games/second-sd-card.de.md new file mode 100644 index 00000000..f47c563b --- /dev/null +++ b/docs/play/add-games/second-sd-card.de.md @@ -0,0 +1,24 @@ +# :material-layers-plus: Eine zweite SD-Karte verwenden + +!!! danger "Important: Read this before you proceed!" + + Wenn du eine zweite SD-Karte verwenden willst, empfehlen wir dir **dringend**, sie mit **ext4** zu formatieren und via [**Netzwerkübertragung**](../network-transfer) darauf zuzugreifen. Bevor du anfängst, eine mit exFAT formatierte zweite SD-Karte einzurichten, lies bitte die Warnung im Abschnitt [Spiele hinzufügen](..). + +Wenn du KNULLI auf einem Gerät installierst, das über zwei SD-Karten-Slots verfügt, kannst du den zweiten Slot für eine zweite SD-Karte nutzen, die dann **anstelle** der *SHARE*-Partition der ersten SD-Karte genutzt werden kann. + +* Schalte dein KNULLI-Gerät aus (falls es noch eingeschaltet ist). +* Steck die zweite SD-Karte in den dafür vorgesehenen Slot während das Gerät ausgeschaltet ist. +* Boote KNULLI, öffne das Hauptmenü mit dem ++"Start"++-Button und gehe zu *System settings*. +* Im Abschnitt *Storage* kannst du das *Storage device* auswählen. + * Stelle von *Internal* (der "interne" Speicher ist die *SHARE*-Partition deiner KNULLI-SD-Karte) auf den Namen deiner zweiten SD-Karte, z.B. *SHARE - 25.6G*. +* Reboote KNULLI, um die Änderungen wirksam zu machen, drücke dazu den ++"Start"++-Button und gehe im Hauptmenü zu *Quit* und wähle dort *Restart system*. +* Falls deine zweite SD-Karte **noch nicht** mit dem Dateisystem deiner Wahl formatiert ist + * folge der Anleitung im Abschnitt [Formatieren](../formatting) um die SD-Karte mit dem **integrierten KNULLI-Formatierer** zu formatieren. + * stelle sicher, dass du das Gerät noch einmal neustartest, um die Formatierung fertigzustellen. + +* Beim Neustart wird KNULLI auf deiner zweiten SD-Karte automatisch alle benötigten Ordner und Dateien anlegen, die du normalerweise im [`/userdata`-Ordner](../game-storage) bzw. auf der *SHARE*-Partition findest. +* Falls du deine zweite SD-Karte mit exFAT formatiert hast, kannst du die Karte aus dem Slot nehmen, nachdem du das Gerät heruntergefahren hast, und über deinen Computer mit Daten füllen. + +!!! info "Der `batocera`-Ordner" + + Ältere Alpha-Versionen von KNULLI haben auf der zweiten SD-Karte einen Ordner namens `batocera` angelegt. In diesen Versionen hat der [`/userdata`-Ordner](../game-storage) noch auf den `batocera`-Ordner gezeigt. Um Kompatiblität mit aktuellen KNULLI-Releases sicherzustellen, kannst du einfach den gesamten Inhalt des `batocera`-Ordners auf die oberste Ebene deiner zweiten SD-Karte verschieben." diff --git a/docs/play/add-games/second-sd-card.md b/docs/play/add-games/second-sd-card.md new file mode 100644 index 00000000..388dc9a6 --- /dev/null +++ b/docs/play/add-games/second-sd-card.md @@ -0,0 +1,23 @@ +# :material-layers-plus: Using a Second SD Card + +!!! danger "Important: Read this before you proceed!" + + If you want to use a second SD card, we **strongly** recommend to format it to **ext4** and use [**Network Transfer**](../network-transfer) to access it. Before you attempt set up a exFAT-formatted second SD card, pleae make sure to read the warning in the [Add Games](..) section. + +If you use KNULLI on a device which has a second SD card slot, you may use the second slot for a secondary SD card, which can be used **instead** of the *SHARE* partition of the primary SD card. + +* Shut down your KNULLI device (if it is currently turned on). +* Insert the second SD card into the second SD card slot while the device is turned off. +* Boot KNULLI, open the main menu by pressing the ++"Start"++ button and choose *System settings*. +* Find the *Storage* section where you can choose your *Storage device*. + * Switch fom *Internal* (the "internal" storage is the *SHARE* partition of your KNULLI SD card) to the name of your second SD card, e.g., *SHARE - 25.6G*. +* Reboot KNULLI to apply the changes by pressing the ++"Start"++ button and choosing *Restart system* in the *Quit* section. +* If your secondary SD card is **not yet** formatted to the file system of your choice + * follow instructions in the [Formatting](../formatting) section to format your SD card with the **built-in KNULLI formatter**. + * make sure to reboot once more to apply the formatting. +* During reboot, KNULLI will automatically populate the second SD card with all the required folders and files you would usually find in the [userdata folder](../game-storage)/*SHARE* partition. +* If your second SD card is formatted to exFAT, you can now shut down your device and take the card out. You can put the card in your computer to access it and populate it with your data. + +!!! warning "The `batocera` folder" + + Older alpha versions of KNULLI created a subfolder `batocera` on your secondary SD card and made the [userdata folder](../game-storage) point to that `batocera` folder. However, more recent versions got rid of the `batocera` folder entirely. To maintain compatibility with current KNULLI releases, simply move the entire contents of the `batocera` folder to the top level of your second SD card." diff --git a/docs/play/quick-start.md b/docs/play/quick-start.md index 9b32efd0..9b129ce3 100644 --- a/docs/play/quick-start.md +++ b/docs/play/quick-start.md @@ -8,11 +8,11 @@ With this quick start guide, we will help you get started with KNULLI on your ha Unlike many other CFWs, KNULLI currently uses **ext4** as the default file system for your games, saves, configs, etc. We made this decision **purposely**, to give you the best out-of-the-box experience with **PortMaster**. Currently, PortMaster does **not** work properly with KNULLI on Windows/macOS-compatible exFAT partitions. (You can read more about this topic in the [PortMaster](../../systems/portmaster) section.) - It is possible to access the ext4-formatted partitions with **Linux** systems. However, ext4 is **not accessible** from **Windows/macOS** directly. Consequently, you will not be able to access your SD card in the same way you might be used to from other CFWs. To add your files, we suggest that you use **network transfer** instead. Once you have added the device to your Wi-Fi (as explained in the [Networking](../../configure/networking) chapter), your KNULLI device will show up in the **Network** section of your **Windows Explorer**, where you can drag-and-drop your files just as easily. (You will find a more detailed walkthrough in the [Add Games](../add-games) section.) + It is possible to access the ext4-formatted partitions/SD cards with **Linux** systems. However, ext4 is **not accessible** from **Windows/macOS** directly. Consequently, you will not be able to access your SD card in the same way you might be used to from other CFWs. To add your files, we suggest that you use **network transfer** instead. Once you have added the device to your Wi-Fi (as explained in the [Networking](../../configure/networking) chapter), your KNULLI device will show up in the **Network** section of your **Windows Explorer**, where you can drag-and-drop your files just as easily. (You will find a more detailed walkthrough in the [Network Transfer](../add-games/network-transfer) section.) We know, that network transfer is a bit slower, which is an inconvenience during the initial setup when you are uploading the major part of your games. However, we also believe that it is **worth the effort**. The PortMaster library contains about **500 games**, a lot of them will be **fully playable** on your handheld device if you stick with ext4. - There is an **opt-out** though. If you do not want to play PortMaster games anyway, you can **easily reformat** to the Windows-compatible **exFAT** format. (You will find instructions in the [Add Games](../add-games) section.) Just be aware that PortMaster will **not** work properly if you choose to format to exFAT! + There is an **opt-out** though. If you do not want to play PortMaster games anyway, you can **easily reformat** to the Windows-compatible **exFAT** format. (You will find instructions in the [Formatting](../add-games/formatting) section.) Just be aware that PortMaster will **not** work properly if you choose to format to exFAT! ## Installing KNULLI [![Latest](https://img.shields.io/github/release/knulli-cfw/distribution.svg?labelColor=111111&color=5998FF&label=Latest&style=flat#only-light)](https://github.com/knulli-cfw/distribution/releases/latest)[![Latest](https://img.shields.io/github/release/knulli-cfw/distribution.svg?labelColor=dddddd&color=5998FF&label=Latest&style=flat#only-dark)](https://github.com/knulli-cfw/distribution/releases/latest) @@ -28,16 +28,16 @@ Your first steps will depend on how you want to use your KNULLI device. For most users, we **recommend** to use a **single SD card** with the **default formatting**. -However, if you want a different setup, e.g. because your device does not support Wi-Fi, use the table below to determine, which setup suits your needs. Be aware that it might be required to **reformat** the storage before you can use it. Please use the **built-in KNULLI formatter** for this purpose. Also, please be aware that you have to **switch** between internal and external storage **manually**. (You will find detailed instructions on switching and formatting storages in the [Add Games](../add-games) section.) +However, if you want a different setup, e.g. because your device does not support Wi-Fi, use the table below to determine, which setup suits your needs. Be aware that it might be required to **reformat** the storage before you can use it. Please use the **built-in KNULLI formatter** for this purpose. Also, please be aware that you have to **switch** between internal and external storage **manually**. (You will find detailed instructions on [switching](../add-games/second-sd-card) and [formatting](../add-games/formatting) storages in the [Add Games](../add-games) section.) -It is possible to use an already populated SD card as secondary SD card. However, if you attempt to do so, please make sure that the **folder structure** matches the one described in the [Add Games](../add-games) section. +It is possible to use an already populated SD card as secondary SD card. However, if you attempt to do so, please make sure that the **folder structure** matches the one described in the [Game Storage](../add-games/game-storage) section. !!! danger "Decide how you want to store your files" | SD cards | I want to play PortMaster games! | I want to access the SD card from Windows without Network transfer! (I accept that PortMaster will *not* work.) | | ------------ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | - | 1 | *You are good to go!* :material-check: | *You will have to* ***reformat*** *your* ***internal storage*** *to* ***exFAT***. | - | 2 | *You will have to* ***reformat*** *your* ***external storage*** *to* ***ext4*** *(unless it is already formatted to ext4).* | *You will have to* ***reformat*** *your* ***external storage*** *to* ***exFAT*** *(unless it is already formatted to exFAT).* | + | 1 | *You are good to go!* :material-check: | *You will have to* [***reformat***](../add-games/formatting) *your* ***internal storage*** *to* ***exFAT***. | + | 2 | *You will have to* [***reformat***](../add-games/formatting) *your* [***external storage***](../add-games/second-sd-card) *to* ***ext4*** *(unless it is already formatted to ext4).* | *You will have to* [***reformat***](../add-games/formatting) *your* [***external storage***](../add-games/second-sd-card) *to* ***exFAT*** *(unless it is already formatted to exFAT).* | Make sure that you **made a decision** on how to store your files and **prepared the storage accordingly** before you continue with the next step. diff --git a/mkdocs.yml b/mkdocs.yml index 648a6a3d..bf03742a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,7 +59,7 @@ extra: - icon: fontawesome/brands/github link: https://github.com/knulli-cfw/distribution - icon: fontawesome/brands/discord - link: https://discord.gg/QZKr2QFA + link: https://discord.gg/HXPS3DAeeB extra: alternate: - name: English @@ -125,6 +125,11 @@ plugins: Install: Installation Update: Aktualisieren Add Games: Spiele hinzufügen + Game Storage: Speicherort für Spiele + Network Transfer: Netzwerkübertragung + Accessing SD Card: Zugriff auf SD-Karte + Second SD Card: Zweite SD-Karte + Formatting: Formatieren Scraping: Scraping Hotkey shortcuts: Tastenkombinationen Achievements: Achievements @@ -172,12 +177,18 @@ nav: - Play: - Quick Start Guide: play/quick-start.md - Install: play/install.md - - Update: play/update.md - - Add Games: play/add-games.md + - Add Games: + - play/add-games/index.md + - Game Storage: play/add-games/game-storage.md + - Network Transfer: play/add-games/network-transfer.md + - Accessing SD Card: play/add-games/accessing-ext4.md + - Second SD Card: play/add-games/second-sd-card.md + - Formatting: play/add-games/formatting.md - Scraping: play/scraping.md - Hotkey Shortcuts: play/hotkey-shortcuts.md - Achievements: play/retro-achievements.md - Netplay: play/netplay.md + - Update: play/update.md - Configure: - Networking: configure/networking.md - Controls: configure/controls.md