mirror of
https://github.com/RetroDECK/RetroDECK.git
synced 2024-11-25 15:35:38 +00:00
Fixed some spelling and grammar
This commit is contained in:
parent
e6a80a6753
commit
79bcfa1dfa
10
README.md
10
README.md
|
@ -46,15 +46,15 @@ For more information read up here:
|
||||||
RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered Linux [Flatpak application](https://flathub.org/apps/net.retrodeck.retrodeck) that thanks to its `RetroDECK Framework` it builds-in and manage a variety of emulators and other software that allows you to play your favorite retro (and even not-so-retro) games in one complete package.
|
RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered Linux [Flatpak application](https://flathub.org/apps/net.retrodeck.retrodeck) that thanks to its `RetroDECK Framework` it builds-in and manage a variety of emulators and other software that allows you to play your favorite retro (and even not-so-retro) games in one complete package.
|
||||||
|
|
||||||
### So what does that mean?
|
### So what does that mean?
|
||||||
It means that RetroDECK provides all the emulators, systems and a frontend. RetroDECK configures them for you and put them into one application you can download from Flathub.
|
It means that RetroDECK provides all the emulators, systems and a frontend. RetroDECK configures them for you and puts them into one application you can download from Flathub.
|
||||||
|
|
||||||
By being one application RetroDECK can put all important files in one location for all the emulators, instead of having them spread out over your entire system and even add features on top to orchestrate them seamlessly.
|
By being one application RetroDECK can put all important files in one location for all the emulators, instead of having them spread out over your entire system and even add features on top to orchestrate them seamlessly.
|
||||||
|
|
||||||
|
|
||||||
### The RetroDECK Framework
|
### The RetroDECK Framework
|
||||||
As previously mentioned, RetroDECK also adds the `RetroDECK Framework` on top of the emulators and ES-DE interface that allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set per emulator basis to create a uniformity between them.
|
As previously mentioned, RetroDECK also adds the `RetroDECK Framework` on top of the emulators and ES-DE interface which allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set on a per emulator basis to create a uniformity between them.
|
||||||
|
|
||||||
The `RetroDECK Configurator` is a `Utility` that some parts of exposes the `RetroDECK Framework` to the RetroDECK users.
|
The `RetroDECK Configurator` is a `Utility` that exposes some parts of the `RetroDECK Framework` to the RetroDECK users.
|
||||||
|
|
||||||
**What can the RetroDECK Framework and by extent the RetroDECK Configurator do?**
|
**What can the RetroDECK Framework and by extent the RetroDECK Configurator do?**
|
||||||
|
|
||||||
|
@ -67,7 +67,7 @@ It can help with:
|
||||||
- Auto installing some free BIOSes
|
- Auto installing some free BIOSes
|
||||||
- Install prebuilt Steam Input profiles for devices like the Steam Deck and external controllers
|
- Install prebuilt Steam Input profiles for devices like the Steam Deck and external controllers
|
||||||
- Easier management of `mods`, `roms`, `texture_packs`, `scraped media`, `screenshots`, `saves / states` `gamelists` and more
|
- Easier management of `mods`, `roms`, `texture_packs`, `scraped media`, `screenshots`, `saves / states` `gamelists` and more
|
||||||
- Give access to global presets that can be acitivated to configure things over many emulators in one go like: `RetroAchievements`
|
- Give access to global presets that can be activated to configure things over many emulators in one go like: `RetroAchievements`
|
||||||
`Borders` `Widescreen Mode` `Swaping A/B X/Y for Nintendo Games`
|
`Borders` `Widescreen Mode` `Swaping A/B X/Y for Nintendo Games`
|
||||||
|
|
||||||
For our long term vision you can check out the following wiki page:
|
For our long term vision you can check out the following wiki page:
|
||||||
|
@ -109,7 +109,7 @@ Read up here on how to help out, there is something for everyone:
|
||||||
Please check out the [Wiki](https://github.com/XargonWan/RetroDECK/wiki) for even more information.
|
Please check out the [Wiki](https://github.com/XargonWan/RetroDECK/wiki) for even more information.
|
||||||
|
|
||||||
## The FAQ
|
## The FAQ
|
||||||
The RetroDECK [FAQ](https://github.com/XargonWan/RetroDECK/wiki/FAQs%3A-Frequently-asked-questions) on the wiki has a vast variety of questions and awnsers.
|
The RetroDECK [FAQ](https://github.com/XargonWan/RetroDECK/wiki/FAQs%3A-Frequently-asked-questions) on the wiki has a vast variety of questions and answers.
|
||||||
|
|
||||||
# How to get support?
|
# How to get support?
|
||||||
Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g).
|
Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g).
|
||||||
|
|
2
functions/cloud_sync.sh
Normal file
2
functions/cloud_sync.sh
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
|
@ -18,7 +18,7 @@ Arguments:
|
||||||
--info-msg Print paths and config informations
|
--info-msg Print paths and config informations
|
||||||
--configurator Starts the RetroDECK Configurator
|
--configurator Starts the RetroDECK Configurator
|
||||||
--compress-one <file> Compresses target file to a compatible format
|
--compress-one <file> Compresses target file to a compatible format
|
||||||
--compress-all <format> Compresses all supported games into compatible format. Available formats are \"chd\", \"zip\", \"rvz\" and \"all\".
|
--compress-all <format> Compresses all supported games into a compatible format. Available formats are \"chd\", \"zip\", \"rvz\" and \"all\".
|
||||||
--reset-component <component> Reset one or more component or emulator configs to the default values
|
--reset-component <component> Reset one or more component or emulator configs to the default values
|
||||||
--reset-retrodeck Starts the initial RetroDECK installer (backup your data first!)
|
--reset-retrodeck Starts the initial RetroDECK installer (backup your data first!)
|
||||||
|
|
||||||
|
|
|
@ -107,12 +107,12 @@ source /app/libexec/global.sh
|
||||||
configurator_welcome_dialog() {
|
configurator_welcome_dialog() {
|
||||||
log i "Configurator: opening welcome dialog"
|
log i "Configurator: opening welcome dialog"
|
||||||
if [[ $developer_options == "true" ]]; then
|
if [[ $developer_options == "true" ]]; then
|
||||||
welcome_menu_options=("Presets & Settings" "Here you find various presets, tweaks and settings to customize your RetroDECK experience" \
|
welcome_menu_options=("Presets & Settings" "Here you will find various presets, tweaks and settings to customize your RetroDECK experience" \
|
||||||
"Open Emulator" "Launch and configure each emulators settings (for advanced users)" \
|
"Open Emulator" "Launch and configure each emulator's settings (for advanced users)" \
|
||||||
"RetroDECK: Tools" "Compress games, move RetroDECK and install optional features" \
|
"RetroDECK: Tools" "Compress games, move RetroDECK and install optional features" \
|
||||||
"RetroDECK: Troubleshooting" "Backup data, perform BIOS / multi-disc file checks checks and emulator resets" \
|
"RetroDECK: Troubleshooting" "Backup data, perform BIOS / multi-disc file checks and emulator resets" \
|
||||||
"RetroDECK: About" "Show additional information about RetroDECK" \
|
"RetroDECK: About" "Show additional information about RetroDECK" \
|
||||||
"Sync with Steam" "Sync with Steam all the favorites games" \
|
"Sync with Steam" "Sync all favorited games with Steam" \
|
||||||
"Developer Options" "Welcome to the DANGER ZONE")
|
"Developer Options" "Welcome to the DANGER ZONE")
|
||||||
else
|
else
|
||||||
welcome_menu_options=("Presets & Settings" "Here you find various presets, tweaks and settings to customize your RetroDECK experience" \
|
welcome_menu_options=("Presets & Settings" "Here you find various presets, tweaks and settings to customize your RetroDECK experience" \
|
||||||
|
@ -212,7 +212,7 @@ configurator_global_presets_and_settings_dialog() {
|
||||||
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --width=1200 --height=720 \
|
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --width=1200 --height=720 \
|
||||||
--column="Choice" --column="Action" \
|
--column="Choice" --column="Action" \
|
||||||
"Widescreen: Enable/Disable" "Enable or disable widescreen in supported systems" \
|
"Widescreen: Enable/Disable" "Enable or disable widescreen in supported systems" \
|
||||||
"Ask-to-Exit: Enable/Disable" "Enable or disable emulators confirming when quitting in supported systems" \
|
"Ask-to-Exit: Enable/Disable" "Enable or disable emulators confirming attempts to quit in supported systems" \
|
||||||
"Quick Resume: Enable/Disable" "Enable or disable save state auto-save/load in supported systems" \
|
"Quick Resume: Enable/Disable" "Enable or disable save state auto-save/load in supported systems" \
|
||||||
"RetroAchievements: Login" "Log into the RetroAchievements service in supported systems" \
|
"RetroAchievements: Login" "Log into the RetroAchievements service in supported systems" \
|
||||||
"RetroAchievements: Logout" "Disable RetroAchievements service in ALL supported systems" \
|
"RetroAchievements: Logout" "Disable RetroAchievements service in ALL supported systems" \
|
||||||
|
@ -337,7 +337,7 @@ configurator_dolphin_input_textures_dialog() {
|
||||||
zenity --question \
|
zenity --question \
|
||||||
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Configurator - Dolphin Textures: Universal Dynamic Input" \
|
--title "RetroDECK Configurator - Dolphin Textures: Universal Dynamic Input" \
|
||||||
--text="Custom input textures are currently enabled. Do you want to disable them?."
|
--text="Custom input textures are currently enabled. Do you want to disable them?"
|
||||||
|
|
||||||
if [ $? == 0 ]
|
if [ $? == 0 ]
|
||||||
then
|
then
|
||||||
|
@ -351,7 +351,7 @@ configurator_dolphin_input_textures_dialog() {
|
||||||
zenity --question \
|
zenity --question \
|
||||||
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Configurator - Dolphin Textures: Universal Dynamic Input" \
|
--title "RetroDECK Configurator - Dolphin Textures: Universal Dynamic Input" \
|
||||||
--text="Custom input textures are currently disabled. Do you want to enable them?.\n\nThis process may take several minutes to complete."
|
--text="Custom input textures are currently disabled. Do you want to enable them?\n\nThis process may take several minutes to complete."
|
||||||
|
|
||||||
if [ $? == 0 ]
|
if [ $? == 0 ]
|
||||||
then
|
then
|
||||||
|
@ -375,7 +375,7 @@ configurator_primehack_input_textures_dialog() {
|
||||||
zenity --question \
|
zenity --question \
|
||||||
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Configurator - Dolphin Custom Input Textures" \
|
--title "RetroDECK Configurator - Dolphin Custom Input Textures" \
|
||||||
--text="Custom input textures are currently enabled. Do you want to disable them?."
|
--text="Custom input textures are currently enabled. Do you want to disable them?"
|
||||||
|
|
||||||
if [ $? == 0 ]
|
if [ $? == 0 ]
|
||||||
then
|
then
|
||||||
|
@ -389,7 +389,7 @@ configurator_primehack_input_textures_dialog() {
|
||||||
zenity --question \
|
zenity --question \
|
||||||
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Configurator - Primehack Custom Input Textures" \
|
--title "RetroDECK Configurator - Primehack Custom Input Textures" \
|
||||||
--text="Custom input textures are currently disabled. Do you want to enable them?.\n\nThis process may take several minutes to complete."
|
--text="Custom input textures are currently disabled. Do you want to enable them?\n\nThis process may take several minutes to complete."
|
||||||
|
|
||||||
if [ $? == 0 ]
|
if [ $? == 0 ]
|
||||||
then
|
then
|
||||||
|
@ -413,7 +413,7 @@ configurator_power_user_warning_dialog() {
|
||||||
choice=$(zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap --ok-label="Yes" --extra-button="No" --extra-button="Never show this again" \
|
choice=$(zenity --icon-name=net.retrodeck.retrodeck --info --no-wrap --ok-label="Yes" --extra-button="No" --extra-button="Never show this again" \
|
||||||
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Power User Warning" \
|
--title "RetroDECK Power User Warning" \
|
||||||
--text="Making manual changes to an emulators configuration may create serious issues,\nand some settings may be overwitten during RetroDECK updates or when using presets.\n\nSome standalone emulator functions may not work properly outside of Desktop mode.\n\nPlease continue only if you know what you're doing.\n\nDo you want to continue?")
|
--text="Making manual changes to an emulator's configuration may create serious issues,\nand some settings may be overwitten during RetroDECK updates or when using presets.\n\nSome standalone emulator functions may not work properly outside of Desktop mode.\n\nPlease continue only if you know what you're doing.\n\nDo you want to continue?")
|
||||||
fi
|
fi
|
||||||
rc=$? # Capture return code, as "Yes" button has no text value
|
rc=$? # Capture return code, as "Yes" button has no text value
|
||||||
if [[ $rc == "0" ]]; then # If user clicked "Yes"
|
if [[ $rc == "0" ]]; then # If user clicked "Yes"
|
||||||
|
@ -807,7 +807,7 @@ configurator_compress_single_game_dialog() {
|
||||||
configurator_compression_tool_dialog
|
configurator_compression_tool_dialog
|
||||||
|
|
||||||
else
|
else
|
||||||
configurator_generic_dialog "RetroDECK Configurator - RetroDECK: Compression Tool" "The selected file does not have any compatible compressed format."
|
configurator_generic_dialog "RetroDECK Configurator - RetroDECK: Compression Tool" "The selected file does not have any compatible compression formats."
|
||||||
configurator_compression_tool_dialog
|
configurator_compression_tool_dialog
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
|
@ -1027,7 +1027,7 @@ configurator_retrodeck_troubleshooting_dialog() {
|
||||||
}
|
}
|
||||||
|
|
||||||
configurator_check_bios_files() {
|
configurator_check_bios_files() {
|
||||||
configurator_generic_dialog "RetroDECK Configurator - Check & Verify: BIOS Files" "This check will look for BIOS files that RetroDECK has identified as working.\n\nNot all BIOS files are required for games to work, please check the BIOS description for more information on its purpose.\n\nThere may be additional BIOS files that will function with the emulators that are not checked.\n\nSome more advanced emulators such as Ryujinx will have additional methods for verifiying the BIOS files are in working order."
|
configurator_generic_dialog "RetroDECK Configurator - Check & Verify: BIOS Files" "This check will look for BIOS files that RetroDECK has identified as working.\n\nNot all BIOS files are required for games to work, please check the BIOS description for more information on its purpose.\n\nBIOS files not known to this tool could still function.\n\nSome more advanced emulators such as Ryujinx will have additional methods to verify that the BIOS files are in working order."
|
||||||
bios_checked_list=()
|
bios_checked_list=()
|
||||||
|
|
||||||
check_bios_files "basic"
|
check_bios_files "basic"
|
||||||
|
@ -1045,7 +1045,7 @@ configurator_check_bios_files() {
|
||||||
}
|
}
|
||||||
|
|
||||||
configurator_check_bios_files_expert_mode() {
|
configurator_check_bios_files_expert_mode() {
|
||||||
configurator_generic_dialog "RetroDECK Configurator - Check & Verify: BIOS Files - Expert Mode" "This check will look for BIOS files that RetroDECK has identified as working.\n\nNot all BIOS files are required for games to work, please check the BIOS description for more information on its purpose.\n\nThere may be additional BIOS files that will function with the emulators that are not checked.\n\nSome more advanced emulators such as Ryujinx will have additional methods for verifiying the BIOS files are in working order."
|
configurator_generic_dialog "RetroDECK Configurator - Check & Verify: BIOS Files - Expert Mode" "This check will look for BIOS files that RetroDECK has identified as working.\n\nNot all BIOS files are required for games to work, please check the BIOS description for more information on its purpose.\n\nBIOS files not known to this tool could still function.\n\nSome more advanced emulators such as Ryujinx will have additional methods to verify that the BIOS files are in working order."
|
||||||
bios_checked_list=()
|
bios_checked_list=()
|
||||||
|
|
||||||
check_bios_files "expert"
|
check_bios_files "expert"
|
||||||
|
@ -1166,7 +1166,7 @@ configurator_reset_dialog() {
|
||||||
component_to_reset=$(zenity --list \
|
component_to_reset=$(zenity --list \
|
||||||
--title "RetroDECK Configurator Utility - Reset Specific RetroDECK Component" --cancel-label="Back" \
|
--title "RetroDECK Configurator Utility - Reset Specific RetroDECK Component" --cancel-label="Back" \
|
||||||
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --width=1200 --height=720 \
|
--window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" --width=1200 --height=720 \
|
||||||
--text="Which component do you want to reset to default?" \
|
--text="Which component do you want to reset to default settings?" \
|
||||||
--column="Component" --column="Action" \
|
--column="Component" --column="Action" \
|
||||||
"BoilR" "Reset BoilR that manages the sync and scraping toward Steam library" \
|
"BoilR" "Reset BoilR that manages the sync and scraping toward Steam library" \
|
||||||
"ES-DE" "Reset the ES-DE frontend" \ )
|
"ES-DE" "Reset the ES-DE frontend" \ )
|
||||||
|
@ -1272,7 +1272,7 @@ configurator_add_steam() {
|
||||||
zenity --question \
|
zenity --question \
|
||||||
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Configurator - RetroDECK Steam Syncronization" \
|
--title "RetroDECK Configurator - RetroDECK Steam Syncronization" \
|
||||||
--text="Steam syncronization is current enabled. Do you want to disable it?\n\nThe already added shortcut will not be removed.\n"
|
--text="Steam syncronization is currently enabled. Do you want to disable it?\n\nThe already added shortcut will not be removed.\n"
|
||||||
|
|
||||||
if [ $? == 0 ] # User clicked "Yes"
|
if [ $? == 0 ] # User clicked "Yes"
|
||||||
then
|
then
|
||||||
|
@ -1284,7 +1284,7 @@ configurator_add_steam() {
|
||||||
zenity --question \
|
zenity --question \
|
||||||
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Configurator - RetroDECK Steam Syncronization" \
|
--title "RetroDECK Configurator - RetroDECK Steam Syncronization" \
|
||||||
--text="Steam syncronization is current disabled. Do you want to enable it?\n\nAll the games marked as favorites will be syncronized with Steam thanks to BoilR.\nRemember to restart Steam each time to see the changes.\n"
|
--text="Steam syncronization is currently disabled. Do you want to enable it?\n\nAll the games marked as favorites will be syncronized with Steam thanks to BoilR.\nRemember to restart Steam each time to see the changes.\n"
|
||||||
|
|
||||||
if [ $? == 0 ]
|
if [ $? == 0 ]
|
||||||
then
|
then
|
||||||
|
@ -1395,7 +1395,7 @@ configurator_retrodeck_multiuser_dialog() {
|
||||||
zenity --question \
|
zenity --question \
|
||||||
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Configurator - RetroDECK Multi-user Support" \
|
--title "RetroDECK Configurator - RetroDECK Multi-user Support" \
|
||||||
--text="Multi-user support is current enabled. Do you want to disable it?\n\nIf there are more than one user configured,\nyou will be given a choice of which to use as the single RetroDECK user.\n\nThis users files will be moved to the default locations.\n\nOther users files will remain in the mutli-user-data folder.\n"
|
--text="Multi-user support is currently enabled. Do you want to disable it?\n\nIf there is more than one user configured,\nyou will be given a choice of which to use as the single RetroDECK user.\n\nThis user's files will be moved to the default locations.\n\nOther users' files will remain in the mutli-user-data folder.\n"
|
||||||
|
|
||||||
if [ $? == 0 ] # User clicked "Yes"
|
if [ $? == 0 ] # User clicked "Yes"
|
||||||
then
|
then
|
||||||
|
@ -1407,7 +1407,7 @@ configurator_retrodeck_multiuser_dialog() {
|
||||||
zenity --question \
|
zenity --question \
|
||||||
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
--no-wrap --window-icon="/app/share/icons/hicolor/scalable/apps/net.retrodeck.retrodeck.svg" \
|
||||||
--title "RetroDECK Configurator - RetroDECK Multi-user support" \
|
--title "RetroDECK Configurator - RetroDECK Multi-user support" \
|
||||||
--text="Multi-user support is current disabled. Do you want to enable it?\n\nThe current users saves and states will be backed up and then moved to the \"retrodeck/multi-user-data\" folder.\nAdditional users will automatically be stored in their own folder here as they are added."
|
--text="Multi-user support is currently disabled. Do you want to enable it?\n\nThe current user's saves and states will be backed up and then moved to the \"retrodeck/multi-user-data\" folder.\nAdditional users will automatically be stored in their own folder here as they are added."
|
||||||
|
|
||||||
if [ $? == 0 ]
|
if [ $? == 0 ]
|
||||||
then
|
then
|
||||||
|
|
Loading…
Reference in a new issue