WIKI: Fixed images

wiki-rtd/docs/wiki_emulator_guides/cemu-guide.md

@@ -1,6 +1,37 @@
 # Guide: CEMU
 
+<img src="../../wiki_images/logos/cemu-logo.png" width="150">
+
 WIP
 
 ## Where to put the games
 WiiU games should be put under the `retrodeck/roms/wiiu/` directory.
+
+## ES-DE Guide
+
+**This needs to be rewritten**
+
+The .wua archive format is the preferred method to use for Wii U games, but the method of using unpacked games is also documented here for reference.
+.wud and .wux files are supported as well, but these two formats are not discussed here as the .wua format is clearly the way to go in the future.
+
+Method 1, using .wua files
+Start Cemu and install the game, any updates as well as optional DLCs to the Cemu NAND. After the installation is completed, open the Title Manager from the Tools menu, select your game, right click and select Convert to compressed Wii U archive (.wua) and select your wiiu system directory as the target. You can modify the file name if you want to, or keep it at its default value. Press the Save button and the game will be automatically packaged as a .wua file.
+Following this just start ES-DE and the game should be shown as a single entry that can be launched using Cemu.
+
+Method 2, unpacked games
+Only the setup on Windows is covered here, but it's the same principle in Linux and macOS.
+Using this unpacked approach, the content of each game is divided into the three directories code, content and meta.
+The first step is to prepare the target directory in the wiiu system directory, for this example we'll go for the game Super Mario 3D World. So simply create a directory with this name inside the wiiu folder. It should look something like the following:
+
+- C:\Users\myusername\ROMs\wiiu\Super Mario 3D World\
+
+The next step is done inside the Cemu user interface. You should install the game, any updates as well as optional DLCs to the Cemu NAND. After the installation is completed, right click on the game and choose Game directory. An Explorer window should now open showing the content of the game. Here's the game directory for our example:
+
+- C:\Games\cemu\mlc01\usr\title\00050000\10145d00\code
+Go up one level and copy the code, content and meta directories and paste them into the C:\Users\myusername\ROMs\wiiu\Super Mario 3D World\ directory. It should now look something like the following:
+
+- C:\Users\myusername\ROMs\wiiu\Super Mario 3D World\code
+- C:\Users\myusername\ROMs\wiiu\Super Mario 3D World\content
+- C:\Users\myusername\ROMs\wiiu\Super Mario 3D World\meta
+
+Starting ES-DE should now show the Super Mario 3D World entry for the Wii U system. The actual game file with the extension .rpx is stored inside the code directory, and does not normally match the name of the game. For this example it's named RedCarpet.rpx. When scraping the .rpx file you therefore need to refine the search and manually enter the game name. ES-DE fully supports scraping of directories, so you can scrape the Super Mario 3D World folder as well.

wiki-rtd/docs/wiki_emulator_guides/citra-guide.md

@@ -1,5 +1,7 @@
 # Guide: Citra
 
+<img src="../../wiki_images/logos/citra-logo.svg" width="150">
+
 WIP
 
 ## Where to put the games

wiki-rtd/docs/wiki_emulator_guides/ikemengo-guide.md

@@ -1,6 +1,57 @@
-# Guide: IkemenGO
+# Guide: IkemenGO / M.U.G.E.N
+
+<img src="../../wiki_images/logos/ikemen-go-logo.png" width="150">
+
 
 WIP
 
 ## Where to put the games
 `IkemenGO` `Ikemen` and `M.U.G.E.N` games should be put under the `retrodeck/roms/mugen/` directory.
