wbrawner/jelos.org
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add Games and Networking documentation

Browse source
This commit is contained in:
anthonycaccese 2023-10-08 22:44:25 -04:00
parent e56b27a8a4
commit 635160e194
7 changed files with 98 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/configure/cloud-sync.md
View file

@ -1,4 +1,4 @@
# Cloud Sync
# :material-cloud-sync: Cloud Sync
JELOS has built in support for multiple cloud sync options. These can be used to sync save files, games and other files between multiple devices.

21
docs/configure/networking.md Normal file
View file

@ -0,0 +1,21 @@
# :material-wifi-plus: Networking
Networking can be set up on any device that can connect to the internet (this includes devices with native networking capabilites and ones where networking can be added through an external dongle).
With networking turned on you do things such as [add games](../../play/add-games), [update JELOS](../../play/update), [netplay across devices](../../play/netplay), [cloud sync](../cloud-sync), [play over VPN](../vpn) and access RetroAchievements.
## Setup
1. While in EmulationStation press ++"START"++ on your controller to open the Main Menu.
2. Navigate to and select `Network Settings`.
3. Under the Network Configuration header turn on `Enable Network`.
4. Then select `WIFI SSID` and choose your network name.
5. Finally enter your password under `WIFI Key` using the onscreen keyboard.
When you exit the network settings menu your network should activiate.
## Additional Settings
- If you want to transfer games over the network make sure to turn enable SSH and Samba under `Network Services`. You can read more about that on the [Add Games](../../play/add-games) page.
- If you want to enable netplay to be able to play multiplayer across devices please see the page on [Netplay](../../play/netplay).
- Check out [Cloud Sync](../cloud-sync) to see the available options and steps for setting up cloud sync services.

2
docs/configure/optimizations.md
View file

@ -1,4 +1,4 @@
# Optimizations
# :material-battery-plus: Optimizations
JELOS provides a variety of settings that allow you to optimize for battery life or performance globally, on a per system and per game basis. For emulating 6th generation and later systems, we recommend installing JELOS on internal storage if available to reduce IO bottlenecks reading and writing shader cache.

14
docs/configure/themes.md
View file

