From 2e85df8917682215a786d8bf47dc4c0802f65874 Mon Sep 17 00:00:00 2001 From: anthonycaccese Date: Mon, 9 Oct 2023 08:44:23 -0400 Subject: [PATCH] Added RetroAchievements documentation --- docs/configure/networking.md | 7 ++++--- docs/play/retro-achievements.md | 21 +++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 26 insertions(+), 3 deletions(-) create mode 100644 docs/play/retro-achievements.md diff --git a/docs/configure/networking.md b/docs/configure/networking.md index 08054c5..a3e0d4c 100644 --- a/docs/configure/networking.md +++ b/docs/configure/networking.md @@ -2,7 +2,7 @@ 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. +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](../../play/retro-achievements/). ## Setup @@ -14,8 +14,9 @@ With networking turned on you do things such as [add games](../../play/add-games When you exit the network settings menu your network should activiate. -## Additional Settings +## Additional Notes - 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. \ No newline at end of file +- Check out [Cloud Sync](../cloud-sync) to see the available options and steps for setting up cloud sync services. +- If you would like to earn achievements while playing games please check out [RetroAchievements](../../play/retro-achievements/) \ No newline at end of file diff --git a/docs/play/retro-achievements.md b/docs/play/retro-achievements.md new file mode 100644 index 0000000..7cc7605 --- /dev/null +++ b/docs/play/retro-achievements.md @@ -0,0 +1,21 @@ +# :fontawesome-solid-medal: Retro Achievements + +JELOS 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. + +## Setup + +1. Create an account at [RetroAchievements.org](https://retroachievements.org/). +2. Follow the steps on the [Networking](../../configure/networking) page to connect your device to the internet. +3. While in EmulationStation press ++"START"++ on your controller to open the Main Menu. +4. Select `Game Settings` and then choose `RetroAchievement Settings`. +5. Turn On RetroAchievements (first toggle). +6. Then enter your username and password for RetroAchievements.org in the username and password fields. + +## Additional Notes + +- There are additional settings that can be changed in the above menu to tailor your experience. Please see the documentation @ [docs.retroachievements.org](https://docs.retroachievements.org/) for details on each option + - Recommended Settings: + - Unlock Sound (++"On"++): this plays the classic unlock sound each time an achievement is earned. + - 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. +- 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 +- 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. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 2ee765f..b864e09 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,6 +72,7 @@ nav: - Install: play/install.md - Update: play/update.md - Add Games: play/add-games.md + - Achievements: play/retro-achievements.md - Controls: play/controls.md - Netplay: play/netplay.md - Contribute: