Tool RPGM RPG MV and MZ Linux and OSX Porter [v1.3]

m4kro · Jan 18, 2024

Please Read the instructions and FAQ if you plan on using it. DO NOT PUT GAME ISSUES HERE!!!

This is a tool/script that I developed to streamline the RPG MV and MZ porting process. It is meant to be a run and forget solution that does most of the work for you. If there are any issues please post them in this thread.
Painless Porter (0.1) (GUI version): (releases will be much slower as CLI version is currently prioritized)

You must be registered to see the links

Instructions for Painless Porter are on GitHub page

Porter (1.3) (Google Colab Version):
Possible to be banned by Colab! Use at your own risk!

You must be registered to see the links

Porter (1.3) (CLI version):

You must be registered to see the links

Features
Does all the extracting, repackaging, and archiving for you
Choose nwjs version on linux
Unpack Game_EN.exe and apply patch
Decrypts files
Rencodes images into webp
Rencodes audio to opus
Does the uploading for you
Creates ports for Linux, OSX x64, and OSX arm64
Prevents case insensitive issues on Linux ports
Adds a cheat menu to the game
Updates pixijs
nwjs sdk version
Cleanup after uploading is finished
Docker image for easy setup and ability to run on all systems
WebUI for easier use

Planned Features
Less jank
Better WebUI
Apply OrangeGreenworks.js crack
error detection

You don't have permission to view the spoiler content. Log in or register now.

Instructions
The Google Colab version is recommended as it sets up the environment for you.
Simply

You must be registered to see the links

and make a copy of the colab as it says. Then follow the included instructions.

You don't have permission to view the spoiler content. Log in or register now.

Once the script is done there will be two files, gofile.txt and pixeldrain.txt
These contain the download links to the ports, note that the link order is:
Windows + Linux link
OSX x64 link
OSX arm64 link

You don't have permission to view the spoiler content. Log in or register now.

m4kro · Feb 2, 2024

Announcement:
The Docker image and WebUI have been released. They are still in very early development and if you want to contribute please do so on the GitHub repo.

Also I may remove Gofile uploading or make it optional in the future due to the extremely limited time/life of each file.

sweatycuk77 · Feb 7, 2024

Tried using Apple silicon version of Scars of summer, heres what happened :

is damaged and can’t be opened. You should move it to the Trash.

m4kro · Feb 7, 2024

sweatycuk77 said:
Tried using Apple silicon version of Scars of summer, heres what happened :

is damaged and can’t be opened. You should move it to the Trash.

Did you port it using the tool or did you download it from here?

For game issues please put them here. Also please attach a screen shot.

m4kro · Feb 23, 2024

Announcement
CLI version 0.5 has been released
nwjs has been downgraded to v0.78.1 to hopefully prevent texture issues
the

You must be registered to see the links

will be applied automatically, can be disabled with --no-cheats

Print1727 · Feb 24, 2024

Coming from https://f95zone.to/threads/68528/post-13029473.

Hello again. I checked out your porter.

In my opinion, you should not distribute the ports with NWJS and instead let the user provide their own instead.
(This will make it not a port but just sharing game files though...)

Directory structure:

Code:

tree -L 2
.
├── 68528 Tower of Ardia 2022-09-24
│     ├── Game
│     ├── package.json
│     ├── RJ283271_img_main.webp
│     └── www
└── NWJS
      ├── chrome_crashpad_handler
      ├── credits.html
      ├── icudtl.dat
      ├── lib
      ├── locales
      ├── nw
      ├── nw_100_percent.pak
      ├── nw_200_percent.pak
      ├── resources.pak
      ├── swiftshader
      ├── v8_context_snapshot.bin
      └── www

The www directory in the Game directory is the one that contains all the game files, while the one in the NWJS directory is empty and only act as a mount point.

The Game file:

Code:

#!/usr/bin/env bash

if command -v fusermount > /dev/null 2>&1
then
    echo "FUSE found."
    www_dir=$(find . -type d -name "www" -print -quit)
    if [ -n "$www_dir" ]
    then
        echo "'www' directory found."
        cp ./package.json ../NWJS/package.json & wait $!
        echo "Mounting..."
        ../NWJS/lib/cicpoffs ./www ../NWJS/www
    fi
else echo "FUSE not found. Game will launch as case sensitive."
fi

if [[ "$XDG_SESSION_TYPE" == "wayland" ]]
then
    echo "Launching as a Wayland application."
#     ../NWJS/nw --ozone-platform=wayland; # Performance degradation
    ../NWJS/nw --ozone-platform=x11
else echo "Launching as a X11 application."; ../NWJS/nw --ozone-platform=x11
fi
if command -v fusermount > /dev/null 2>&1
then
    www_temp=$(find ../NWJS -type d -name "www" -print -quit)
    if [ -n "$www_temp" ]
    then
        echo "Unmounting..." &
        fusermount -u ../NWJS/www & wait $!
        rm ../NWJS/package.json
    fi
fi
echo "Finished."

This reduce storage space significantly as user won't have multiple NWJS on their computer. NWJS can also be updated easily.

Tested working (on my machine).

m4kro · Feb 24, 2024

Print1727 said:
Coming from https://f95zone.to/threads/68528/post-13029473.

Hello again. I checked out your porter.

In my opinion, you should not distribute the ports with NWJS and instead let the user provide their own instead.
(This will make it not a port but just sharing game files though...)

Directory structure:

Code:

tree -L 2 . ├── 68528 Tower of Ardia 2022-09-24 │ ├── Game │ ├── package.json │ ├── RJ283271_img_main.webp │ └── www └── NWJS ├── chrome_crashpad_handler ├── credits.html ├── icudtl.dat ├── lib ├── locales ├── nw ├── nw_100_percent.pak ├── nw_200_percent.pak ├── resources.pak ├── swiftshader ├── v8_context_snapshot.bin └── www

