/yoyoloader_vita

Primary LanguageCMIT LicenseMIT

YoYo Loader Vita

YoYo Loader is a loader for libyoyo.so, the official GameMaker Studio Runner application for Android, for the PS Vita.

YoYo Loader works by loading such ARMv7 executable in memory, resolving its imports with native functions and patching it in order to properly run.

This enables to run potentially any game made with GameMaker Studio.

What is supported

Type of Game Compatibility
Android Bytecode #c5f015 Native
Android YYC #c5f015 Native
PC/Console Bytecode #1589f0 Yes
PC/Console YYC #f03c15 No

For PC/Console exported games, you will need to perform an assets swap with a blank Android exported project with a Game Maker Studio version similar or equal of the one of the game you want to attempt to run. You can find a small guide on how to perform an Asset Swap here: https://gist.github.com/CatoTheYounger97/fa47e7eef92f772e4004d4dac22f9bdb

Note that patches to the bytecode may still be required in order to fix resolution, inputs or performances issues. Any game reported as #c5f015 Native, instead, will work with simple drag'n'drop of the apk.

A comprehensive Compatibility List can be found here: https://yoyo.rinnegatamante.it. You can contribute to it by opening an Issue here: https://github.com/Rinnegatamante/YoYo-Loader-Vita-Compatibility/issues.

If a game seems to be running out of memory, you can try to fix this issue by applying pngquant on images inside game.droid (A guide about this can be found here: https://gist.github.com/CatoTheYounger97/10db240958c9ba17af9069a7f8cc1716 ) or by externalizing musics and sounds loading. (A guide about music externalization can be found here: https://gist.github.com/CatoTheYounger97/517db5d15589fa3d20c7fa999dd4d9ef )

Keyboard keys emulation

YoYo Loader supports mapping of physical buttons to keyboard keys for those games that have not working controller code. It may be especially useful for PC asset swapped games.

A guide on how to set it up can be found here: https://gist.github.com/CatoTheYounger97/ce19685d349d913f9a2f097464453c97

Setup Instructions (For End Users)

In order to properly install the loader, you'll have to follow these steps precisely:

  • Install kubridge and FdFix by copying kubridge.skprx and fd_fix.skprx to your taiHEN plugins folder (usually ux0:tai) and adding two entries to your config.txt under *KERNEL:
  *KERNEL
  ux0:tai/kubridge.skprx
  ux0:tai/fd_fix.skprx

Note Don't install fd_fix.skprx if you're using rePatch plugin

  • Install libshacccg.suprx, if you don't have it already, by following this guide.
  • Games must be placed inside ux0:data/gms/GAMENAME, where GAMENAME must refer to the name of the game, in form of an apk file renamed as game.apk. You can get all the required files directly from your phone.
  • Inside the loader, you can also find a feature, by pressing Triangle in the game selector screen, to optimize the apk. Such feature will optimize compression of the files inside the apk to not cause stuttering and loading issues and will also remove any unnecessary file thus reducing the final apk size.

Build Instructions (For Developers)

In order to build the loader, you'll need a vitasdk build fully compiled with softfp usage.
You can find a precompiled version here: https://github.com/vitasdk/buildscripts/releases. Additionally, you'll need some libraries normally included in vdpm compiled with softfp. You can get most of the required ones here: https://github.com/Rinnegatamante/vitasdk-packages-softfp/releases. Finally, you'll need to recompile the few missing ones on your own:

  • openal-soft

    cd build
    cmake -DCMAKE_TOOLCHAIN_FILE=${VITASDK}/share/vita.toolchain.cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS=-mfloat-abi=softfp .. && make install
  • vitaGL

    make SOFTFP_ABI=1 NO_DEBUG=1 SAMPLER_UNIFORMS=1 CACHED_MEM=1 install

After all these requirements are met, you can compile the loader similarly to how the CI compiles it for nightly builds: https://github.com/Rinnegatamante/yoyoloader_vita/blob/main/.github/workflows/compilation.yml

Credits

  • TheFloW for the original .so loader.
  • JohnnyonFlame for GMSLoader used as reference for some implementations and for generic advices.
  • Once13One for the Livearea assets and the README showcase image.
  • hatoving for the German translation.
  • BetterWinds and SofyUchiha for the Spanish translation.
  • gl33ntwine for the Russian and Ukrainian translations.
  • Titi Clash for the Brazilian Portuguese translation.
  • kuragehime for the Japanese translation.
  • CatoTheYounger for providing most of the banners used in the game selector.
  • Everyone who contributed, tested and provided support over Vita Nuova Discord channel.