Skip to content

Commit f8151bb

Browse files
authored
Merge pull request #13 from chrizzo-hb/main
Updated FAQ, added section about RetroArch control remapping
2 parents 749ee3d + c07d493 commit f8151bb

12 files changed

+69
-27
lines changed

docs/configure/retroarch/controls.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Modifying controls in RetroArch
2+
3+
For several systems, KNULLI employs emulation cores from the RetroArch library (*libretro*). You will find exhaustive documentation on how to use RetroArch in the excellent [RetroArch documentation portal](https://docs.libretro.com). However, to give you a kick-start, here's how to remap controls for your RetroArch-driven emulation systems on your KNULLI device.
4+
5+
## Remap by game, content directory, or core
6+
7+
If you want to remap controls for your retroArch-driven games, first you got to decide, whether you want to change controls for the *game*, the *content directory* where the game is stored, or the entire emulation *core*.
8+
9+
When launching a game with a RetroArch core, RetroArch first loads its default remap file `common.rmp`. However, the default remap file can be overriden hierarchically in the following order:
10+
11+
1. *core* remap file overrides default remap file
12+
2. *content directory* remap file overrides core and default remap file
13+
3. *game* remap file overrides all other remap files
14+
15+
Now, depending on how your games are stored on your device, if you want to change key mappings for each game of a system, you might either want to change controls for the entire *core* or for the *content directory*. However, even if you create a remap file for a *content directory*, the remapping still will **only** apply to the core it was made for.
16+
17+
Changing controls for an entire *core* might come in handy if you want to change the key mappings for every game which is run by that core, e.g. for globally swapping ++"B"++ and ++"Y"++ and ++"A"++ and ++"B"++ on a Gameboy core to make default Gameboy controls more similar to default SNES controls and not having to make the same change for every single game again.
18+
19+
Remapping controls for a *content directory* could be helpful if the core covers games from more than one folder but you want to apply the remap to games from only one of these folders.
20+
21+
Changing controls for a single *game* will help you to adapt controls for a single game without messing up controls for every other game of the same core (or folder).
22+
23+
## Remap your controls
24+
25+
After you made a decision on whether you want a *game* or *core* specific remapping, hold ++"F"++ (the function button) and press ++"B"++ to bring up the RetroArch menu while playing the game.
26+
27+
- Go to the *Controls* section and select *Manage Remap Files*.
28+
- Check if there is already an *Active Remap File* indicated at the top of the menu and if that is the remap file you would like to edit.
29+
- If the file is named like the game, it is a *game* remap file.
30+
- If the file is named like the folder it is a *content directory* remap file.
31+
- If the file is named like the emulation core it is a *core* remap file.
32+
- If the file is named `common.rmp` it is the *default* remap file. (You should not try to edit this one.)
33+
- If the default remap file is selected (or the active remap file is not the remap file you want to use),
34+
- pick *Save Game Remap File* to create a game remap file or
35+
- pick *Save Content Directory File* to create a content directory remap file or
36+
- pick *Save Core Remap File* to create a core remap file.
37+
- If you want to permanently delete the current remap file
38+
- pick *Remove Game Remap File* to **permanently delete** the game remap file or
39+
- pick *Remove Content Directory File* to **permanently delete** the content directory remap file or
40+
- pick *Remove Core Remap File* to **permanently delete** the core remap file.
41+
- After you made sure the *Active Remap File* indicates the file you want to use and modify,
42+
- return the previous section (*Controls*),
43+
- pick the control port you want to remap (for the controls integrated in your KNULLI device, use *Port 1 Controls*), and
44+
- find the input of your device that you want to reassign (first/left column) and assign it to the desired input of the emulated system (second/right column).
45+
46+
Once you are done remapping, return to your game. All changes you made will be stored in the currently active remap file and will be automatically restored when you launch the game again, unless they are overriden by another remap file as illustrated above.

docs/devices/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Device Support
22

3-
KNULLI supports a variety of ARM based devices.
3+
We are working on KNULLI versions for a variety of ARM based devices.
44

55
There are two main categories, those that have GPU support and include Emulation Station as their main interface, and others that are currently framebuffer based only (legacy) that typically use Simplemenu as the main interface.
66

7+
!!! info "Not all devices we are currently working on have received a public release of KNULLI, yet. To find out if KNULLI is already available for your device, visit the [Releases page](https://github.com/knulli-cfw/distribution/releases/latest). You will find a list of all currently supported devices in the `Installation Package Downloads` section. If you find a package for your device there, you should follow the [Installation guide](../../play/install) to install KNULLI on your device. If your device is **not** listed there, please be patient. There is no public release available, yet. Do *not* attempt to install a package for a different device - it will not work."
8+
79
## GPU supported devices
810

911
| Manufacturer | Device | CPU / Architecture | Kernel | GL driver | Interface |

docs/faqs.md

+5-19
Original file line numberDiff line numberDiff line change
@@ -21,36 +21,22 @@ A: Because batocera license does not allow for closed sourced kernels to be adde
2121

2222
A: The goal is to maintain compatibility with batocera, but with focus on low powered devices or devices that don't necessarily benefit from some features that have an impact on device performance, etc. For instance, devices with low memory (256MB like Powkiddy A12/A13 or RG35XX Classic). Then there's also the intention to add features currently present in [JelOS](https://jelos.org)/[Rocknix](https://github.com/rocknix), [EmuELEC](https://github.com/EmuELEC), etc.
2323

24-
### Q: Where can I download the latest version
24+
### Q: Where can I download the latest version?
2525

26-
A: Check the downloads sections (TBC)
26+
You will find the latest version of KNULLI on our [Releases page](https://github.com/knulli-cfw/distribution/releases/latest). Find the download for your device in the `Installation Package Downloads` section and follow the [Installation guide](../play/install) to install KNULLI on your device. If your device is not listed there, please be patient - there is no public release of KNULLI for your device available, yet.
2727

2828
---
2929

30-
### Q: Which devices are supported
30+
### Q: Which devices are supported?
3131

32-
A: Check the list of supported devices
32+
You will find a list of all currently supported devices in the `Installation Package Downloads` section of our [Releases page](https://github.com/knulli-cfw/distribution/releases/latest). If your device is not listed there, there is no public release of KNULLI for your device available, yet.
3333

3434
---
3535

3636
### Q: I want to add my own roms to the SDCARD but my Windows/Mac computer can't see the roms partition
3737

3838
A: By default KNULLI formats the second partition with Linux EXT4 file format. That format is typically
39-
not readable/mountable under Windows/Mac. To solve that you need to use one of the following approaches:
40-
41-
* Use Paragon EXTFS for Windows/Mac. This tool is not free but it's highly recommended since it allows seamless
42-
access to EXT2/3/4
43-
* Use DiskGenius on Windows. Not recommended. DiskGenius performs badly and tends to corrupt the partition and its content
44-
* Format the second partition as FAT32:
45-
* Insert the SDCARD on your PC/MAC
46-
* On Windows, open the partition tool and erase/format the second partition (SHARE) as FAT32
47-
* On Mac, unfortunately you will need use the command line to completely reformat the partition. Open Disk Utility and note the
48-
disk number and partition of your usb (e.g. disk4s2). Open a terminal and reformat the partition with the following command:
49-
```sudo diskutil eraseVolume ms-dos SHARE /dev/disk4s2```
50-
* Eject the SDCARD from your computer and insert it again on the RG35XX
51-
* Power the device on
52-
* KNULLI will re-populate the partition with the correct contents. After the system boots you can power it off and insert the sdcard
53-
on your computer to add your bios/roms or any other content.
39+
not readable/mountable under Windows/Mac. We propose to use network transfer instead. Alternatively, you may reformat the partition from within KNULLI. Please refer to the [Add Games](../play/add-games) section for details.
5440

5541
---
5642

docs/index.de.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ KNULLI unterstützt sowohl Geräte mit GPU (GLES-Unterstützung) als auch Gerät
2626

2727
## Community
2828

29-
KNULLI nutzt Discord und [:simple-github: GitHub](https://github.com/knulli-cfw/distribution/discussions) Diskussionsseiten für Diskussionen, wenn du dich uns anschließen möchtest, nutze bitte folgenden Link: [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB)
29+
KNULLI nutzt Discord für Diskussionen, wenn du dich uns anschließen möchtest, nutze bitte folgenden Link: [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB)
3030

3131
## Lizenzen
3232

docs/index.es.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ KNULLI soporta dispostivos con GPU (soporte a través de GLES) y aquellas que s
2626

2727
## Comunidad
2828

29-
KNULLI utiliza las páginas de discusión de Discord y [:simple-github: GitHub](https://github.com/knulli-cfw/distribution/discussions), si te gustaría unirte a nosotros por favor usa este enlace: [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB)
29+
KNULLI utiliza las páginas de discusión de Discord, si te gustaría unirte a nosotros por favor usa este enlace: [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB)
3030

3131
## Licencias
3232

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ KNULLI supports devices with GPU (GLES support) and framebuffer only (legacy).
2626

2727
## Community
2828

29-
KNULLI uses Discord and [:simple-github: GitHub](https://github.com/knulli-cfw/distribution/discussions) discussion pages for discussion, it you would like to join us please use this link: [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB)
29+
KNULLI uses Discord for discussions, it you would like to join us please use this link: [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB)
3030

3131
## Licenses
3232

docs/play/add-games.de.md

+2
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ Wie im Abschnitt [Datenstruktur](#datenstruktur) beschrieben, ist die *SHARE*-Pa
9090

9191
#### Die Share-Partition mit exFAT formatieren
9292

93+
!!! 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."
94+
9395
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.
9496

9597
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.

docs/play/add-games.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ When you install KNULLI on a SD card, several partitions will be created, which
88

99
!!! danger "You should never format the KNULLI partitions which Windows cannot read, no matter how strongly Windows suggests that."
1010

11-
The *BATOCERA* drive will be the only drive which was formatted to FAT32, to make it accessible on Windows. However, this is just the place where the operating system itself is stored, so it is not a place to store your games. You still might need access to the *BATOCERA* partition if you want to update KNULLI manually as described in the [update](../update) section.
11+
The *BATOCERA* drive will be the only drive formatted to FAT32, to make it accessible on Windows. However, this is just the place where the operating system itself is stored, so it is not a place to store your games. You still might need access to the *BATOCERA* partition if you want to update KNULLI manually as described in the [update](../update) section.
1212

1313
### The share partition
1414

@@ -90,9 +90,9 @@ As explained in the [Data storage structure](#data-storage-structure) section, t
9090

9191
#### Reformat the share partition to exFAT
9292

93-
It is possible to reformat the *SHARE* partition to exFAT, to make the partition accessible on Windows. Be aware that exFAT has some disadvantages regarding performance and is limited in the max size of its files. Consequently, some games, especially certain ports, will not run on a *SHARE* partition which is formatted to exFAT.
93+
!!! 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."
9494

95-
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.
95+
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.
9696

9797
#### Third party software
9898

docs/play/install.de.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Um KNULLI installieren zu können, musst du als erstes ein passendes Image für
99
* Stelle sicher, dass du das richtige Image für dein Gerät herunterlädst. Wenn du KNULLI z.B. auf einem [RG35XX](../../devices/anbernic/rg35xx) installieren möchtest, musst du das `rg45xx`-Image herunterladen.
1010
* Wenn unklar ist, welches Image für dein Gerät geeignet ist, kannst du im Abschnitt [Unterstützte Geräte](../../devices) überprüfen, welches Image du für dein Gerät herunterladen solltest.
1111

12+
!!! warning "Falls dein Gerät *nicht* ist der Liste der `Installation Package Downloads` enthalten ist, gibt es noch keine öffentlich zugängliche Releaseversion von Knulli für dein Gerät. Du solltest *nicht* versuchen, ein Installationspaket für ein anderes Gerät zu installieren."
13+
1214
## Schritt 2: Speicher flashen
1315

1416
* Entpacke zunächst das komprimierte Image (z.B. mit [7-Zip](https://7-zip.org/)).

docs/play/install.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ KNULLI is installed by downloading an image for your device, flashing it to an S
99
* Make sure to download the correct image for your device. For example; if you are installing KNULLI on a [RG35XX](../devices/anbernic/rg35xx.md) you would download the `rg35xx` image.
1010
* If you have any questions you can check the [Device Support](../devices/index.md) section to confirm which image you should download for your specific device.
1111

12+
!!! warning "If your device is *not* listed among the `Installation Package Downloads`, there is no public release of Knulli for your device, yet. You should *not* attempt to use a package for a different device."
13+
1214
## Step 2: Flash
1315

1416
* First decompress the image.

docs/systems/portmaster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The library is divided in two major categories:
1111
* Ports which are *"Ready to run"* are ports of free games which you can install and immediately start playing.
1212
* 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.
1313

14-
!!! 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."
14+
!!! info "Some PortMaster games only run on drives which are formatted to ext4. For this reason, KNULLI formats the *SHARE* partition to ext4 by default. However, if you re-formatted the *SHARE* partition to exFAT or if you use a second SD card which is formatted to exFAT, some PortMaster games might not work on your device. You will find information on how to reformat your drive to ext4 in the [Add Games](../../play/add-games) section."
1515

1616
## Installing PortMaster
1717

mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,8 @@ nav:
174174
- Configure:
175175
- Networking: configure/networking.md
176176
- SSH: configure/ssh.md
177+
- Retroarch:
178+
- Controls: configure/retroarch/controls.md
177179
- Systems:
178180
- Engines:
179181
- Pico-8: systems/pico-8.md

0 commit comments

Comments
 (0)