Merge pull request #12 from chrizzo-hb/main

Section about PortMaster

Author: acmeplus

docs/play/add-games.de.md

@@ -19,7 +19,7 @@ Die größte Partition auf deiner SD-Karte ist die *SHARE*-Partition. *SHARE* wi
 Im Verzeichnis `/userdata` befinden sich weitere Unterordner, in denen du Spiele und weitere Dateien ablegen kannst. Die wichtigsten Ordner für dich sind folgende:
 
 * `/userdata`
-    * `/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 für die Systems, für die das jeweilige Spiel entwickelt wurde.
+    * `/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.
     * `/bios` ist der Ordner, in dem du BIOSe 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.)
     * `/saves` ist der Ordner, in dem deine gespeicherten Spielstände abgelegt werden.

docs/play/add-games.md

@@ -4,7 +4,7 @@ KNULLI has a few options for adding games. Depending on the capabilites of your
 
 ## Data storage structure
 
-When you install KNULLI on a SD card, several partitions will be created, which will be shown to you as different drives on your computer. Most of these drives can only be accessed from a Linux operating system. On Windows, they are not accessible.
+When you install KNULLI on a SD card, several partitions will be created, which will be shown to you as different drives on your computer. Most of these drives can only be accessed from a Linux operating system. They are not accessible on Windows.
 
 !!! danger "You should never format the KNULLI partitions which Windows cannot read, no matter how strongly Windows suggests that."
 
@@ -16,10 +16,10 @@ The biggest partition on your SD card is the *SHARE* partition. By default, KNUL
 
 ### The userdata folder
 
-Inside the `/userdata` folder, you will find subfolders, where you can store your games and other files. The most important folders for you to know are the following:
+Inside the `/userdata` folder, you will find subfolders where you can store your games and other files. The most important folders for you to know are the following:
 
 * `/userdata`
-    * `/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.
+    * `/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.
     * `/bios` is the folder where you can store your BIOSes.
     * `/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.)
     * `/saves` is the folder where your savegames will be stored.

docs/play/netplay.md

@@ -0,0 +1,3 @@
+# :material-web: Netplay
+
+!!! 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!"

docs/play/update.md

@@ -1,6 +1,6 @@
 #  :material-update: Updating KNULLI
 
-On devices, which can be connected to the internet, KNULLI can be updated "over the air" (OTA). Alternatively, KNULLI can also be updated by downloading the respective update file and installing it manually.
+On devices which can be connected to the internet, KNULLI can be updated "over the air" (OTA). Alternatively, KNULLI can also be updated by downloading the respective update file and installing it manually.
 
 ## Option 1: OTA update
 

docs/systems/portmaster.md

@@ -0,0 +1,51 @@
+# :material-ferry: PortMaster
+
+PortMaster is a management software for installing and updating various ports for Linux-driven handheld video game systems. Ports are, in this case, video games which have been adapted from other systems and optimized to run natively on your handheld device. You will find more information about PortMaster on the [PortMaster website](https://portmaster.games).
+
+## Games
+
+The PortMaster library is huge and contains almost 500 different games already. However, not all of those games will run on your respective device. Hence, when browsing the PortMaster library on your device, you will only find games which are compatible with your handheld.
+
+The library is divided in two major categories:
+
+* Ports which are *"Ready to run"* are ports of free games which you can install and immediately start playing.
+* Ports with *"Files needed"* are ports of commercially released games. To be able to run these ports, you will have to provide essential files from the games you bought.
+
+!!! info "Some PortMaster games only run on drives which are formatted to ext4. You will find information on how to reformat your drive in the [Add Games](../../play/add-games) section."
+
+## Installing PortMaster
+
+After installing KNULLI, you will find the PortMaster install script (*Install.PortMaster*) in the *Ports* category. Running this script will install PortMaster on your KNULLI device and restart EmulationStation automatically. Now, you will find *PortMaster* in the *Ports* category instead of the install script.
+
+## Managing games
+
+PortMaster will automatically check for updates during launch and apply them, if necessary. Afterwards, you will find yourself in the main menu of PortMaster. Here, you can find ports to install or manage the ports on your device.
+
+!!! info "PortMaster requires an active internet connection to install and update ports."
+
+* *Featured Ports* presents a hand-picked selection of ports, curated by the PortMaster team.
+* *All Ports* contains a list of all ports which are compatible with your respective device, including ports which are ready-to-run and ports which require some additonal files.
+* *Ready To Run Ports* contains a list of all free ready-to-run ports which you can install and immediately start playing.
+* *Manage Ports* provides options to update, re-install, or uninstall the ports which are currently installed on your device.
+
+There is also an *Options* section where you will find settings for PortMaster itself.
+
+### Installing ready-to-run games
+
+To install a ready-to-run game, simply find it in the *Ready To Run Ports* section and install it by following the on-screen instructions. Once you are done installing your games, exit PortMaster from the PortMaster main menu. EmulationStation will restart automatically to apply the changes and detect the newly installed games. You will now find the game in the *Ports* category.
+
+If the game does not show up, press ++"Start"++ and pick *Game settings* and *Update gamelists* to restart EmulationStation and detect new games. If that does not help, launch *PortMaster*, find the game in the *Manage Ports* section and reinstall it.
+
+### Installing games with files needed
+
+To install a game with files needed, simply find it in the *All Ports* section and install it by following the on-screen instructions. Once you are done installing your games, exit PortMaster from the PortMaster main menu. EmulationStation will restart automatically to apply the changes and detect the newly installed games.
+
+Now, you will have to take care of the files needed to be able to play the game. To do so, gain access to your `roms/ports` folder by one of the methods described in the [Add Games](../../play/add-games) section. In your `roms/ports` folder, you will find subfolders for all the ports you have installed via PortMaster. Find the subfolder which corresponds to the game you want to install.
+
+The [Games](https://portmaster.games/games.html) section of the PortMaster website will provide you with instructions which files you will need and where to put them. Additionally, you might find a `readme` file in the folder where the port is stored. Depending on the game, you might need a specific version to be compatible with the port. You will often find compatible versions of the games on [GOG](https://gog.com) or [Steam](https://store.steampowered.com), however, you should read the instructions of the respective port carefully before buying the game to be sure that you found the right version of it.
+
+After you added all the required files, the game should be ready to run. Simply go to the *Ports* category, find the game, and launch it!
+
+!!! info "During first launch, some ports will take some time to compress and/or compile and/or repackage files from the original game. Depending on the game, this may take several minutes, sometimes even longer. Do not panic if the first launch takes some time. Do not panic if you see a lot of command-line messages. Some games may even require several attempts to prepare all the necessary assets for playing the game on your handheld. Be patient."
+
+If the game does not show up, press ++"Start"++ and pick *Game settings* and *Update gamelists* to restart EmulationStation and detect new games. If that does not help, launch *PortMaster*, find the game in the *Manage Ports* section and reinstall it.

mkdocs.yml

@@ -177,6 +177,7 @@ nav:
     - Systems:
       - Engines:
         - Pico-8: systems/pico-8.md
+      - PortMaster: systems/portmaster.md
     - Devices: 
       - devices/index.md
       - Anbernic: