Skip to content

Commit c26a41c

Browse files
authored
Merge pull request #65 from t0b10-r3tr0/main
Reviewed and updated spelling/grammar on most of the documentation.
2 parents 81272b1 + a1b1c01 commit c26a41c

19 files changed

+89
-90
lines changed

docs/configure/bluetooth.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ After your devices have been paired successfully, you might need to take additio
2020

2121
### Set up audio output
2222

23-
After pairing an audio output device (like a headphone), you need to set it as your audio output. Press ++"Start"++ to bring up the main menu, head to *System Settings* and choose your Blueooth device as *Audio output*.
23+
After pairing an audio output device (like a headphone), you need to set it as your audio output. Press ++"Start"++ to bring up the main menu, head to *System Settings* and choose your Bluetooth device as *Audio output*.
2424

2525
## Forget a Bluetooth device
2626

docs/configure/collections.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# :material-collage: Collections
22

3-
In addition to the systems displayed; EmulationStation (ES) has functionality to create custom collections that you can use to group and organize your game library in different ways. For example; if you wanted to create a view that automatically grouped all of your Role Playing Games or one that only lists the games you are currently playing you can use ES collections to do that.
3+
In addition to the systems displayed, EmulationStation (ES) has functionality to create custom collections that you can use to group and organize your game library in different ways. For example; if you wanted to create a view that automatically grouped all of your Role-Playing Games or one that only lists the games you are currently playing you can use ES collections to do that.
44

55
All of the options described below can be managed by pressing ++"START"++ anywhere in ES to open the Main Menu and then opening ++"Game Collection Settings"++
66

@@ -17,7 +17,7 @@ Knulli includes a `Now Playing` collection that can be used to curate and play t
1717
</tr>
1818
</table>
1919

20-
Once its turned on; you can add to it by pressing ++"X(NORTH)"++ on any game while in ES. In the menu that opens you'll see `Now Playing` listed under the collections header. Simply highlight it and press the confirm button.
20+
Once it's turned on, you can add to it by pressing ++"X(NORTH)"++ on any game while in ES. In the menu that opens you'll see `Now Playing` listed under the collections header. Simply highlight it and press the confirm button.
2121

2222
You can also set Knulli to boot directly into the Now Playing collection by setting the `Start on System` value in the `Game Collection Settings` menu. Change that value to `Now Playing` and also turn on `Start on Gamelist`.
2323

@@ -33,11 +33,11 @@ EmulationStation has a set of built-in automated collections to easily view your
3333

3434
### Editable Collections
3535

36-
An editable collection is one that you can specifically curate by hand. Simply give it a name and then as you are browing your gamelists you can press ++"X(NORTH)"++ on any game and add it to the collection you created. As an example, you could use this functionality to create a collection for all of your Final Fantasy games and then manually add each FF game to the list.
36+
An editable collection is one that you can specifically curate by hand. Simply give it a name and then as you are browsing your gamelists you can press ++"X(NORTH)"++ on any game and add it to the collection you created. As an example, you could use this functionality to create a collection for all of your Final Fantasy games and then manually add each FF game to the list.
3737

3838
### Dynamic Collections
3939

40-
A dynamic collection enables you to create a set of filters that will automatically group your games. For example if you wanted to create a collection that automatically grouped all of your Role Playing Games into a single view; you could create a dynamic collection called RPGs, select a genre filter of Role Playing Games and then save the filter. Then any time you add a new game with the Role Playing genre it will automatically show up in this collection.
40+
A dynamic collection enables you to create a set of filters that will automatically group your games. For example if you wanted to create a collection that automatically grouped all of your Role-Playing Games into a single view; you could create a dynamic collection called RPGs, select a genre filter of Role-Playing Games and then save the filter. Then any time you add a new game with the Role-Playing genre it will automatically show up in this collection.
4141

4242
<table>
4343
<tr>
@@ -54,4 +54,4 @@ A dynamic collection enables you to create a set of filters that will automatica
5454

5555
## Additional Notes
5656

