diff --git a/wiki-rtd/docs/wiki_community/contibute-rd.md b/wiki-rtd/docs/wiki_about/contibute-retrodeck.md similarity index 96% rename from wiki-rtd/docs/wiki_community/contibute-rd.md rename to wiki-rtd/docs/wiki_about/contibute-retrodeck.md index 8da74d2..13b67c8 100644 --- a/wiki-rtd/docs/wiki_community/contibute-rd.md +++ b/wiki-rtd/docs/wiki_about/contibute-retrodeck.md @@ -10,7 +10,7 @@ Yes! Everybody is welcome to contribute in any way possible if it is personal ti - **Support:** Guide people on various communication platforms. - **Early Testing:** Find bugs, issues, and provide suggestions on cooker releases. - **Experimenting and Tweaking:** Find the best configurations for emulators and engines. -- **Donations:** Donate to the project over at [Donations & Licenses 🎁](../wiki_credits/donations-licenses.md).. +- **Donations:** Donate to the project over at [Donations & Licenses 🎁](../wiki_about/donations-licenses.md).. ## Any specific examples of what you need help with? diff --git a/wiki-rtd/docs/wiki_credits/donations-licenses.md b/wiki-rtd/docs/wiki_about/donations-licenses.md similarity index 63% rename from wiki-rtd/docs/wiki_credits/donations-licenses.md rename to wiki-rtd/docs/wiki_about/donations-licenses.md index cebc4cd..ed770bd 100644 --- a/wiki-rtd/docs/wiki_credits/donations-licenses.md +++ b/wiki-rtd/docs/wiki_about/donations-licenses.md @@ -1,37 +1,42 @@ # Information on donations -RetroDECK is nothing without our dependencies without them this project and many others like us cannot exist. Without them RetroDECK can not run any games at all, it is their software that make this possible. We always strive to do more cooperation between projects for the betterment of RetroDECK and Linux as a whole. +RetroDECK relies on its dependencies to function. Without them, RetroDECK and similar projects cannot exist. We aim to collaborate with other projects to improve RetroDECK and Linux as a whole. -If you do not want to donate to RetroDECK and you might want to donate to the Frontend, art assets, a specific emulator or engine. We support you no matter what, whatever choice you take from this list will be a good one for us all. The goal of the RetroDECK project is not to make money for profit, this is just a pure passion project. +If you prefer to donate to the frontend, art assets, a specific emulator, or engine instead of RetroDECK, we support your choice. The goal of RetroDECK is not to make a big profit but to pursue a passion project. -**If you feel passionate about a specific emulator / engine / other always make sure you donate to them directly and not via proxy. No project should be the arbiter of another projects funds.** +If you feel passionate about a specific emulator/engine/other, always donate to them directly and not via proxy. No project should control another project's funds. -### About this page +We list current and future software and functions we want to include in RetroDECK and their licenses. More items will be added in upcoming updates. -We are trying to list current and some future software and functions we want to include in RetroDECK here and their licenses (not everything is added to RetroDECK proper yet). More things will be added all the time in upcoming updates on this page and in RetroDECK. - -There are even more emulators, software, front-ends, and assets out there that are not part of the RetroDECK project for various other systems. This is not a complete list of all Emulators or Frontends for the entire internet. +There are many emulators, software, front-ends, and assets not part of RetroDECK. This is not a complete list of all emulators or frontends on the internet. ## RetroDECK + -By donating to RetroDECK you support this project and the vision of a unified packaged retro experience. +By donating to RetroDECK, you support the project and the vision of a unified experience. -#### We will use those funds to: +### We will use those funds to: -- Pay for web hosting / build servers and other such costs that comes with hosting. -- Pay for development software, other type of licenses: (we always strive for use much FOSS and CC licences as possible). -- Pay for UI elements and art from artists: (we always strive for use much FOSS and CC licences as possible). -- Buy new devices and hardware that can be targeted or used for RetroDECK development and future usage examples: - - Gaming Devices such as the Steam Deck or Rog Ally or other such types. - - Various big brand and small brand controllers for development purposes. - - Other special peripherals to target for RetroDECK: Lightguns, Wheels, XAC, Vboard, Arcade Cabinet etc.. -#### Where to donate / support the project? +- Pay for web hosting, build servers, and other hosting costs. +- Pay for development software and licenses (we strive to use FOSS and CC licenses as much as possible). +- Pay for UI elements and art from artists (we strive to use FOSS and CC licenses as much as possible). + +On rare occasions, the RetroDECK Team might need to buy new devices and hardware for RetroDECK development (we will inform the community before doing so): + +- Gaming devices like the Steam Deck or Rog Ally. +- Various big brand and small brand controllers for development. +- Special peripherals: Lightguns, Wheels, XAC, Vboard, etc. + +### Where to donate / support the project? [Patreon](https://www.patreon.com/RetroDECK) -#### Licenses +We aim to have better FOSS donation methods in the future. + +### Licenses + [Licenses](https://github.com/XargonWan/RetroDECK/blob/main/LICENSE) --- @@ -39,11 +44,11 @@ By donating to RetroDECK you support this project and the vision of a unified pa ## Flatpak - + As a flatpak we are nothing without the technology. -#### Where to donate / support the project? +### Where to donate / support the project? [Flatpak collective](https://opencollective.com/flatpak) @@ -51,38 +56,35 @@ As a flatpak we are nothing without the technology. --- -## Frontend +## ES-DE Frontend -### ES-DE Frontend + - - -ES-DE Frontend is a frontend for browsing and launching games from your multi-platform game backup collection. +ES-DE Frontend is a frontend for browsing and launching games from your multi-platform game backup collection. -#### Where to donate / support the project? +### Where to donate / support the project? Buy the app to show them your support: [Patreon - Android App](https://www.patreon.com/es_de/) -#### Licenses +### Licenses + [License](https://gitlab.com/es-de/emulationstation-de/-/blob/master/LICENSE) [Licenses](https://gitlab.com/es-de/emulationstation-de/-/tree/master/licenses) --- -## Emulators: Multi-system +## LibreRetro - RetroArch -### LibreRetro - RetroArch - - + The LibreRetro Team makes RetroArch, Libretro and Lakka -#### Where to donate / support the project? +### Where to donate / support the project? [Teespring](https://teespring.com/stores/retroarch) @@ -94,10 +96,10 @@ The LibreRetro Team makes RetroArch, Libretro and Lakka [BountySource](https://salt.bountysource.com/checkout/amount?team=libretro) -#### Licenses +### Licenses [Licenses](https://docs.libretro.com/development/licenses/) -### MAME +## MAME @@ -106,16 +108,17 @@ MAME is a multi-purpose emulation framework. MAME's purpose is to preserve decades of software history. As electronic technology continues to rush forward, MAME prevents this important "vintage" software from being lost and forgotten. -#### Where to donate / support the project? +### Where to donate / support the project? + We have not found a donation link to this project at this time or the project does not support donations. -#### Licenses +### Licenses [Copy License](https://github.com/mamedev/mame/blob/master/COPYING) [Licenses](https://github.com/mamedev/mame#license) -### ares +## ares Not yet added to RetroDECK @@ -123,253 +126,264 @@ Not yet added to RetroDECK ares is a cross-platform, open source, multi-system emulator, focusing on accuracy and preservation. -#### Where to donate / support the project? +### Where to donate / support the project? + [Patreon](https://www.patreon.com/LukeUsher) - -#### License +### License [Licenses](https://github.com/ares-emulator/ares/blob/master/LICENSE) --- -## Emulators: Sony +## RPCS3 -### RPCS3 - - + The world's first free and open-source PlayStation 3 emulator/debugger, written in C++ for Windows, Linux, macOS and FreeBSD. -#### Where to donate / support the project? +### Where to donate / support the project? [Patreon](https://patreon.com/Nekotekina) [Alipay](https://rpcs3.net/alipay) -### Duckstation +## Duckstation - - + DuckStation is an simulator/emulator of the Sony PlayStation(TM) console, focusing on playability, speed, and long-term maintainability. The goal is to be as accurate as possible while maintaining performance suitable for low-end devices. "Hack" options are discouraged, the default configuration should support all playable games with only some of the enhancements having compatibility issues. - #### Where to donate / support the project? + We have not found a donation link to this project at this time or the project does not support donations. #### Licenses + [Licenses](https://github.com/stenzek/duckstation/blob/master/LICENSE) -### PPSSPP +## PPSSPP - + PPSSPP can run your PSP games on your PC or Android phone in full HD resolution or even higher. It can also upscale textures to make them sharper, and you can enable post-processing shaders to adjust color and brightness the way you like, and other effects. -#### Where to donate / support the project? +### Where to donate / support the project? [PPSSPP Gold](https://www.ppsspp.org/buygold) -#### Licenses +### Licenses [Licenses](https://github.com/hrydgard/ppsspp/blob/master/LICENSE.TXT) -### PCSX2 +## PCSX2 PCSX2 is a free and open-source PlayStation 2 (PS2) emulator. Its purpose is to emulate the PS2's hardware and this allows you to play PS2 games on your PC, with many additional features and benefits. -#### Where to donate / support the project? +### Where to donate / support the project? [Github Sponsor](https://github.com/sponsors/PCSX2) -#### Licenses +### Licenses [Licenses](https://github.com/PCSX2/pcsx2/blob/master/COPYING.GPLv3) -### Vita3K +## Vita3K - + Vita3K is an experimental PlayStation Vita emulator for Windows, Linux, macOS and Android. -#### Where to donate / support the project? +### Where to donate / support the project? [Ko-fi](https://ko-fi.com/vita3k/tiers) -#### Licenses +### Licenses + [Licenses](https://github.com/Vita3K/Vita3K/blob/master/COPYING.txt) --- -## Emulators: Nintendo +## Dolphin -### Dolphin - - + Dolphin is an emulator for two recent Nintendo video game consoles: the GameCube and the Wii. It allows PC gamers to enjoy games for these two consoles in full HD (1080p) with several enhancements: compatibility with all PC controllers, turbo speed, networked multiplayer, and even more! -#### Where to donate / support the project? +### Where to donate / support the project? We have not found a donation link to this project at this time or the project does not support donations. -#### Licenses +### Licenses + [Licenses](https://github.com/dolphin-emu/dolphin/tree/master/LICENSES) -### Primehack +## Primehack - + PrimeHack is a modified version of [Dolphin-Emu](https://github.com/dolphin-emu/dolphin) solely for playing Metroid Prime Trilogy for Wii with keyboard and mouse on a PC. -#### Where to donate / support the project? +### Where to donate / support the project? + We have not found a donation link to this project at this time or the project does not support donations. -#### Licenses +### Licenses + [Licenses](https://github.com/Kekun/primehack/tree/master/LICENSES) -### Ryujinx - - - - -Ryujinx is an open-source Nintendo Switch emulator, created by gdkchan, written in C#. This emulator aims at providing excellent accuracy and performance, a user-friendly interface and consistent builds. It was written from scratch and development on the project began in September 2017. - -#### Where to donate / support the project? -[Patreon](https://www.patreon.com/ryujinx) - -#### Licenses -[Licenses](https://github.com/Ryujinx/Ryujinx/blob/master/LICENSE.txt) - -### melonDS - - +## melonDS + melonDS aims at providing fast and accurate Nintendo DS emulation. While it is still a work in progress, it has a pretty solid set of features: -#### Where to donate / support the project? +### Where to donate / support the project? [Patreon](https://www.patreon.com/Arisotura) [Paypal](https://paypal.me/Arisotura) -#### Licenses +### Licenses + [Licenses](https://github.com/melonDS-emu/melonDS/blob/master/LICENSE) +## Cemu -### Cemu - - + Cemu, a Wii U emulator that is able to run most Wii U games and homebrew in a playable state. It's written in C/C++ and is being actively developed with new features and fixes to increase compatibility, convenience and usability. -#### Where to donate / support the project? +### Where to donate / support the project? + [Patreon](https://www.patreon.com/cemu) -#### Licenses +### Licenses + [Licenses](https://github.com/cemu-project/Cemu/blob/main/LICENSE.txt) --- -## Emulators: Microsoft - -### Xenia +## Xenia Not yet added to RetroDECK - + Xenia is an experimental emulator for the Xbox 360. -#### Where to donate / support the project? +### Where to donate / support the project? + [Patreon](https://www.patreon.com/xenia_project) -#### Licenses +### Licenses + [Licenses](https://github.com/xenia-project/xenia/blob/master/LICENSE) -### Xemu +## Xemu - + A free and open-source application that emulates the original Microsoft Xbox game console, enabling people to play their original Xbox games on Windows, macOS, and Linux systems. -#### Where to donate / support the project? +### Where to donate / support the project? + [Patreon](https://www.patreon.com/mborgerson) -#### Licenses +### Licenses + [Licenses](https://github.com/xemu-project/xemu/tree/master/licenses) --- +## OpenBOR -## Software - -### OpenBOR - - + OpenBOR is a royalty free sprite-based side scrolling gaming engine. From humble beginnings in 2004, it has since grown into the most versatile, easy to use, and powerful engine of its type you will find anywhere. -#### Where to donate / support the project? +### Where to donate / support the project? + We have not found a donation link to this project at this time or the project does not support donations. -#### Licenses +### Licenses + [Licenses](https://github.com/DCurrent/openbor/blob/master/LICENSE) -### GZDoom +## GZDoom - + GZDoom is a feature centric port for all Doom engine games, based on ZDoom, adding an OpenGL renderer and powerful scripting capabilities. -#### Where to donate / support the project? +### Where to donate / support the project? + We have not found a donation link to this project at this time or the project does not support donations. -#### Licenses +### Licenses [Licenses](https://github.com/ZDoom/gzdoom/blob/master/LICENSE) -### ScummVM +## ScummVM - + ScummVM allows you to play classic graphic point-and-click adventure games, text adventure games, and RPGs, as long as you already have the game data files. ScummVM replaces the executable files shipped with the games, which means you can now play your favorite games on all your favorite devices. -#### Where to donate / support the project? +### Where to donate / support the project? + [Website - Paypal](https://www.scummvm.org/) -#### Licenses +### Licenses + [Licenses](https://github.com/scummvm/scummvm/blob/master/COPYING) -### Solarus +## Solarus - + Solarus is a free and open-source 2D game engine written in C++, that can run games scripted in Lua. It has been designed with 16-bit classic Action-RPGs in mind, and is available on a wide range of platforms. -#### Where to donate / support the project? +### Where to donate / support the project? + [Liberapay](https://liberapay.com/solarus-labs/donate) -#### Licenses +### Licenses + [Licenses](https://gitlab.com/solarus-games/solarus/-/blob/dev/license.txt) -### IKEMEN Go +## IKEMEN Go - + IKEMEN Go is a remake of the IKEMEN (open source fighting games engine that supports M.U.G.E.N resources) in Google’s Programming Language β€œGo”. -#### Where to donate / support the project? +### Where to donate / support the project? + We have not found a donation link to this project at this time or the project does not support donations. -#### Licenses +### Licenses + [Licenses](https://github.com/ikemen-engine/Ikemen-GO/blob/master/License.txt) --- +## Steam Rom Manager (SRM) + + + +### Where to donate / support the project? + +[Patreon](https://www.patreon.com/steamgriddb) + +### Licenses + +[Licenses](https://github.com/SteamGridDB/steam-rom-manager?tab=GPL-3.0-1-ov-file#readme) + +--- + + ## Art and Assets ### Kenney.nl @@ -412,6 +426,7 @@ Weestuarty of the group made the remix version of their LaunchBox theme for usag --- ## Other Licenses + Here we showcase the licenses of projects / functions we might use in part, got inspired by the code/solutions or want to give special credit. ### Dungeon Crawl Stone Soup @@ -437,26 +452,26 @@ CC0 [Licenses](https://github.com/PhilipK/BoilR/blob/main/LICENSE-MIT.txt) ### Lutris + [Licenses](https://github.com/lutris/lutris/blob/master/LICENSE) ### Pugsy's Cheats for MAME + [mamecheat.co.uk](https://www.mamecheat.co.uk/) ### Batocera [Licenses](https://github.com/batocera-linux/batocera.linux?tab=License-1-ov-file#readme) -### Steam Rom Manager (SRM) -[Licenses](https://github.com/SteamGridDB/steam-rom-manager?tab=GPL-3.0-1-ov-file#readme) ### Steam Deck & Steam Deck Logo -The Steam Deck logo and Steam Deck device is a registered trademark of Valve Corporation. This project is in no way officially affiliated with Valve.
+The Steam Deck logo and device are registered trademarks of Valve Corporation. This project is not officially affiliated with Valve. ### Other Trademarks -All trademarks, logos, controller images and brand names are the property of their respective owners. All company, product and service names used in this project are for identification purposes only. Use of these names, trademarks and brands does not imply endorsement. +All trademarks, logos, controller images, and brand names are the property of their respective owners. All company, product, and service names used in this project are for identification purposes only. Use of these names, trademarks, and brands does not imply endorsement. --- diff --git a/wiki-rtd/docs/wiki_credits/credits-additional.md b/wiki-rtd/docs/wiki_development/credits/credits-additional.md similarity index 100% rename from wiki-rtd/docs/wiki_credits/credits-additional.md rename to wiki-rtd/docs/wiki_development/credits/credits-additional.md diff --git a/wiki-rtd/docs/wiki_credits/credits-alumni.md b/wiki-rtd/docs/wiki_development/credits/credits-alumni.md similarity index 100% rename from wiki-rtd/docs/wiki_credits/credits-alumni.md rename to wiki-rtd/docs/wiki_development/credits/credits-alumni.md diff --git a/wiki-rtd/docs/wiki_credits/credits-boot.md b/wiki-rtd/docs/wiki_development/credits/credits-boot.md similarity index 100% rename from wiki-rtd/docs/wiki_credits/credits-boot.md rename to wiki-rtd/docs/wiki_development/credits/credits-boot.md diff --git a/wiki-rtd/docs/wiki_credits/credits-collaborators.md b/wiki-rtd/docs/wiki_development/credits/credits-collaborators.md similarity index 100% rename from wiki-rtd/docs/wiki_credits/credits-collaborators.md rename to wiki-rtd/docs/wiki_development/credits/credits-collaborators.md diff --git a/wiki-rtd/docs/wiki_credits/credits-team.md b/wiki-rtd/docs/wiki_development/credits/credits-team.md similarity index 100% rename from wiki-rtd/docs/wiki_credits/credits-team.md rename to wiki-rtd/docs/wiki_development/credits/credits-team.md diff --git a/wiki-rtd/docs/wiki_credits/credits-translation.md b/wiki-rtd/docs/wiki_development/credits/credits-translation.md similarity index 100% rename from wiki-rtd/docs/wiki_credits/credits-translation.md rename to wiki-rtd/docs/wiki_development/credits/credits-translation.md diff --git a/wiki-rtd/docs/wiki_community/discord-matrix.md b/wiki-rtd/docs/wiki_development/social/discord-matrix.md similarity index 100% rename from wiki-rtd/docs/wiki_community/discord-matrix.md rename to wiki-rtd/docs/wiki_development/social/discord-matrix.md diff --git a/wiki-rtd/docs/wiki_community/lemmy-reddit.md b/wiki-rtd/docs/wiki_development/social/lemmy-reddit.md similarity index 100% rename from wiki-rtd/docs/wiki_community/lemmy-reddit.md rename to wiki-rtd/docs/wiki_development/social/lemmy-reddit.md diff --git a/wiki-rtd/docs/wiki_general/retrodeck-start.md b/wiki-rtd/docs/wiki_general/retrodeck-start.md index 8fae0d9..9b5b418 100644 --- a/wiki-rtd/docs/wiki_general/retrodeck-start.md +++ b/wiki-rtd/docs/wiki_general/retrodeck-start.md @@ -81,6 +81,6 @@ Feel free to explore the wiki! - The RetroDECK community is active and widespread. You can find our social links on the start page of the wiki. - You can learn how to tweak certain systems from various articles. -- You can read [The RetroDECK Blog](../../blog/) to stay updated with development updates. -- You can contribute to the project: [How-to: Contribute to RetroDECK](../wiki_community/contibute-rd.md) +- You can read [The RetroDECK Blog](../blog/index.md) to stay updated with development updates. +- You can contribute to the project: [How-to: Contribute to RetroDECK](../wiki_about/contibute-retrodeck.md) diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index f442004..9133643 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -78,9 +78,10 @@ nav: - Systems included in RetroDECK: wiki_about/what-is-included.md - Supported Devices & OS: wiki_general/supported-devices.md - Supported Controllers: wiki_general/supported-controllers.md - - How to Contribute?: wiki_community/contibute-rd.md - Bugs & Known Issues: wiki_general/known-issues.md - Version History: wiki_rd_versions/version-history.md + - How to Contribute?: wiki_about/contibute-retrodeck.md + - Donations & Licenses: wiki_about/donations-licenses.md - FAQ ❔: @@ -302,16 +303,15 @@ nav: - Development πŸ§ͺ: - Social Rules ❀️: - - Discord/Matrix: wiki_community/discord-matrix.md - - Lemmy/Reddit: wiki_community/lemmy-reddit.md + - Discord/Matrix: wiki_development/social/discord-matrix.md + - Lemmy/Reddit: wiki_development/social/lemmy-reddit.md - - Credits & Donations πŸ“–: - - Credits - RetroDECK Team: wiki_credits/credits-team.md - - Credits - RetroDECK Alumni: wiki_credits/credits-alumni.md - - Credits - Additional: wiki_credits/credits-additional.md - - Credits - Boot Logos: wiki_credits/credits-boot.md - - Credits - Collaborators: wiki_credits/credits-collaborators.md - - Donations & Licenses 🎁: wiki_credits/donations-licenses.md + - Credits πŸ“–: + - Credits - RetroDECK Team: wiki_development/credits/credits-team.md + - Credits - RetroDECK Alumni: wiki_development/credits/credits-alumni.md + - Credits - Additional: wiki_development/credits/credits-additional.md + - Credits - Boot Logos: wiki_development/credits/credits-boot.md + - Credits - Collaborators: wiki_development/credits/credits-collaborators.md - Flatpak πŸ“¦: - About Flatpak: wiki_development/flatpak/retrodeck-flatpak.md