+
+## ES-DE Guide
+
+**This need to be rewritten**
+
+Ikemen GO and M.U.G.E.N Game Engine
+M.U.G.E.N games can be played using the  game engine which is being actively developed and is available on Linux, macOS and Windows. The original M.U.G.E.N engine which only exists for Windows has not had any updates in years and is therefore considered obsolete and won't be covered here. But it's still possible to use it on Windows via the same approach described for Ikemen GO so if you really want to use it, then you can.
+Basic setup
+These games are shipped as self-contained units with the game engine binary included in the game directory structure. On Windows .lnk files are used to launch the games and on Linux and macOS files or symlinks with the .mugen extension are required.
+For this example we'll go with the game Ultimate Sonic Mugen.
+On Windows, go into the game directory, right click on the Ikemen_GO.exe file, select Create Shortcut followed by Create Desktop Shortcut. This will create a file with the .lnk extension. Rename the file to Ultimate Sonic Mugen.lnk and try to run this file to make sure that the game starts and runs correctly. Note that this setup is not portable, if you move your game files somewhere else you will need to manually update your shortcuts as these contain absolute paths.
+On Linux and macOS, go into the game directory and rename the Ikemen_GO_Linux or Ikemen_GO_MacOS binary to the name of the game and add the .mugen extension to the filename, for example Ultimate Sonic Mugen.mugen. Try to run this file to make sure that the game starts and runs correctly.
+Starting ES-DE and launching the game should now work fine, but a further improvement is to use the directories interpreted as files functionality to display the game as a single entry instead of a directory. To accomplish this, simply rename the game directory to the same name as the game file, which for this example would be Ultimate Sonic Mugen.lnk or Ultimate Sonic Mugen.mugen depending on which operating system you use.
+
+The setup should now look something like the following:
+
+~/ROMs/mugen/Ultimate Sonic Mugen.mugen/
+~/ROMs/mugen/Ultimate Sonic Mugen.mugen/chars/
+~/ROMs/mugen/Ultimate Sonic Mugen.mugen/data/
+~/ROMs/mugen/Ultimate Sonic Mugen.mugen/external/
+~/ROMs/mugen/Ultimate Sonic Mugen.mugen/font/
+~/ROMs/mugen/Ultimate Sonic Mugen.mugen/sound/
+~/ROMs/mugen/Ultimate Sonic Mugen.mugen/stages/
+~/ROMs/mugen/Ultimate Sonic Mugen.mugen/Ultimate Sonic Mugen.mugen
+
+Configuring M.U.G.E.N games for use with Ikemen GO
+This section is only included to provide some general understanding on how to convert M.U.G.E.N games to run with Ikemen GO, it's in no way a complete tutorial and the steps needed are likely slightly different for each game. Refer to the Ikemen GO support forums and documentation for more thorough information.
+We'll use the game Ultimate Sonic Mugen for this example.
+Download Ikemen GO from https://github.com/ikemen-engine/Ikemen-GO/releases, the package you want is Ikemen_GO_v0.98.2.zip or similar, depending on which version you're downloading. Unpack the file to a suitable location.
+Download the game Ultimate Sonic Mugen and unpack it to a suitable location.
+Create a new game directory, for example ~/ROMs/mugen/Ultimate Sonic Mugen
+Copy the following directories from the downloaded game directory to the empty game directory you just created:
+
+chars
+data
+font
+sound
+stages
+
+If you're using an operating system with a case-sensitive file system like Linux, then you also need to rename every file inside the data directory to lowercase characters. This includes also the file extensions.
+Copy the following directories from the Ikemen GO directory to the game directory:
+
+data
+external
+font
+The game binary, either Ikemen_GO.exe, Ikemen_GO_Linux or Ikemen_GO_MacOS
+
+Do NOT overwrite any files when copying over the data and font directories, or the game will not work correctly.

wiki-rtd/docs/wiki_emulator_guides/mame-guide.md

@@ -2,5 +2,7 @@
 
 WIP
 
+<img src="../../wiki_images/logos/mame-logo.png" width="180">
+
 ## Where to put the games
 Games that you want to run with MAME should be put under the `retrodeck/roms/mame/` directory.

wiki-rtd/docs/wiki_emulator_guides/melonds-guide.md

@@ -1,5 +1,7 @@
 # Guide: MelondDS
 
+<img src="../../wiki_images/logos/melonds-logo.svg" width="150">
+
 WIP
 
 ## Where to put the games

wiki-rtd/docs/wiki_emulator_guides/openbor-guide.md

@@ -1,6 +1,37 @@
 # Guide: OpenBOR
 
+<img src="../../wiki_images/logos//openbor-logo.svg" width="150">
+
 WIP
 
 ## Where to put the games
 OpenBOR games should be put under the `retrodeck/roms/openbor/` directory.
+
+## ES-DE Guide
+
+**This need to be rewritten**
+
+The Open Beats of Rage (OpenBOR) game engine is available on Windows and Linux. Unfortunately the macOS ports seems to have been abandoned.
+These games are often but not always distributed together with the game engine as specific engine versions may be required for some games. The setup is slightly different between Windows and Linux so they are described separately here.
+
+On Linux you need to supply your own game engine binary as few (if any) games are distributed with the Linux release of OpenBOR. Download the .7z archive from the https://github.com/DCurrent/openbor repository. The file you want is OpenBOR_3.0_6391.AppImage which is located inside the LINUX/OpenBOR folder. If you need an older engine for some specific game, then you may need to download an earlier release instead.
+Copy this file to the game directory and make it executable using the command chmod +x OpenBOR_3.0_6391.AppImage
+Using the same game example as for the Windows instructions above, the directory structure should look like the following:
+
+- /ROMs/openbor/D&D - K&D - The Endless Quest LNS/
+- /ROMs/openbor/D&D - K&D - The Endless Quest LNS/Logs/
+- /ROMs/openbor/D&D - K&D - The Endless Quest LNS/Paks/
+- /ROMs/openbor/D&D - K&D - The Endless Quest LNS/Saves/
+- /ROMs/openbor/D&D - K&D - The Endless Quest LNS/ScreenShots/
+- /ROMs/openbor/D&D - K&D - The Endless Quest LNS/OpenBOR_3.0_6391.AppImage
+- /ROMs/openbor/D&D - K&D - The Endless Quest LNS/OpenBOR.exe
+
+You can delete the OpenBOR.exe file since you don't need it, and it's recommended to rename the OpenBOR_3.0_6391.AppImage file to the name of the game, such as:
+
+~/ROMs/openbor/D&D - K&D - The Endless Quest LNS/The Endless Quest.AppImage
+
+Starting ES-DE and launching the game should now work fine, but a further improvement is to use the directories interpreted as files functionality to display the game as a single entry instead of a directory. To accomplish this, simply rename the game directory to the same name as the .AppImage file, such as:
+
+~/ROMs/openbor/The Endless Quest.AppImage/The Endless Quest.AppImage
+
+Doing this will make the game show up as if it was a single file inside ES-DE and it can be included in automatic collections, custom collections and so on.