57-
You can also use the ++"Game Collection Settings"++ menu to manage which systems are displayed. Press ++"START"++ anywhere in ES to open the Main Menu and then go to ++"Game Collection Settings"++ > ++"Systems Displayed"++. In this menu; uncheck the systems you would like to hide and then exit the menu. ES will then refresh and those systems will be hidden.
57+
You can also use the ++"Game Collection Settings"++ menu to manage which systems are displayed. Press ++"START"++ anywhere in ES to open the Main Menu and then go to ++"Game Collection Settings"++ > ++"Systems Displayed"++. In this menu, uncheck the systems you would like to hide and then exit the menu. ES will then refresh and those systems will be hidden.

docs/configure/controls.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ Press ++"Start"++ to open the main menu and head to *Controller & Bluetooth Sett
2626

2727
!!! info "Controller assignments are reset after reboot"
2828

29-
Your KNULLI device does not memorize, which controller was assigned to which player in a previous session. Make sure to always assign all controllers to the corresponding players after you (re-)connected them to your KNULLI device.
29+
Your KNULLI device does not memorize which controller was assigned to which player in a previous session. Make sure to always assign all controllers to the corresponding players after you (re-)connected them to your KNULLI device.
3030

3131
## Controller mapping
3232

3333
!!! danger "Do not attempt to remap the built-in controls"
3434

35-
Each KNULLI build is **optimized** for the specific device it was designed for. Specificially, all built-in controls are **already mapped** for you. Do **not** attempt to remap the built-in controls in the *Controller & Bluetooth Settings* menu. By doing so, you might **break** any hidden virtual controls (e.g. the **D-pad-to-virtual-stick mapping** for devices without analog sticks, which usually can be toggled with ++"Function"+++++"Select"++). If you want to remap controls for certain *games* or *systems*, please do it within the respective game or emulator settings. The *Controller & Bluetooth Settings* menu is **not** the right place to map game- or system-specific controls!
35+
Each KNULLI build is **optimized** for the specific device it was designed for. Specifically, all built-in controls are **already mapped** for you. Do **not** attempt to remap the built-in controls in the *Controller & Bluetooth Settings* menu. By doing so, you might **break** any hidden virtual controls (e.g. the **D-pad-to-virtual-stick mapping** for devices without analog sticks, which usually can be toggled with ++"Function"+++++"Select"++). If you want to remap controls for certain *games* or *systems*, please do it within the respective game or emulator settings. The *Controller & Bluetooth Settings* menu is **not** the right place to map game- or system-specific controls!
3636

37-
To map the buttons and directional inputs of a controller, press the ++"Start"++ button to bring up the main menu, find *Controller & Bluetooth Settings* and select *Controller Mapping*. On-screen instructions will ask you to hold a button on the controller you want to map. Once the controller was detected, you will be guided through the process: Simply press the button on your controller which corresponds best to the button/function displayed on screen.
37+
To map the buttons and directional inputs of a controller, press the ++"Start"++ button to bring up the main menu, find *Controller & Bluetooth Settings* and select *Controller Mapping*. On-screen instructions will ask you to press and hold a button on the controller you want to map. Once the controller was detected, you will be guided through the process: Simply press the button on your controller which corresponds best to the button/function displayed on screen.
3838

3939
If you press a wrong button, don't worry: You will always be able to return to this menu and remap the controller again.
4040

docs/configure/customization/background-music.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Your [userdata folder](../../../play/add-games/game-storage) contains a folder c
44

55
!!! info "Make sure your music files are compatible"
66

7-
Background music for KNULLI/EmulationStation should be in `MP3` or `OGG` format and have a sample rate of 44100Hz and a bitrate of 256kb/s max.
7+
Background music for KNULLI/EmulationStation should be in `MP3` or `OGG` format and have a sample rate of 44100Hz and a bit rate of 256kb/s max.
88

