Skip to content

Commit 79982ac

Browse files
acmeplusacmeplus
authored
Merge pull request #17 from chrizzo-hb/main
Restructured FAQ, removed dated translations, added section about hotkeys
2 parents 898c72e + 2d1c876 commit 79982ac

16 files changed

+315
-429
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/.project
2+
/Pipfile.lock
3+
/*.bat

‎docs/_inc/images/face-buttons.png

68.2 KB
Loading

‎docs/faq/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# :material-frequently-asked-questions: Frequently Asked Questions
2+
3+
* [Frequently asked questions about KNULLI](knulli)
4+
* [Frequently asked questions about troubleshooting](troubleshooting)

‎docs/faq/knulli.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# :material-frequently-asked-questions: FAQ: About KNULLI
2+
3+
### Q: What is KNULLI?
4+
A: KNULLI is a fork of [Batocera](https://batocera.org). It tries to provide support for devices that fall under at least one of these two categories:
5+
6+
* There are no open source kernel and/or u-boot sources available
7+
* There are sources, but the kernel is either not mainline, and/or too old (e.g. devices with a BSP kernel 3.4 like the Egret II Mini)
8+
* It's a device that I own and I have decided to create a Custom Firmware for it
9+
10+
---
11+
12+
### Q: OK, so why a fork and not merge the changes back to Batocera?
13+
14+
A: Because the license of Batocera does not allow for closed sourced kernels to be added to the distribution.
15+
16+
---
17+
18+
### Q: Are there any other differences?
19+
20+
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.
21+
22+
---
23+
24+
### Q: Do you know what the word "Knulli" means in Swedish?
25+
26+
A: Yes, we do. 😃
27+
28+
---
29+
30+
### Q: Where can I download the latest version?
31+
32+
A: 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.
33+
34+
---
35+
36+
### Q: Which devices are supported?
37+
38+
A: 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.
39+
40+
---
41+
42+
### Q: Do I have to flash every release or can I update?
43+
44+
A: For most of the releases you can update:
45+
* Download the boot.tar.xz file from the releases page
46+
* Extract its content
47+
* Mount your KNULLI SDCARD on your PC/Mac/Linux computer
48+
* Delete the file ``boot/knulli`` (you can make a backup of this file on your computer in case you want to revert to the previous version)
49+
* Copy the contents of the extracted boot.tar.xz to the SDCARD
50+
51+
---
52+
53+
### Q: Do you support X device? Will you add support for X device?
54+
55+
A: You can find the list of currently supported devices here: [Devices](../devices)
56+
57+
If the device you are interested in isn't in that list then no one has contributed the work to add support for it yet. Why? To add support for a device we (1) need to be interested in adding support for it 😊 and (2) need to have direct access to the device.
58+
59+
That said, anyone who is interested can submit updates to KNULLI to add support for a device they care about! If you are interested in adding support for a new device please start here: [Contribute](../contribute)
60+
61+
---
62+
63+
### Q: Is it possible to license KNULLI for redistribution?
64+
65+
A: KNULLI utilizes a non-commercial CC BY-NC-SA 4.0 copyleft license on our branding which is intended to prevent abuse of our work. Device Makers and others who would like to bundle on devices may not do so without our express permission.
66+
67+
---
68+
69+
### Q: Can I sell KNULLI?
70+
71+
A: The KNULLI brand is licensed for non-commercial use only. It is not allowed to be sold or included as an up charge in any form what-so-ever. Period. This is not negotiable.
72+
73+
---

‎docs/faq/knulli.tr.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# :material-frequently-asked-questions: KNULLI Hakkında
2+
3+
### S: KNULLI nedir?
4+
C: KNULLI, retro oyun cihazları için özel bir firmware'dir (elde taşınabilirler, masaüstü emülasyon cihazları vb.). [Batocera](https://batocera.org)'nın bir fork'u olarak geliştirilmiştir. Knulli aşağıdaki kategoriler altındaki cihazları desteklemeye çalışmaktadır:
5+
6+
* Açık kaynaklı kernel ve/veya u-boot kaynakları olmayan cihazlar
7+
* Kaynağı olan ancak kerneli ana akım olmayan ve/veya çok eski olan cihazlar (örneğin, Egret II Mini gibi BSP kernel 3.4'e sahip olan cihazlar)
8+
* GPU desteği olmayan veya desteklenmeyen GPU'ya sahip ve bu yüzden framebuffer'in tek seçenek olduğu cihazlar
9+
* Sahip olduğum bir cihaz için özelleştirilmiş firmware (CFW) oluşturmaya karar verdim
10+
11+
---
12+
13+
### S: Peki, bu neden bir fork ve değişiklikleri batocera'ya geri birleştirmiyorsunuz?
14+
C: Çünkü batocera lisansı, kapalı kaynaklı çekirdeklerin dağıtıma eklenmesine izin vermez.
15+
16+
---
17+
18+
### S: Başka farklar var mı?
19+
C: Hedef, batocera ile uyumluluğu sürdürmek olsa da, düşük güçlü cihazlar veya cihazların performansını etkileyen bazı özelliklerden fayda sağlamayan cihazlar üzerinde odaklanmaktır. Örneğin, düşük belleğe sahip cihazlar (Powkiddy A12/A13 veya RG35XX Classic gibi 256MB). Ayrıca, [JelOS](https://jelos.org)/[Rocknix](https://github.com/rocknix), [EmuELEC](https://github.com/EmuELEC) vb. mevcut özellikleri eklemek isteme niyeti de bulunmaktadır.
20+
21+
### S: En son sürümü nereden indirebilirim
22+
23+
C: İndirmeler bölümünü kontrol edin (Daha sonra eklenecektir)
24+
25+
---
26+
27+
### S: Hangi cihazlar destekleniyor?
28+
29+
C: Desteklenen cihazların listesini kontrol edin
30+
31+
---
32+
33+
### S: X cihazını destekliyor musunuz? X cihazı için destek ekleyecek misiniz?
34+
C: Şu anda desteklenen cihazların listesini burada bulabilirsiniz: [Cihazlar](../devices)
35+
36+
Eğer ilgilendiğiniz cihaz bu listede yoksa, henüz hiç kimse onun için destek eklememiştir demektir. Peki neden? Bir cihaz için destek eklemek için (1) onu eklemek istememiz gerekmekte 😊 ve (2) cihaza doğrudan erişimimizin olması gerekmektedir.
37+
38+
Ancak, ilgilenen herkes KNULLI'ye bir cihaz için destek ekleyebilir! Eğer yeni bir cihaz için destek eklemek istiyorsanız lütfen buradan başlayın: [Katkıda Bulunmak](../contribute)
39+
40+
---
41+
42+
### KNULLI'nin yeniden dağıtım lisansı
43+
C: KNULLI, işimizin kötüye kullanılmasını önlemek için ticari olmayan CC BY-NC-SA 4.0 kopya hakkı lisansı (copyleft license) kullanıyor. Cihaz üreticileri ve diğerleri, bizim açık iznimiz olmadan cihazlarında bunu paketleyemezler.
44+
45+
---
46+
47+
##### KNULLI'nin Satışı
48+
KNULLI markası sadece ticari olmayan kullanım için lisanslanmıştır. Satılmak veya herhangi bir şekilde ücret eklenmek kesinlikle yasaktır. Bu tartışmaya kapalıdır.

‎docs/faq/troubleshooting.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# :material-frequently-asked-questions: FAQ: Troubleshooting
2+
3+
### Q: I want to add my own ROMs to the SD card but my Windows/Mac computer can't see the roms partition - what can I do?
4+
5+
A: By default KNULLI formats the second partition with the ext4 filesystem for Linux. That format is typically
6+
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.
7+
8+
---
9+
10+
### Q: Can I use a second SD card for my roms/bios content?
11+
12+
A: Yes! if you have a new or empty SDCARD you can insert the SDCARD on the second slot of the RG35XX and follow these steps:
13+
14+
* Boot KNULLI and go to ``Settings -> System Settings -> Storage Device`` and change it from ``INTERNAL`` to your second card, e.g. ``SHARE - 25.6G``.
15+
* Exit the settings menu and the system will indicate you need to reboot to get the changes applied.
16+
* Go to the menu ``Settings -> Quit -> Restart System`` to reboot. The system will reboot and the second card will be now used for batocera and the folder structure (roms, bios, etc.) will be created.
17+
* You can now shutdown the console, insert the card on your computer, and copy your bios & roms content.
18+
19+
---
20+
21+
### Q: I would like to try muOS and KNULLI - is it possible to have the same second SD card for both CFWs to share my games between them?
22+
23+
A: KNULLI requires all the ROMs to be in the respective subfolders of the emulated system, e.g., `roms/snes` for SNES ROMs. If you populate your SD card the KNULLI way (see [Add Games](../../play/add-games) section for details), it will be possible to configure your muOS to take the ROMs from these folders, which will enable you to use the same second SD card for your ROMs in both CFWs.
24+
25+
---
26+
27+
### Q: I have Garlic with my ROMs/BIOSes on the second SD card. Is it possible to reuse that card for KNULLI?
28+
29+
A: By default KNULLI expects a different name for the ROM folders and their location, but thanks to @XQuader there's a script that creates the compatible configuration for KNULLI based on the Garlic structure. You can read more about it on [this Reddit post](https://www.reddit.com/r/RG35XX/comments/12zxs8t/how_to_get_garlicos_roms_folders_working_in/).
30+
31+
---
32+
33+
### Q: The installation seems to be running, I can see it's expanding the partition but it's taking too long
34+
35+
A: Expanding and booting the first time with a 64GB SDCARD takes about 1 to 1:30 minutes. If your SDCARD is larger it may take much longer, however, if it goes beyond 5 minutes, chances are that something didn't go well. Just press reset and the system will continue. If that's the case, the partition may have not been expanded. For that you will need to manually expand the card on your PC/Mac/Linux.
36+
37+
---
38+
39+
### Q: I've installed KNULLI or updated to the latest version and my controls don't respond as expected - what can I do?
40+
41+
A: For some devices, especially those which share a common installation image (e.g., the RG35XX H/Plus/SP series), it might be required to manually map the controls after the first installation. To do that, follow the instructions in the [Control](../../configure/controls) section.
42+
43+
---
44+
45+
### Q: I cannot connect to my Wi-Fi even though my device has a wireless network adapter - what can I do?
46+
47+
A: Make sure that your router is set to WPA2. Some users experience connection issues with Wi-Fis which are set to WPA3.
48+
49+
---
50+
51+
### Q: I've installed/updated to the latest version and I don't have audio, or my controls don't respond, or something else is not working as expected:
52+
53+
A: If you have updated from an older version you may need to copy the ``batocera.conf`` from the releases page to your SD card:
54+
* 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``
55+
* If you use two SD cards, mount the second SD card on your PC/Mac/Linux and copy the file to ``system/batocera.conf``
56+
57+
---

‎docs/faqs.tr.md ‎docs/faq/troubleshooting.tr.md

+1-50
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,5 @@
11
# :material-frequently-asked-questions: Sıkça Sorulan Sorular
22

3-
## KNULLI Hakkında
4-
5-
### S: KNULLI nedir?
6-
C: KNULLI, retro oyun cihazları için özel bir firmware'dir (elde taşınabilirler, masaüstü emülasyon cihazları vb.). [Batocera](https://batocera.org)'nın bir fork'u olarak geliştirilmiştir. Knulli aşağıdaki kategoriler altındaki cihazları desteklemeye çalışmaktadır:
7-
8-
* Açık kaynaklı kernel ve/veya u-boot kaynakları olmayan cihazlar
9-
* Kaynağı olan ancak kerneli ana akım olmayan ve/veya çok eski olan cihazlar (örneğin, Egret II Mini gibi BSP kernel 3.4'e sahip olan cihazlar)
10-
* GPU desteği olmayan veya desteklenmeyen GPU'ya sahip ve bu yüzden framebuffer'in tek seçenek olduğu cihazlar
11-
* Sahip olduğum bir cihaz için özelleştirilmiş firmware (CFW) oluşturmaya karar verdim
12-
13-
---
14-
15-
### S: Peki, bu neden bir fork ve değişiklikleri batocera'ya geri birleştirmiyorsunuz?
16-
C: Çünkü batocera lisansı, kapalı kaynaklı çekirdeklerin dağıtıma eklenmesine izin vermez.
17-
18-
---
19-
20-
### S: Başka farklar var mı?
21-
C: Hedef, batocera ile uyumluluğu sürdürmek olsa da, düşük güçlü cihazlar veya cihazların performansını etkileyen bazı özelliklerden fayda sağlamayan cihazlar üzerinde odaklanmaktır. Örneğin, düşük belleğe sahip cihazlar (Powkiddy A12/A13 veya RG35XX Classic gibi 256MB). Ayrıca, [JelOS](https://jelos.org)/[Rocknix](https://github.com/rocknix), [EmuELEC](https://github.com/EmuELEC) vb. mevcut özellikleri eklemek isteme niyeti de bulunmaktadır.
22-
23-
### S: En son sürümü nereden indirebilirim
24-
25-
C: İndirmeler bölümünü kontrol edin (Daha sonra eklenecektir)
26-
27-
---
28-
29-
### S: Hangi cihazlar destekleniyor?
30-
31-
C: Desteklenen cihazların listesini kontrol edin
32-
33-
---
34-
353
### S: Kendi romlarımı eklemek istiyorum ama Windows/Mac bilgisayarım "roms" disk bölümünü göremiyor
364

375
C: KNULLI varsayılan olarak ikinci disk bölümünü Linux EXT4 dosya biçimi ile biçimlendirir. Bu biçim genellikle Windows/Mac altında okunamaz/bağlanamaz. Bunun için aşağıdaki yaklaşımlardan birini kullanmanız gerekmektedir:
@@ -95,21 +63,4 @@ C: Çoğu sürüm için güncelleyebilirsiniz:
9563
A: Şu anda Drastic, NDS romları için en iyi emülatördür. Ancak, romları doğrudan NDS romları menüsünden başlatmak desteklenmiyor. Drastic'i portlar menüsünden başlatmak için [bu GitHub sorununa](https://github.com/rg35xx-cfw/rg35xx-cfw.github.io/issues/25#issuecomment-1526845570) bakın. Betik romlar/ports'a eklendikten sonra, bağımsız drastic emülatörünü başlatabilir ve ardından romlarınızı bulmak için ``/userdata/roms/nds`` dizinine gidebilirsiniz. Romların .nds formatında sıkıştırılmamış olması gerektiğini unutmayın.
9664
Desmume ve melonds da çalışıyor ancak performansı Drastic ile kıyaslandığında çok iyi değil.
9765

98-
---
99-
100-
### S: X cihazını destekliyor musunuz? X cihazı için destek ekleyecek misiniz?
101-
C: Şu anda desteklenen cihazların listesini burada bulabilirsiniz: [Cihazlar](../devices)
102-
103-
Eğer ilgilendiğiniz cihaz bu listede yoksa, henüz hiç kimse onun için destek eklememiştir demektir. Peki neden? Bir cihaz için destek eklemek için (1) onu eklemek istememiz gerekmekte 😊 ve (2) cihaza doğrudan erişimimizin olması gerekmektedir.
104-
105-
Ancak, ilgilenen herkes KNULLI'ye bir cihaz için destek ekleyebilir! Eğer yeni bir cihaz için destek eklemek istiyorsanız lütfen buradan başlayın: [Katkıda Bulunmak](../contribute)
106-
107-
---
108-
109-
### KNULLI'nin yeniden dağıtım lisansı
110-
C: KNULLI, işimizin kötüye kullanılmasını önlemek için ticari olmayan CC BY-NC-SA 4.0 kopya hakkı lisansı (copyleft license) kullanıyor. Cihaz üreticileri ve diğerleri, bizim açık iznimiz olmadan cihazlarında bunu paketleyemezler.
111-
112-
---
113-
114-
##### KNULLI'nin Satışı
115-
KNULLI markası sadece ticari olmayan kullanım için lisanslanmıştır. Satılmak veya herhangi bir şekilde ücret eklenmek kesinlikle yasaktır. Bu tartışmaya kapalıdır.
66+
---

0 commit comments

Comments
 (0)