josefnemec/playnitedocs

Playnite manual and SDK documentation sources.

Playnite documentation

This repository contains sources for Playnite manual and SDK documentation.

Building

• install Docfx
• install .NET Framework 4.6.2 developer pack
• navigate to docs folder
• run docfx metadata (needed to re-run only when Playnite subrepo is updated)
• run docfx build

To start local server: docfx serve

playnitedocs's Issues

Add explanation of how metadata sources ordering work for metadata download

Mentioned in https://www.reddit.com/r/playnite/comments/16zm9lj/new_user_manual_is_now_available_your_feedback_is/ldv0gtf/

Image alignment

Images should be generally aligned to corresponding paragraph, they currently always align to page border which looks weird in several places, for example where there are multiple steps listed, images don't align to them properly.

Not sure if this can be changed in markdown or if it will require CSS changes.

Add keyboard and controller mapping section to Fullscreen mode introduction page

Similar how it's done with desktop mode: https://api.playnite.link/docs/manual/gettingStarted/playniteDesktopMode.html#keyboard-shortcuts

Some images have white dots in corners

I'm guessing this is because they were taken on Windows 11 with rounded borders, it's noticeable with dark theme.

https://api.playnite.link/docs/manual/gettingStarted/images/playniteDesktopMode_GroupingSorting.png

Manual header directs to command line page

Clean up an unify use of headings

Use of heading could use some improvements:

• various levels used on various pages inconsistently
• some headings having underline, others not on other pages in the middle of an article
• some heading levels not being set properly to show up in right hand "In this article" menu

I'm not listing any specific pages because it would be imo better to just go through all of it at once.

Issue with RetroArch handling save files / save states for compressed games when launched via Playnite

Noticed an issue with how RetroArch handles save files / save states for specific cores and image formats, if compressed, when launching RA via Playnite.

Issue

If RetroArch is launched via Playnite, save files / save states that were created in RetroArch when RA is launched directly are not recognized if the game files are compressed (i.e. zip, 7z, etc.). Additionally, save files / states created while running RA launched via Playnite are recognized only when running via Playnite and not by RA when launched directly.

Findings

This may be due to the way RA handles compressed folders. When RA is launched directly, it appears to unzip the contents of the game before launching the game and then rezipping them afterwards. When launched via Playnite, it behaves differently. Below is a direct example.

Example

You have a legal backup of Fire Emblem for Game Boy Advance (GBA) in a folder called Fire Emblem (GBA).zip and inside that folder is a file called Fire Emblem (USA).gba. When launching RetroArch directly it will create save files with the string Fire Emblem (USA).srm (if save file compression is enabled in RA) and Fire Emblem (USA).sav because that is the file name of the .gba file. If you launch the game through Playnite however, it will create save files with the string Fire Emblem (GBA).srm and Fire Emblem (GBA).sav because that is the file name of the .zip folder that the .gba file is inside of. The same thing occurs with save states using the extension .state.

Solution

This can be resolved by simply naming the rom itself with the exact same file name as the zip folder it is saved in (i.e. Fire Emblem (GBA).gba saved inside a zip folder called Fire Emblem (GBA).zip) as the difference in naming is what causes the underlying issue. Else, you could simply unzip all of your roms, however you lose compression and thus increase the overall file size of your library.

Alternatively, there may be an argument that fixes this discrepancy, however after discussing it with the admin on the official Playnite Discord, this may not be an option. The proposed alternate solution might also be to have Playnite unzip the rom prior to launch, but this is untested and may not be feasible for all cores / configurations of RA.