wiki-rtd/docs/wiki_emulator_guides/pcsx2-guide.md

@@ -1,5 +1,7 @@
 # Guide: PCSX2
 
+<img src="../../wiki_images/logos/pcsx2-logo.png" width="180">
+
 WIP
 
 ## Where to put the games

wiki-rtd/docs/wiki_emulator_guides/pico8-guide.md

@@ -1,6 +1,27 @@
 # Guide: PICO-8
 
+<img src="../../wiki_images/logos//pico-8-logo.png">
+
 WIP
 
 ## Where to put the games
 PICO-8 games should be put under the `retrodeck/roms/pico8/` directory.
+
+## ES-DE Guide
+
+**This needs to be rewritten**
+
+PICO-8 Fantasy Console is a game engine developed by Lexaloffle Games that you need to buy a license to use. Doing so will provide you with download links to releases for Linux, macOS and Windows. Make sure to use the 64-bit release as the 32-bit release reportedly has some technical issues. On macOS and Windows the installation is straightforward, but on Linux you need to place PICO-8 in a location recognized by ES-DE. See the Using manually downloaded emulators on Linux section of this guide for more details.
+After the emulator has been installed you are ready to add some games. There are two ways to play games using PICO-8, either to add them to ES-DE as for any other system, or using the built-in Splore tool to explore and run games all through the PICO-8 user interface.
+For the first approach you can download games from the PICO-8 forum and these are quite uniquely distributed as .png images. You just download these and place them inside the ~/ROMs/pico8 directory, for example:
+
+- /ROMs/pico8/c_e_l_e_s_t_e-0.p8.png
+- /ROMs/pico8/xzero-3.p8.png
+
+After this you just launch them like any regular game. You can also scrape many of these games using ScreenScraper, but you will need to refine the game names in most instances since most have filenames that the scraper service won't recognize. It's therefore recommended to run the scraper in interactive mode for these games or to scrape them one by one from the metadata editor.
+The second alternative for playing PICO-8 games is to run Splore to browse and launch games from inside the game engine user interface. To do this, first add a dummy game file to the ROMs/pico8 directory. It can be named anything but splore.png is recommended. The file content doesn't matter, it can even be an empty file. Following this, change to the alternative emulator PICO-8 Splore (Standalone) for this specific entry using the metadata editor. If you now launch the file, you will be brought straight to the Splore browser inside PICO-8.
+This is what the complete setup could look like:
+
+- /ROMs/pico8/c_e_l_e_s_t_e-0.p8.png
+- /ROMs/pico8/splore.png
+- /ROMs/pico8/xzero-3.p8.png

wiki-rtd/docs/wiki_emulator_guides/ppsspp-guide.md

@@ -1,5 +1,7 @@
 # Guide: PPSSPP
 
+<img src="../../wiki_images/logos/ppsspp-logo.png" width="150">
+
 WIP
 
 ## Where to put the games

wiki-rtd/docs/wiki_emulator_guides/retroarch-guide.md

@@ -1,3 +1,5 @@
 # Guide: RetroArch
 
+<img src="../../wiki_images/logos/retroarch-logo.png" width="150">
+
 WIP

wiki-rtd/docs/wiki_emulator_guides/ryujinx-guide.md

@@ -1,5 +1,8 @@
 # Guide: Ryujinx
 
+<img src="../../wiki_images/logos/ryujinx-logo.svg" width="150">
+
+
 WIP
 
 ## Where to put the games?

wiki-rtd/docs/wiki_emulator_guides/solarus-guide.md

@@ -1,5 +1,7 @@
 # Guide: Solarus
 
+<img src="../../wiki_images/logos/solarus-logo.svg" width="150">
+
 WIP
 
 ## Where to put the games

wiki-rtd/docs/wiki_emulator_guides/xemu-guide.md

@@ -1,5 +1,7 @@
 # Guide: XEMU
 
+<img src="../../wiki_images/logos/xemu-logo.png" width="150">
+
 WIP
 
 ## Where to put the games