Skip to content

Commit fa8194d

Browse files
acmeplusacmeplus
authored
Merge pull request #27 from chrizzo-hb/main
Added section about bezels, updated FAQ
2 parents 9f1fd81 + 943fa91 commit fa8194d

12 files changed

+125
-16
lines changed

‎docs/configure/bezel-decorations.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# :material-image-frame: Bezel Decorations
2+
3+
KNULLI supports a lot of different emulators for a lot of different systems. Many of these systems originally had an aspect ratio that is different from the built-in screen of your KNULLI device. To fill the black void between the border of the screen and the game area, KNULLI supports using *decorations*, also referred to as *bezels* or *bezel decorations*.
4+
5+
!!! warning "Decorations only work with RetroArch cores"
6+
7+
KNULLI comes with a lot of different emulators. However, bezel decorations currently only work with RetroArch-integrated emulators (libretro cores).
8+
9+
## Mind the aspect ratio
10+
11+
Most bezel decorations are made for a **specific aspect ratio** of **16:9**, to provide a decoration for the void around the game when playing on a **TV screen**. However, if the screen of your handheld has a different aspect ratio, those bezels will **not** work on your device!
12+
13+
For example, the devices of Anbernic's RG35XX H/Plus/SP series have a 3.5" screen with an aspect ratio of **4:3**, hence, a lot of well-known bezel decoration packs which have been designed for 19:6 displays (e.g., The Bezel Project) will **not** work on the built-in screen of those devices.
14+
15+
### Bezel decorations for 4:3 displays
16+
17+
Even though most bezel decoration packs are specifically designed for 16:9 displays, there are a few options for 4:3 displays, too.
18+
19+
#### drkhrse/antiKk
20+
21+
Some bezels which were originally created by [drkhrse](https://github.com/drkhrse) and [antiKk](https://github.com/antiKk) have been adapted by [nvitaterna](https://github.com/nvitaterna) to work on Batocera-based handhelds with 4:3 displays. To install this set on your Knulli device
22+
23+
* download the bezel pack from the GitHub repository of nvitaterna, either by
24+
* visting the [GitHub repository](https://github.com/nvitaterna/batocera_4_3_handheld_bezels) and finding *Download ZIP* in the *Local* menu,
25+
* or just clicking [here](https://github.com/nvitaterna/batocera_4_3_handheld_bezels/archive/refs/heads/main.zip).
26+
* unzip the file (e.g. with [7-Zip](https://7-zip.org/)).
27+
* find the `batocera_4_3_handheld_bezels` folder **inside** the `decorations` folder you just unzipped.
28+
* copy the **entire** `batocera_4_3_handheld_bezels` folder into the `decorations` folder of your [userdata folder](../../play/add-games/game-storage).
29+
30+
The bezel pack should now be installed and ready to use. However, to apply it, you have to set it up as explained in the [Apply bezel decorations](#apply-bezel-decorations) section.
31+
32+
## Apply bezel decorations
33+
34+
If you want to apply bezel decorations, you can do this either globally, by system, or by game. Since game settings override system settings and system settings override global settings, it is possible to globally set a specific bezel pack and, at the same time, pick a different one for a specific system, or even just a single game.
35+
36+
!!! info "EmulationStation does the work for you"
37+
38+
You might be used to setting up bezels directly within RetroArch. On your KNULLI device, EmulationStation will take care of this for you. Do not attempt to set up bezel decorations from within RetroArch.
39+
40+
### Global bezel decorations
41+
42+
To apply a set of bezel decorations globally
43+
44+
* press ++"Start"++ on the home screen to bring up the main menu.
45+
* go to *Game Settings* and open *Decorations*.
46+
* select the *Decoration Set* of your choice.
47+
* leave the menu to apply the change.
48+
49+
### System bezel decorations
50+
51+
To apply a set of bezel decorations to a system
52+
53+
* press ++"Start"++ on the home screen to bring up the main menu.
54+
* go to *Game Settings* and open *Per System Advanced Configuration*.
55+
* select the system you want to apply the bezels to.
56+
* open *Decorations*.
57+
* select the *Decoration Set* of your choice. (*Auto* means to inherit global settings.)
58+
* leave the menu to apply the change.
59+
60+
### Game bezel decorations
61+
62+
To apply a set of bezel decorations to a single game
63+
64+
* find the game on your device by browsing your game lists.
65+
* **hold** the button that launches your games (usually ++"A"++ or ++"B"++).
66+
* go to *Advanced Game Options* and open *Decorations*.
67+
* select the *Decoration Set* of your choice. (*Auto* means to inherit global/system settings.)
68+
* leave the menu to apply the change.

‎docs/configure/networking.de.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
# Netzwerkverbindungen
1+
# :material-wifi: Netzwerkverbindungen
22

33
Viele Geräte, die von KNULLI unterstützt werden, sind in der Lage, sich mit dem Internet oder anderen lokalen Netzwerken zu verbinden. In den meisten Fällen geschieht dies über den eingebauten W-LAN-Adapter. Allerdings unterstützt KNULLI auch Netzwerkverbindungen über USB-Dongles.
44

55
## W-LAN
66

7+
!!! danger "WPA3-Probleme"
8+
9+
Einige Nutzer haben von Problemen berichtet, die entstanden sind, als sie ihr KNULLI-Gerät mit einem WPA3-geschützten W-LAN verbinden wollten. Falls du Probleme hast, mit deinem W-LAN zu verbinden, stelle sicher, dass es mit WPA2 und **nicht** mit WPA3 geschützt ist.
10+
711
Wenn dein Gerät einen eingebauten W-LAN-Adapter hat, kannst du ihn direkt via KNULLI konfigurieren. Öffne das Hauptmenü, in dem du den ++"Start"++-Button drückst, gehe zu *Network settings* und konfiguriere dort deine W-LAN-Verbindung. Im unteren Abschnitt *Settings* kannst du W-LAN aktivieren (*Enable WIFI*) und dein W-LAN ahand seiner SSID auswählen. Anschließend kannst du den W-LAN-Schlüssel eingeben und das Menü schließen, um mit dem W-LAN zu verbinden.
812

913
Im Abschnitt darüber kannst du sehen, ob du gerade mit einem W-LAN verbunden bist. Außerdem siehst du deine aktuelle IP-Adresse und kannst das Netzwerksymbol ein- oder ausschalten.
1014

11-
!!! warning "Standardmäßig ist in KNULLI kein root-Passwort gesetzt. Das bedeutet, dass deine Nutzerdaten-Partition sofort und ohne Passwortschutz zugreifbar ist, sobald du mit einem W-LAN verbindest. In den eigenen vier Wänden mag das ein praktisches Feature sein. Wenn du dein Gerät allerdings mit einem W-LAN verbindest, das nicht unter deiner Kontrolle ist, gehst du damit ein Sicherheitsrisiko ein."
15+
!!! warning "Passwortschutz"
16+
17+
Standardmäßig fragt KNULLI nicht nach einem Passwort, wenn man übers Netzwerk auf dein Gerät zugreift. Das bedeutet, dass deine Nutzerdaten-Partition sofort und ohne Passwortschutz zugreifbar ist, sobald du dein Gerät mit einem W-LAN verbindest. In den eigenen vier Wänden mag das ein praktisches Feature sein. Wenn du dein Gerät allerdings mit einem W-LAN verbindest, das nicht unter deiner Kontrolle ist, gehst du damit ein Sicherheitsrisiko ein. Wir empfehlen dringend, die Maßnahmen für **zusätzliche Sicherheit** zu ergreifen.
1218

1319
### Zusätzliche Sicherheit
1420

@@ -18,7 +24,9 @@ Wenn du die Sicherheitsmaßnahmen eingeschaltet und das Gerät neu gestartet has
1824

1925
Dieses Passwort, in Kombination mit dem Benutzernamen `root`, bildet die Zugangsdaten, mit denen auf dein Gerät via Netzwerk zugegriffen werden kann.
2026

21-
!!! warning "Dir sollte bewusst sein, dass KNULLI für Retro-Gaming und niedrigschwelligen Netzwerkzugang entwickelt wurde. Die erweiterten Sicherheitsmaßnahmen stellen eine zusätzliche Hürde da, um deine Nutzerdaten vor ungewollten Zugriffen zu schützen. Du solltest das Gerät trotzdem nicht mit einem W-LAN verbinden, von dem du nicht sicher bist, dass es sicher ist!"
27+
!!! warning "Fremde Netzwerke"
28+
29+
Dir sollte bewusst sein, dass KNULLI für Retro-Gaming und niedrigschwelligen Netzwerkzugang entwickelt wurde. Die erweiterten Sicherheitsmaßnahmen stellen eine zusätzliche Hürde da, um deine Nutzerdaten vor ungewollten Zugriffen zu schützen. Du solltest das Gerät trotzdem nicht mit einem W-LAN verbinden, von dem du nicht sicher bist, dass es sicher ist!
2230

2331
### Hostname
2432

‎docs/configure/networking.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
# Networking
1+
# :material-wifi: Networking
22

33
Many devices which are supported by KNULLI are capable of connecting to the internet as well as local networks. In most cases, this is achieved by a built-in Wi-Fi adapter. However, KNULLI also supports network connection via USB dongles.
44

55
## Wi-Fi
66

7+
!!! danger "WPA3 issues"
8+
9+
Some users experienced issues when connecting their device to a WPA3-protected Wi-Fi. If your device does not connect to your local Wi-Fi, make sure that it is protected with WPA2, **not** WPA3.
10+
711
If your device has a built-in Wi-Fi adapter, you can set it up directly via KNULLI. Press the ++"Start"++ button to open the main menu, go to *Network settings* where you can configure your Wi-Fi connection. In the lower *Settings* section, enable Wi-Fi, then select your Wi-Fi by its SSID, enter your Wi-Fi key, and leave the menu to connect to your Wi-Fi.
812

913
In the section above, you can see whether you are currently connected to Wi-Fi, see your current IP address and toggle the network indicator on or off.
1014

11-
!!! warning "By default, your KNULLI device does not have a root password set. Consequently, as soon as you connect to a network, the data on your device becomes accessible in your local network without any password protection. While this might be convenient within your own home, it might be a severe security risk when connecting to a network which is not under your control."
15+
!!! warning "Password protection"
16+
17+
By default, your KNULLI device does not require a root password to access your device. Consequently, as soon as you connect to a network, the data on your device becomes accessible in your local network without any password protection. While this might be convenient within your own home, it might be a severe security risk when connecting to a network which is not under your control. We strongly suggest to enable **additional security**.
1218

1319
### Additional security
1420

@@ -18,7 +24,9 @@ After you enabled additioal security and rebooted your device, return to the *Se
1824

1925
The password and the username `root` must now be used to access the device via network.
2026

21-
!!! warning "Be aware, that KNULLI is built for retro gaming and easy network access. While this setting will make it harder to access your userdata partition, you still should not connect your KNULLI-driven device to any unknown local networks."
27+
!!! warning "Unknown networks"
28+
29+
Be aware, that KNULLI is built for retro gaming and easy network access. While this setting will make it harder to access your userdata partition, you still should not connect your KNULLI-driven device to any unknown local networks.
2230

2331
### Hostname
2432

‎docs/configure/ppsspp/cheats.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cheats for PPSSPP
1+
# :material-auto-fix: Cheats for PPSSPP
22

33
The standalone PPSSPP emulator for PlayStation Portable (PSP) brings its own database of cheats which can be applied to your PSP games.
44

‎docs/configure/retroarch/controls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Modifying controls in RetroArch
1+
# :material-controller: Modifying controls in RetroArch
22

33
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.
44

‎docs/configure/ssh.de.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SSH
1+
# :material-console: SSH
22

33
Als fortgeschrittener Nutzer möchtest du möglicherweise auf die Kommandozeile (oder Shell) deines KNULLI-Gerätes zugreifen, um Linux-Befehle direkt eingeben zu können. KNULLI stellt dafür einen SSH-Zugang bereit. Es gibt viele verschiedene SSH-Clients, die du nutzen kannst, um Zugriff auf die Shell deines KNULLI-Gerätes zu erhalten. Für Windows-Nutzer empfehlen wir [SmarTTY](https://sysprogs.com/SmarTTY) oder [PuTTY](https://www.putty.org).
44

‎docs/configure/ssh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SSH
1+
# :material-console: SSH
22

33
As an advanced user, you might want to access the command line (or shell) of your KNULLI device to enter Linux commands directly. You may do so by connecting to KNULLI via SSH. There are several SSH clients available. For Windows users, we recommmend [SmarTTY](https://sysprogs.com/SmarTTY) or [PuTTY](https://www.putty.org).
44

‎docs/faq/troubleshooting.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,22 @@ A: If you have updated from an older version you may need to copy the ``batocera
5656
* If you use one single SD card, mount the second partition on your PC/Mac/Linux (``SHARE``) and copy the file to ``system/batocera.conf``
5757
* If you use two SD cards, mount the second SD card on your PC/Mac/Linux and copy the file to ``system/batocera.conf``
5858

59-
---
59+
---
60+
61+
### Q: When I try to open Retro Achievements, I get an error message with status code `419`, telling me I am not authorized. What can I do?
62+
63+
A: Nothing. But don't worry! If you see this message, it only means that your version of KNULLI does not support **displaying** your collected Retro Achievements, **yet**. However, it is still completely possible to **collect** Retro Achievements while playing! Just set up your Retro Achievements account as explained in the [Retro Achievements](../../play/retro-achievements) section and start hunting!
64+
65+
---
66+
67+
### Q: Why are bezel decorations not working on my KNULLI device?
68+
69+
A: Most bezel decorations are made for screens with an aspect ratio of 16:9. Consequently, those bezels do not work on a 4:3 display (like on the Anbernic RG35XX H/Plus/SP). To get bezel decorations working, find a bezel pack for 4:3 displays. You will find a detailed explanation (and a pointer to 4:3-compatible bezels) in the [Bezel Decorations](../../configure/bezel-decorations) section.
70+
71+
---
72+
73+
### Q: There seems to be some battery drain. What can I do?
74+
75+
A: Most likely, there is no battery drain. There is a bug in the algorithm which calculates and refreshes the estimated battery charge. Therefore, the displayed percentage is inaccurate. Do not worry about it, your battery is fine. Our developers are already working on a solution to give you a more precise battery charge indicator.
76+
77+
---

‎docs/play/add-games/second-sd-card.de.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# :material-layers-plus: Eine zweite SD-Karte verwenden
1+
# :material-micro-sd: Eine zweite SD-Karte verwenden
22

33
!!! danger "Important: Read this before you proceed!"
44

‎docs/play/add-games/second-sd-card.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# :material-layers-plus: Using a Second SD Card
1+
# :material-micro-sd: Using a Second SD Card
22

33
!!! danger "Important: Read this before you proceed!"
44

‎docs/play/retro-achievements.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
KNULLI has a native integration with [RetroAchievements](https://retroachievements.org/) which allows you to earn achievements as you play games across numerous emulators. In order to use RetroAchievements your device must be connected to the internet.
44

5+
!!! warning "Error 419"
6+
7+
It is currently not possible to access your collected *Retroachievements* from the main menu. There is a change needed on the RetroAchievements API in order to be able to display your history of earned achievements in EmulationStation. Once the needed change is made by RetroAchievements, we will re-enable this feature in EmulationStation.
8+
9+
However, even if you cannot **look** at your collected achievements, you can still **collect** achievements by following the steps below!
10+
511
## Setup
612

713
1. Create an account at [RetroAchievements.org](https://retroachievements.org/).
@@ -18,4 +24,3 @@ KNULLI has a native integration with [RetroAchievements](https://retroachievemen
1824
- Unlock Sound (++"On"++): this plays the classic unlock sound each time an achievement is earned.
1925
- Automatic Screenshot (++"On"++): this takes a screenshot each time an achievement is earned and stores it in the screenshots directory. These can be viewed in the screenshots system in EmulationStation.
2026
- Not all emulators and games support RetroAchievements; please see the list of emulators that support achievements [here](https://docs.retroachievements.org/Emulator-Support-and-Issues/) and check if your game has achievements available by searching for it on RetroAchievements.org
21-
- There is a change needed on the RetroAchievements API in order to be able to display to display your history of earned achievements in EmulationStation. Once the needed change is made by RetroAchievements; we can look at renabling this functionality in EmulationStation.

‎mkdocs.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ plugins:
137137
Configure: Konfiguration
138138
Networking: Netzwerkverbindungen
139139
Unbranded: Ohne Marke
140+
Bezel Decorations: Bezel-Dekorationen
140141
- locale: pl
141142
name: Polski
142143
build: true
@@ -171,14 +172,14 @@ plugins:
171172
nav:
172173
- Home: index.md
173174
- FAQs:
174-
- faq/index.md
175+
- FAQs: faq/index.md
175176
- About KNULLI: faq/knulli.md
176177
- Troubleshooting: faq/troubleshooting.md
177178
- Play:
178179
- Quick Start Guide: play/quick-start.md
179180
- Install: play/install.md
180181
- Add Games:
181-
- play/add-games/index.md
182+
- Add Games: play/add-games/index.md
182183
- Game Storage: play/add-games/game-storage.md
183184
- Network Transfer: play/add-games/network-transfer.md
184185
- Accessing SD Card: play/add-games/accessing-ext4.md
@@ -193,6 +194,7 @@ nav:
193194
- Networking: configure/networking.md
194195
- Controls: configure/controls.md
195196
- Collections: configure/collections.md
197+
- Bezel Decorations: configure/bezel-decorations.md
196198
- Themes: configure/themes.md
197199
- SSH: configure/ssh.md
198200
- Retroarch:

0 commit comments

Comments
 (0)