99
When adding your background music, you can either dump all your songs randomly into the `music` folder or create subfolders for each **system** if you want to add **system-specific music** for all the systems you like to play. If you want to add your music per system, you should **not** leave any music files in the top level of the `music` folder but sort all your music **by system**. The system names in the `music` folder correspond to the system names in the `roms` folder (e.g., `snes` for SNES, `megadrive` for Mega Drive/Genesis).
1010

docs/configure/customization/bezel-decorations.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ Even though most bezel decoration packs are specifically designed for 16:9 displ
2121
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
2222

2323
* 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,
24+
* visiting the [GitHub repository](https://github.com/nvitaterna/batocera_4_3_handheld_bezels) and finding *Download ZIP* in the *Local* menu,
2525
* or just clicking [here](https://github.com/nvitaterna/batocera_4_3_handheld_bezels/archive/refs/heads/main.zip).
2626
* unzip the file (e.g. with [7-Zip](https://7-zip.org/)).
2727
* find the `batocera_4_3_handheld_bezels` folder **inside** the `decorations` folder you just unzipped.
2828
* copy the **entire** `batocera_4_3_handheld_bezels` folder into the `decorations` folder of your [userdata folder](../../../play/add-games/game-storage).
2929

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.
30+
The bezel pack should now be installed and ready to use. However, to apply it, you must set it up as explained in the [Apply bezel decorations](#apply-bezel-decorations) section.
3131

3232
## Apply bezel decorations
3333

docs/configure/customization/themes.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The following options can be changed directly from the main menu under `User Int
2525
| Aspect Ratio | Enables you to select the correct aspect ratio for your screen. This will automatically set itself so you should not need to change it but if the theme layout looks odd or spacing looks incorrect you can use this setting to make sure the aspect ratio matches your screen. | `16:9`, `16:10`, `4:3`, `3:2`, `1:1` |
2626
| System Artwork | Defines the set of artwork that is displayed on the system view | `Default`, `Noir`, `Custom`, `Custom (Fullscreen)` |
2727
| System Logos | Defines the logo set used on all views | `Default`, `Custom` |
28-
| Game Artwork | Defines the type of artwork used to represent a game. These are sourced from the the selections you make in the scraper menu. Image will display the image you selected to scrape for `Image Source`. Image (Cropped) will display that same image zoomed in to fill the screen. Boxart will display the image you selected to scrape for `Box Source` | `Image`, `Image (Cropped)`, `Boxart` |
28+
| Game Artwork | Defines the type of artwork used to represent a game. These are sourced from the selections you make in the scraper menu. Image will display the image you selected to scrape for `Image Source`. Image (Cropped) will display that same image zoomed in to fill the screen. Boxart will display the image you selected to scrape for `Box Source` | `Image`, `Image (Cropped)`, `Boxart` |
2929
| Game Metadata | Sets if metadata (e.g. description, release date, etc...) should be displayed for a game | `On`, `Off` |
3030
| Font Size | Set the size for text elements throughout the theme. | `Default`, `Small`, `Large` |
3131
| Color Scheme | Sets the color scheme that is used for the theme. There is a set of prebuilt color schemes that you can select and an option to supply your custom color scheme (selected by choosing `custom`). You can see details on customizations below under [Customization](#customization). | `Default`, `Light`, `Steam OS`, `SNES`, `Famicom`, `DMG`, `OLED`, `Custom` |
@@ -61,9 +61,9 @@ The artwork used on the system view can be customized with your own images.
6161
* They can be named:
6262
* `_default.png`
6363
* `${system.theme}.png`
64-
* The theme will look them them up in that order. If a given image is not found in your folder then the the images from the theme will be used as a fallback. This allows you to customize only the images you want and still have images displayed for all systems.
64+
* The theme will look them up in that order. If a given image is not found in your folder then the images from the theme will be used as a fallback. This allows you to customize only the images you want and still have images displayed for all systems.
6565
* `_default.png` can be used for creating a single image that is used for all systems OR a fallback for systems that you did not create a custom image for (if you don't want to use the fallback that already exists in the theme)
66-
* `${system.theme}.png` should be named for the system you are looking to override. For example if you wanted to override the artwork for `snes` you would create an image called `snes.png` in the artwork folder.
66+
* `${system.theme}.png` should be named for the system you are looking to override. For example, if you wanted to override the artwork for `snes` you would create an image called `snes.png` in the artwork folder.
6767
* Once your images are in place you turn on custom images by changing the `System Artwork` setting to `Custom`
6868

6969
#### For fullscreen artwork:
@@ -75,9 +75,9 @@ The artwork used on the system view can be customized with your own images.
7575
* `_default.jpg`
7676
* `${system.theme}.png`
7777
* `${system.theme}.jpg`
78-
* The theme will look them them up in that order.
78+
* The theme will look them up in that order.
7979
* `_default.png/jpg` can be used for creating a single image that is used for all systems OR a fallback for systems that you did not create a custom image for (if you don't want to use the fallback that already exists in the theme)
80-
* `${system.theme}.png/jpg` should be named for the system you are looking to override. For example if you wanted to override the artwork for `snes` you would create an image called `snes.png` or `snes.jpg` in the artwork folder.
80+
* `${system.theme}.png/jpg` should be named for the system you are looking to override. For example, if you wanted to override the artwork for `snes` you would create an image called `snes.png` or `snes.jpg` in the artwork folder.
8181
* Once your images are in place you turn on custom images by changing the `System Artwork` setting to `Custom (Fullscreen)`
8282

8383
#### Splash Screen
@@ -95,7 +95,7 @@ You can create your own custom color scheme to use for the theme
9595
* Download [this template](https://github.com/anthonycaccese/art-book-next-es/blob/main/resources/customizations/colors.xml)
9696
* Upload it in the path you created above and make sure its called `colors.xml`
9797
* Change any values in the template to the colors you prefer.
98-
* I tried to make the values as self explanatory as possible but if you have questions regarding which property does what please don't hesitate to ask.
98+
* I tried to make the values as self-explanatory as possible but if you have questions regarding which property does what please don't hesitate to ask.
9999
* After your colors are defined; in theme configuration change `Color Scheme` to `Custom`
100100

101101
### Logos
@@ -107,8 +107,8 @@ System logos can be customized by adding your own images
107107
* They can be named:
108108
* `${system.theme}.svg`
109109
* `${system.theme}.png`
110-
* The theme will look them them up in that order. If a given image is not found in your folder then the the images from the theme will be used as a fallback. This allows you to customize only the images you want and still have images displayed for all systems.
111-
* `${system.theme}.svg/png` should be named for the system you are looking to override. For example if you wanted to override the logo for `snes` you would create an image called `snes.svg` or `snes.png` in the logos folder.
110+
* The theme will look them up in that order. If a given image is not found in your folder then the images from the theme will be used as a fallback. This allows you to customize only the images you want and still have images displayed for all systems.
111+
* `${system.theme}.svg/png` should be named for the system you are looking to override. For example, if you wanted to override the logo for `snes` you would create an image called `snes.svg` or `snes.png` in the logos folder.
112112
* Once your images are in place you turn on custom images by changing the `System Logos` setting to `Custom`
113113

114114
## Adding Additional Themes
@@ -121,4 +121,4 @@ System logos can be customized by adding your own images
121121

122122
## Creating Your Own Theme
123123

124-
An exhaustive tutorial is out of scope for this wiki. That said; please see Batocera's theme documention @ [https://wiki.batocera.org/write_themes_for_emulationstation](https://wiki.batocera.org/write_themes_for_emulationstation). Its a great starter guide for understanding the fundamentals of creating themes for the version of EmulationStation used by Knulli.
124+
An exhaustive tutorial is out of scope for this wiki. That said; please see Batocera's theme documentation @ [https://wiki.batocera.org/write_themes_for_emulationstation](https://wiki.batocera.org/write_themes_for_emulationstation). Its a great starter guide for understanding the fundamentals of creating themes for the version of EmulationStation used by Knulli.

0 commit comments

Comments
 (0)