The www directory in the Game directory is the one that contains all the game files, while the one in the NWJS directory is empty and only act as a mount point.

The Game file:

Code:

#!/usr/bin/env bash if command -v fusermount > /dev/null 2>&1 then echo "FUSE found." www_dir=$(find . -type d -name "www" -print -quit) if [ -n "$www_dir" ] then echo "'www' directory found." cp ./package.json ../NWJS/package.json & wait $! echo "Mounting..." ../NWJS/lib/cicpoffs ./www ../NWJS/www fi else echo "FUSE not found. Game will launch as case sensitive." fi if [[ "$XDG_SESSION_TYPE" == "wayland" ]] then echo "Launching as a Wayland application." # ../NWJS/nw --ozone-platform=wayland; # Performance degradation ../NWJS/nw --ozone-platform=x11 else echo "Launching as a X11 application."; ../NWJS/nw --ozone-platform=x11 fi if command -v fusermount > /dev/null 2>&1 then www_temp=$(find ../NWJS -type d -name "www" -print -quit) if [ -n "$www_temp" ] then echo "Unmounting..." & fusermount -u ../NWJS/www & wait $! rm ../NWJS/package.json fi fi echo "Finished."

This reduce storage space significantly as user won't have multiple NWJS on their computer. NWJS can also be updated it easily.

Tested working (on my machine).

I decided to include the nwjs files to make the experience as easy as possible for players. No setup needed, download and play. But I do see what you mean by how this wastes lots of disk space. I'll probably go with your solution and also have start.sh check ~/.nwjs/ for the nwjs files and if its not there then download it.

I will also start a poll later to see if others also think it's a good idea.

Print1727 · Feb 24, 2024

m5kro said:
I decided to include the nwjs files to make the experience as easy as possible for players. No setup needed, download and play. But I do see what you mean by how this wastes lots of disk space. I'll probably go with your solution and also have start.sh check ~/.nwjs/ for the nwjs files and if its not there then download it.

I will also start a poll later to see if others also think it's a good idea.

Sounds good. But please not another dot file. I have enough of them.
Maybe using '~/.local/share/porter/nwjs' and having an updater/version chooser is a better idea.

Also the way the original script handles MZ is not ideal. You should package MZ game files into the www directory like with MV instead.

Print1727 · Feb 25, 2024

m5kro you can check out

You must be registered to see the links

for ideas.

m4kro · Feb 25, 2024

Print1727 said:
m5kro you can check out
You must be registered to see the links
for ideas.

Looks great! I'll add all of it in soon.

m4kro · Feb 26, 2024

Announcement:
CLI version 0.7 has been released

You must be registered to see the links

You don't have permission to view the spoiler content. Log in or register now.

The next version will likely be version 1.0 with all the planned features except for the GUI stuff.

m4kro · Feb 26, 2024

Announcement:
A GitHub repo has been created for the shell scripts of the CLI version. If anyone wants to make changes please create a pull request there. Changes with files too large for github will need to be done here.
You can find the repo

You must be registered to see the links

.

Print1727 · Feb 26, 2024

m5kro can you provide an example of texture issues that nwjs v0.78.1 may(?) fix.

m4kro · Feb 26, 2024

Print1727 said:
m5kro can you provide an example of texture issues that nwjs v0.78.1 may(?) fix.

Touch The Bio-Unit Lady [v1.01] [egig ere faundation], Using nwjs 0.83.0 caused major graphical issues with incorrect texures.
I've also seen a few things like missing background textures for some games but those are usually minor and not as extreme as the example above.

Maybe upgrading pixijs would fix it?

Print1727 · Feb 27, 2024

m5kro said:
Touch The Bio-Unit Lady [v1.01] [egig ere faundation], Using nwjs 0.83.0 caused major graphical issues with incorrect texures.
I've also seen a few things like missing background textures for some games but those are usually minor and not as extreme as the example above.

Maybe upgrading pixijs would fix it?

I'm playing it (not really, I don't know how to play this...) on NWJS v0.84 and there doesn't seems to be any issues, even before upgrading Pixi.

m4kro · Feb 27, 2024

Print1727 said:
I'm playing it (not really, I don't know how to play this...) on NWJS v0.84 and there doesn't seems to be any issues, even before upgrading Pixi.

Nvm figured it out. Newer versions of nwjs weren't playing well with my laptops dual gpu setup. Will go with latest nwjs (0.84.0) as default now and users can change to 0.78.1 if they also run into the same issues.

Print1727 · Feb 27, 2024

m5kro said:
Nvm figured it out. Newer versions of nwjs weren't playing well with my laptops dual gpu setup. Will go with latest nwjs (0.84.0) as default now and users can change to 0.78.1 if they also run into the same issues.

I tested on a dual GPU laptop. I just don't use the dGPU at all because I just don't want to deal with Nvidia specific issues.

m4kro · Mar 3, 2024

Announcement
Version 1.0 has been released!
Big thanks to Print1727/Revival8697 for ideas and parts of the code.

You must be registered to see the links

You don't have permission to view the spoiler content. Log in or register now.

m4kro · Mar 29, 2024

Announcement
A google colab version of porter has been released! This helps simplify the process and move everything into the cloud for free. Instructions are included.

You must be registered to see the links

gfurst · Apr 2, 2024

This looks really useful, but another thing I like included could be the MV/MZ text hooker for those who want to play japanese games, its the thing that takes the most work imo.

Tool RPGM RPG MV and MZ Linux and OSX Porter [v1.3]

Member

Member

New Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Active Member