@ -1,6 +1,6 @@
# EmulationStation Themes
# :material-page-next-outline: Themes
Our default theme is [Art Book Next](https://github.com/anthonycaccese/art-book-next-jelos) and it has been designed specifically to work with all the aspect ratios we support. You will see it represented in the UI as `system-theme` and it's updated automatically as part of each JELOS release. It also offers a set of options to tailor the look of theme which are detailed below.
Our default frontend is EmulationStation and our default theme is [Art Book Next](https://github.com/anthonycaccese/art-book-next-jelos). It has been designed specifically to work with all the aspect ratios we support. You will see it represented in the UI as `system-theme` and it's updated automatically as part of each JELOS release. It also offers a set of options to tailor the look of theme which are detailed below.
## Preview
@ -53,11 +53,11 @@ The following options can be changed directly from the main menu under `UI Setti
Art Book Next allows customizations to artwork, colors and fonts without the need to edit the source XML. This enables you to change the look of the theme and retain any changes when JELOS is updated.
### First:
### Start Here
- Create the following path on your storage: `~/roms/jelos/theme-customizations/art-book-next/`
- In Theme Configuration make sure distribution is set to `JELOS` (this is needed to make sure the above path is referenced when looking for customization files)
### Background Art:
### Background Art
The artwork used on the system view can be customized with your own images. You can create either `centered` or `full screen` variations.
@ -81,7 +81,7 @@ To create `centered` artwork that matches the mask used in the theme you can use
If you create a set of images that you would like to share with the community please let us know about it in the themes channel on [Discord](https://discord.gg/seTxckZjJy)
### Logos:
### Logos
The logos used on the system and gamelist views can be customized with your own images.
@ -93,7 +93,7 @@ The logos used on the system and gamelist views can be customized with your own
- The theme will look them them up in that order. I recommend SVGs as they scale better on different resolutions.
- `${system.theme}.svg/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.svg` or `snes.png` in the logos folder
### Color Schemes:
### Color Schemes
You can create your own custom color scheme to use for the theme
@ -103,7 +103,7 @@ You can create your own custom color scheme to use for the theme
- 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.
- After your colors are defined; in theme configuration change `Color Scheme` to `Custom`
### Fonts:
### Fonts
You can modify the font size used to display gamelists

2
docs/configure/vpn.md
View file

@ -1,4 +1,4 @@
# VPN Services
# :material-check-network-outline: VPN Services
JELOS has built in support for multiple VPN services.

73
docs/play/add-games.md
View file

@ -1,17 +1,74 @@
# :material-nintendo-game-boy: Adding Games to JELOS
# :material-layers-plus: Adding Games to JELOS
JELOS has a few options for adding games and the option you choose will depend on the device you have and its available functionality *(For example, some devices do not have networking capabilites so those devices will not be able to use the network transfer option)*.
This page will aim to document all possible options and indicate when you might use a given one over another.
!!! note "For details on which specific files each system requires please see the corresponding pages in the systems section of this wiki."
## Option 1: Network Transfer
SSH
Network transfer can be used on any device that can connect to the internet (this includes devices with native networking capabilites and ones where networking can be added through an external dongle).
FTP
This option first requires you to set up networking on your device. Please see [Networking](../../configure/networking) for details. Once you have completed those steps make note of your IP Address in the Network Settings menu.
In addition to your IP you will also need your root password. This can be found in the Main Menu by pressing ++"START"++ in EmulationStation and navigating to `System Settings`. You will see your root password under the `Authentication` header.
!!! note "By default the root password is set up to rotate to a unique string of characters after every reboot. You can leave it like this and make note of the current password, or you can turn it off and set it to something that will persist."
### SMB
- Windows:
- open a Windows Explorer window, and type in `\\[YOUR IP ADDRESS]`; replace `[YOUR IP ADDRESS]` with the IP Address seen in the Network Settings menu.
- You will be prompted for a username and password.
- The username is `root` and your password will be the value from `Root Password` in the System Settings menu.
- MacOS:
- open Finder and select `Go > Connect to Server` from the top menu.
- In the address bar that appears, type `smb://[YOUR IP ADDRESS]`; replace `[YOUR IP ADDRESS]` with the IP Address seen in the Network Settings menu.
- You will be prompted for a username and password.
- For name enter `root` and your password will be the value from `Root Password` in the System Settings menu.
### FTP
Using your FTP program of choice set up an SFTP connection to the IP Address seen in the Network Settings menu. Make sure the Port is set to `22`. The username is `root` and your password will be the value from `Root Password` in the System Settings menu.
### After connecting
- You will see a list of folders after you have connected via network.
- Open the `roms` folder and you will see a list of folders where games and bios files can be placed.
- Please see the systems section of the wiki for details on where each system's files should be placed.
- After you have added your games you can get them to display in EmulationStation by pressing ++"START"++ to open the Main Menu, then open `Game Settings` then select `Update Gamelists` under the Tools header.
## Option 2: SD Card
## Refresh EmulationStation
Games can also be added via an SD card. There are 2 primary methods for this depending on your device.
## Next Up
### If your device has 2 SD card slots
- [Adding Metadata, Images and Video Previews]()
- [Configuring Per System/Game Settings]()
- [Hotkey Reference]()
- With your device turned off; insert a FAT32 or ExFAT formated SD card into slot 2 of your device.
- Turn your device on.
- When JELOS completes its boot process it will generate a set of folders on the SD card in slot 2.
- Now you can turn off your device, remove your SD card from slot 2 and open it on your PC.
- You PC will display a list of folders, open the `roms` directory and you will see a list of folders for each system where you can place your games and bios files.
- Add your games and place your SD card back into slot 2 and boot up JELOS.
### If your device has 1 SD card slot
!!! warning "This option is only for devices where you have installed JELOS to the internal drive of the device. In this scenario an SD card can be used directly for storage"
- With JELOS installed to your internal drive press ++"START"++ to open the Main Menu, then open `System Settings` and turn on `Autodetect Games Card` under the Preferences header.
- Turn your device off
- Insert a FAT32 or ExFAT formated SD card into your device.
- Turn your device on
- When JELOS completes its boot process it will generate a set of folders on the SD card.
- Now you can turn off your device, remove your SD card and open it on your PC.
- You PC will display a list of folders, open the `roms` directory and you will see a list of folders for each system where you can place your games and bios files.
- Add your games and place your SD card back into your device and boot up JELOS.
## Option 3: External USB Drive
*TBA*
## Option 4: Linux OS
*TBA*

2
mkdocs.yml
View file

@ -71,6 +71,7 @@ nav:
- Play:
- Install: play/install.md
- Update: play/update.md
- Add Games: play/add-games.md
- Controls: play/controls.md
- Netplay: play/netplay.md
- Contribute:
@ -86,6 +87,7 @@ nav:
- Optimizations: configure/optimizations.md
- Shaders: configure/shaders.md
#- Bluetooth: configure/bluetooth.md
- Networking: configure/networking.md
- Cloud Sync: configure/cloud-sync.md
- VPN: configure/vpn.md
- Systems: