Tutorial  Updated

wiiflow - my own tutorial to use it with emulators

hi, here is my tutorial for setting up wiiflow as an emulator frontend.

i wrote this cause i found a bit messy to rely on someone's other pack with settings already done,
instead here i'm using only original material... let's start!

my goal is to play super mario bros with a nes emulator using wiiflow.

step 0: your wii is already soft-modded with hbc installed, must have a sd card formatted in fat32.

step1: download all necessary files

download last official version of wiiflow from here:
https://github.com/Fledge68/WiiFlow_Lite/releases
you need two files:
https://github.com/Fledge68/WiiFlow_Lite/releases/download/v5.4.6/wf_internal_plugins.zip
https://github.com/Fledge68/WiiFlow_Lite/releases/download/v5.4.6/wiiflow_v5.4.6.zip

download wiiflow channel installer from here:
https://storage.googleapis.com/goog...om/wiiflow/WiiFlow_Channel_Installer_v1.1.zip

(optional) download a channel of your choice from here:
https://sites.google.com/site/wiiflowiki4/forwarder-channels

download last version of the rhapsodii shima theme from here:
https://gbatemp.net/threads/rhapsodii-shima-5-4.555062/

step2: copying all files to sd

unpack wiiflow_v5.4.6.zip, WiiFlow_Channel_Installer_v1.1.zip and rhapsodii shima theme to root directory of sd.
you have to install first the older files, cause newer have probably an updated version of platform.ini inside.
overwrite if requested.
copy the context of wf_internal_plugins.zip in sd\wiiflow\plugins\ directory
create a sd\rom\ directory
create a sd\rom\nes\ directory

step3: make some settings

in homebrew channel launch the channel installer app and install the channel. you'll use it when you have to exit an emulator and you want to return directly to wiiflow.
(optional, if you don't like the aspect of the channel installed you can install another channel with a wad manager, but AFTER this step 3)
now in your system menu you have a new icon for wiiflow. launch it.
after some time the program starts. press home button and go to settings.
on page 2 change theme from "default" to "rhapsodii shima"
on page 4 change return to channel from "disabled" to "WiiFlow"
on page 11 change source menu on start from "no" to "yes"
hit back, wiiflow should restart.
now press home button a couple of times to go again to settings
on page 12 enter source menu settings, change enable source flow from "off" to "on",
new options will appear, change sourceflow smallbox from "off" to "on", hit back.
now hitting B you can appreciate the beauty of this theme and go around to the different sections.
if everything works, press home button until you can shutdown wiiflow.

step4: preparing to emulate a game

the rom for super mario bros is already somewhere in your files, you know.
put supermariobros.zip in sd\roms\nes directory.
we can find a list of emulators for wii at this site:
https://wiibrew.org/wiki/List_of_homebrew_emulators
we choose to emulate super mario bros using last official fceugx release. you can find it here:
https://github.com/dborth/fceugx/releases/download/3.4.7/FCEUltraGX-3.4.7.zip

open the zip file, rename boot.dol to fceugx.dol and put it in sd\wiiflow\plugins\

step5: search for the right magic number

in sd\wiiflow\plugins_data\ find the platform.ini file and open it
you have to search a section which recalls the emulator you choose. here's what we find:
#FCEU GX
46434555=NES
56434555=FDS

46434555 is the magic number we must use. NES is the console code used to determine which type of covers to use.

step6: preparing a plugin ini file

we need one ini file for each emulator, we'll prepare one on the basis of the other ones we have.
go to sd\wiiflow\plugins\ directory and copy and rename wii.ini to fceugx-347.ini then open it.

[PLUGIN]
magic=4E574949
dolfile=boot.dol
arguments={device}:/{path}/|{name}
romdir=wbfs
rompartition=-1
filetypes=.wbfs
displayname=Wii
coverfolder=Wii
covercolor=ffffff
bannersound=
consolecoverid=

we must edit to this:

[PLUGIN]
magic=46434555
dolfile=fceugx.dol
arguments={device}:/{path}/|{name}|{loader}
romdir=roms/nes
rompartition=0
filetypes=.zip
displayname=Nintendo Entertainment System
coverfolder=nes
covercolor=ffffff
bannersound=
consolecoverid=NES

a) we've changed the magic number to what we found in platform.ini;
b) we've changed the name of dol file;
c) we've changed the arguments line (is requested by the emulator);
d) we've changed the romdir;
e) we've changed the rompartition to 0 (sd);
f) we've changed filetypes (zip is the format of our super mario bros rom);
g) we've changed the displayname (you can put what you want);
h) we've changed the coverfolder (see step 9);
i) we've changed the consolecoverid to what we found in platform.ini

step7: check/modify the theme

we have to be sure that the theme is pointing to the right magic number.
go to sd\wiiflow\source_menu\Rhapsodii Shima\ directory and open consoles.ini
this is the section which interest us:

[BUTTON_8]
autoboot=
cat_page=1
category=0
image=NES.png
image_s=NES.png
magic=46434D4D
source=plugin
title=NES

change magic number from 46434D4D to 46434555 and save it.

step8: play the game

now launch wiiflow, go to retro consoles section, choose NES and you should see your super mario bros game.
choose it and play it with A button.
home button, exit and ok to return to wiiflow. everything ok? we can go on.

step9: adding covers

you can add a cover for your game.
if you want a flat cover create sd\wiiflow\covers\nes
if you want a full cover create sd\wiiflow\boxcovers\nes

you can find full covers here:
https://gbatemp.net/threads/cover-collections-for-emulators-with-cover-support.324714/
and here:
https://gbatemp.net/threads/cover-collections-part-2.559649/
once downloaded find the right one and unpack it to sd\wiiflow\boxcovers\nes\
probably you have also to rename it.
if your rom is supermariobros.zip then your cover should be named supermariobros.zip.png
open wiiflow again and control if your cover is shown.
if not, press home button and try to reload the cache.

step10: adding some info
you can add info, a cart disk image and a snapshot to your game.
if you do this, your rom.zip isn't renamed but the name that appears on wiiflow maybe different (wiiflow is now using the database to name the games).

first download the files indicated in wii flow lite official thread:
https://www.mediafire.com/file/4blrpsqqn5g0bdu/Wiiflow_Database.7z/file
https://www.mediafire.com/file/xegmyb7uxid4nki/Wiiflow_CartDisk.7z/file
http://www.mediafire.com/file/6a563zva8c7weew/Wiiflow_Snapshots.7z/file
these are pretty big files but you can use only the portion that interest you (in our case, the Nes directory of every file).

open the database.7z file and extract only nes section in
sd\wiiflow\plugins_data\Nes\ directory
it should now contains NES.ini and NES.xml files.

open the cartdisk.7z file and find and extract yourgame_2d.png file in
sd\wiiflow\cart_disk\Nes\ directory

open the snapshot.7z file and find and extract yourgame.png file in
sd\wiiflow\snapshots\Nes\ directory

now, if you start wiiflow and choose your game, pressing + button should show some infos and images of super mario bros game.

if your rom is a patched or unofficial translated one, your game won't be probably recognised. whatever the reason you could try this:
you have to calculate the crc of your rom file using one of several tools available online and offline. one online is at:
https://toolslick.com/programming/hashing/crc-calculator
browse your file and calculate "CRC checksum in Hex", you'll obtain something like 2f05681f
open NES.ini file in sd\wiiflow\plugins_data\Nes and search for super mario bros game.
you'll find:
Super Mario Bros.=1245AA|A5C2849E|A1491AA1|B693999A|1D2F046F|7D5FAA58|3337EC46|E66...
1245AA is what interest us, the key code to the game, the rest are crc for the several versions of the game that exist.
you have to add 2f05681f in that line, separating your crc from the others by the | character.
Super Mario Bros.=1245AA|2f05681f|A5C2849E|A1491AA1|B693999A|1D2F...
now, save NES.ini file and delete gametdb_offsets.bin in the same directory.
now enter wiiflow, home button, reload cache and your game is now in the database.

if your cartdisk and snapshot image aren't recognised, what to do? remember the key code of super mario bros 1245AA in NES.ini?
rename your cartdisk image to 1245AA_2D.png
rename your snapshot image to 1245AA.png
it should work now.

it's also possible to add a trailer for each game but to me the space required is too big (around 30-40 megabytes per rom), please refer to danimal wiiflow tutorial if you are interested...

step 11: to thank all people
a great thanks to fledge68, wiimpathy, tetsuo shima, danimal and the others who made this possible!

edit: corrected some typos, updated step10
urbanman2004 has made an updated tutorial on the same topic, check at:
https://gbatemp.net/threads/tutorial-how-to-use-emulators-plugins-available-within-wiiflow.609568/
 
Last edited by spinoman,
Awesome guide; exactly what I was looking for. For those who want to launch games from USB, be sure to put in "1" for the rompartition, like so:

magic=46434555
dolfile=fceugx.dol
arguments={device}:/{path}/|{name}|{loader}
romdir=roms/nes
rompartition=1
filetypes=.zip
displayname=Nintendo Entertainment System
coverfolder=nes
covercolor=ffffff
bannersound=
consolecoverid=NES

On another note, I tried following the guide to setup wiimednafen to launch PCEngine ROMs. Everything works fine and Mednafen launches through WiiFLow, but instead of the selected game launching automatically, Mednafen is at the "Load" step. At which point I can manually choose a game and it works fine; however I'd prefer that the correct game automatically loads. Any tips on how I can do that?
 
On another note, I tried following the guide to setup wiimednafen to launch PCEngine ROMs. Everything works fine and Mednafen launches through WiiFLow, but instead of the selected game launching automatically, Mednafen is at the "Load" step. At which point I can manually choose a game and it works fine; however I'd prefer that the correct game automatically loads. Any tips on how I can do that?

you can try this:
download the last "official" wiiflow plugin pack from
https://storage.googleapis.com/goog...google.com/wiiflow/WiiFlow_Plugins_Pack_v7.7z
and use the mednafen version inside
(wiimednafen-mod3.dol 5222336 bytes).
it's the version i'm using and it works.
also make sure that the arguments line in your ini file is correct: this is what the loader uses to pass the rom to the emulator...
 
  • Like
Reactions: timewarpgamer
spinoman, thank you very much. I'm now launching from Wiiflow into Mednafen for pce engine games seamlessly. That plugin pack is also a big help, in general.
 
  • Like
Reactions: spinoman
For anyone else having trouble following Step #3, I took the liberty of tidying up spinoman's instructions from that section to be a little more coherent/explanatory — respectfully:
3)
* A new icon for Wiiflow should now be in your system menu; launch it.
* It should take some time for WiiFlow to load; press the 'Home' button once the program starts to go to 'Settings'.
* On page 2, change 'Theme' from "Default" to "Rhapsodii Shima".
* On page 4, change 'Return To Channel' from "Disabled" to "WiiFlow".
* On page 12, change 'Source Menu on start' from "No" to "Yes".
* Hit back; Wiiflow should restart.
* After Wiiflow restarts, press Back then the 'Home' button a few times to go to 'Settings' again.
* On page 12, enter 'Sourceflow settings'; change 'Enable Sourceflow' from "Off" to "On".
* After the new options appear, change 'Sourceflow Smallbox' from "Off" to "On"; hit Back.
* Once you hit the 'B' button, take an opportunity to marvel at the beauty of this theme and go around to tour different sections.
* If everything works as intended, go to the 'Wii menu' then press the 'Home' button until Wiiflow shuts down.
 
Last edited by urbanman2004,
  • Like
Reactions: spinoman
Does anybody know why some plugins will not launch as a plugin and others will only launch as a plugin?

I thought I might have damaged my quasi88 plugin when I attempted to launch it as a standalone but after verifying it's unchanged from the original file, I'm suspecting that this particular file only launches as a plugin.

Previously, I've had several emulators I tried to set up as plugins but was unsuccessful. I am now beginning to suspect that it's something to do with how it's programmed, or something else must be at play.

As an opposite example, I haven't been able to get Neko Project 2 to launch in WiiFlow as a plugin with any syntax I've tried so far (I was initially thinking that I just had to find the right syntax since many plugins show different syntax from each other).
 
  • Like
Reactions: 0arsoluto
Does anybody know why some plugins will not launch as a plugin and others will only launch as a plugin?

I thought I might have damaged my quasi88 plugin when I attempted to launch it as a standalone but after verifying it's unchanged from the original file, I'm suspecting that this particular file only launches as a plugin.

Previously, I've had several emulators I tried to set up as plugins but was unsuccessful. I am now beginning to suspect that it's something to do with how it's programmed, or something else must be at play.

As an opposite example, I haven't been able to get Neko Project 2 to launch in WiiFlow as a plugin with any syntax I've tried so far (I was initially thinking that I just had to find the right syntax since many plugins show different syntax from each other).
The question is very interesting, and due to my extensive experience working with Wiiflow, I think I can speak to the matter. That's right, my friend, the .dol file of a plugin is pre-configured with specific folder structures and characteristics. This means that if those folders and their contents aren't correctly placed in their directories, the program won't run and the game won't launch. That's undeniable, and in fact, you can modify .dol files (I haven't modified any myself). For example, my friend Superrsonic modified the .dol file for WiisXR Silver so that a different emulator configuration could be run by calling it from another configuration file. You can also achieve this, though not without some ingenuity, by creating your own folder paths. For example, I've managed to create two identical cover images in an arcade game category, one for a game on normal difficulty and the other for the exact same game on hardest difficulty. This is even more difficult because the game's difficulty isn't something directly achievable through emulator settings themselves, but rather through a specific configuration of MAME, for example; it's more hidden, so to speak.

For instance, getting OpenBOR games to run directly from Wiiflow was achieved through the use of arguments. The arguments define the path the .dol file uses, but it's not easy, especially for someone without computer knowledge. It's a process based on trial and error for beginners.

As for the NEC PC98 emulator, Neko Project 2, I've gotten it running through Wiiflow, and not only that, but also running with different configurations automatically. It all comes down to the arguments of the created plugins and the correct game configurations and hosting. Creating a solid and logical structure is the key, and it requires a lot of testing based on that trial and error.

When I finish those personal projects, I'll provide information that can serve as a guide for doing it with other .dol files, but it's almost an artistic endeavor for those of us without formal computer and programming knowledge.
 
The question is very interesting, and due to my extensive experience working with Wiiflow, I think I can speak to the matter. That's right, my friend, the .dol file of a plugin is pre-configured with specific folder structures and characteristics. This means that if those folders and their contents aren't correctly placed in their directories, the program won't run and the game won't launch. That's undeniable, and in fact, you can modify .dol files (I haven't modified any myself). For example, my friend Superrsonic modified the .dol file for WiisXR Silver so that a different emulator configuration could be run by calling it from another configuration file. You can also achieve this, though not without some ingenuity, by creating your own folder paths. For example, I've managed to create two identical cover images in an arcade game category, one for a game on normal difficulty and the other for the exact same game on hardest difficulty. This is even more difficult because the game's difficulty isn't something directly achievable through emulator settings themselves, but rather through a specific configuration of MAME, for example; it's more hidden, so to speak.

I don't think filepaths are the problem in this case, as I'm not changing those whatsoever. For example, I have two versions of quasi88, one of which works as a plugin but causes KP when launched standalone, and the other is not quite the opposite, however it works fine in standalone and launching as a plugin usually results in it launching the plugin version if it's present (even when you change the filenames), or if it's not present it will just return you to wiiflow.

With NP2, you briefly get a green screen just before the emulator crashes if you launch it as a plugin but works fine in standalone mode. All folder paths are kept the same.

For instance, getting OpenBOR games to run directly from Wiiflow was achieved through the use of arguments. The arguments define the path the .dol file uses, but it's not easy, especially for someone without computer knowledge. It's a process based on trial and error for beginners.

As for the NEC PC98 emulator, Neko Project 2, I've gotten it running through Wiiflow, and not only that, but also running with different configurations automatically. It all comes down to the arguments of the created plugins and the correct game configurations and hosting. Creating a solid and logical structure is the key, and it requires a lot of testing based on that trial and error.

Would you mind sharing which arguments you're using?

While the PC-98 emulation seems like it's missing some key elements, it does perform well enough that some games are playable (even some shooters, though they're definitely not full speed). The versions before beta 6 are not worth any effort IMO but the one performs well enough to play Rusty without too much frustration.

When I finish those personal projects, I'll provide information that can serve as a guide for doing it with other .dol files, but it's almost an artistic endeavor for those of us without formal computer and programming knowledge.

That’s great that you are working on some things you plan to share with the community however, I would humbly ask that you do not gate keep the information itself. Of course, I’m by no means suggesting that you change your release schedule nor that you share any personal discoveries you’re not ready to, but I would like access to the same information that you’re referring to for this project of yours.
 
Last edited by GhaleonX,
  • Like
Reactions: 0arsoluto
I don't think filepaths are the problem in this case, as I'm not changing those whatsoever. For example, I have two versions of quasi88, one of which works as a plugin but causes KP when launched standalone, and the other is not quite the opposite, however it works fine in standalone and launching as a plugin usually results in it launching the plugin version if it's present (even when you change the filenames), or if it's not present it will just return you to wiiflow.

With NP2, you briefly get a green screen just before the emulator crashes if you launch it as a plugin but works fine in standalone mode. All folder paths are kept the same.



Would you mind sharing which arguments you're using?

While the PC-98 emulation seems like it's missing some key elements, it does perform well enough that some games are playable (even some shooters, though they're definitely not full speed). The versions before beta 6 are not worth any effort IMO but the one performs well enough to play Rusty without too much frustration.



That’s great that you are working on some things you plan to share with the community however, I would humbly ask that you do not gate keep the information itself. Of course, I’m by no means suggesting that you change your release schedule nor that you share any personal discoveries you’re not ready to, but I would like access to the same information that you’re referring to for this project of yours.

Post automatically merged:

I don't think filepaths are the problem in this case, as I'm not changing those whatsoever. For example, I have two versions of quasi88, one of which works as a plugin but causes KP when launched standalone, and the other is not quite the opposite, however it works fine in standalone and launching as a plugin usually results in it launching the plugin version if it's present (even when you change the filenames), or if it's not present it will just return you to wiiflow.

With NP2, you briefly get a green screen just before the emulator crashes if you launch it as a plugin but works fine in standalone mode. All folder paths are kept the same.



Would you mind sharing which arguments you're using?

While the PC-98 emulation seems like it's missing some key elements, it does perform well enough that some games are playable (even some shooters, though they're definitely not full speed). The versions before beta 6 are not worth any effort IMO but the one performs well enough to play Rusty without too much frustration.



That’s great that you are working on some things you plan to share with the community however, I would humbly ask that you do not gate keep the information itself. Of course, I’m by no means suggesting that you change your release schedule nor that you share any personal discoveries you’re not ready to, but I would like access to the same information that you’re referring to for this project of yours.
 
I don't think filepaths are the problem in this case, as I'm not changing those whatsoever. For example, I have two versions of quasi88, one of which works as a plugin but causes KP when launched standalone, and the other is not quite the opposite, however it works fine in standalone and launching as a plugin usually results in it launching the plugin version if it's present (even when you change the filenames), or if it's not present it will just return you to wiiflow.

With NP2, you briefly get a green screen just before the emulator crashes if you launch it as a plugin but works fine in standalone mode. All folder paths are kept the same.



Would you mind sharing which arguments you're using?

While the PC-98 emulation seems like it's missing some key elements, it does perform well enough that some games are playable (even some shooters, though they're definitely not full speed). The versions before beta 6 are not worth any effort IMO but the one performs well enough to play Rusty without too much frustration.



That’s great that you are working on some things you plan to share with the community however, I would humbly ask that you do not gate keep the information itself. Of course, I’m by no means suggesting that you change your release schedule nor that you share any personal discoveries you’re not ready to, but I would like access to the same information that you’re referring to for this project of yours.
It's not that I don't want to share the files with you or that I'm hiding them. It's simply that I'm currently busy with the arcade project. One Wiiflow for arcade games to play on Tate and another for playing on Yoko. Looking into it and explaining it to you in detail would take me quite a while. It's not just a matter of sharing the arguments I use; it's more complex than that. I have to tell you where the configurations, BIOS, and other settings are located, and it's not easy to gather the information because the system for running the games with different configurations is quite complex in its structure. And as I said, I'm currently focused on the arcades. I'll get back to the NEC PC98 emulator when I finish it, and then I'll be able to give you detailed information without fear of giving you incorrect information due to lack of time. I must also mention that, throughout my experience with Wiiflow, this program, while wonderful, can be very capricious in its behavior. For example, the one I use for horizontal arcades has stopped loading the cover art I designed for the horizontal arcade Wiiflow, so I've had to use another Wiiflow I have to cache it so it appears in the arcade Wiiflow... typical Wiiflow stuff. I'm telling you this because for some reason, probably due to duplicate plugin numbers or the lists folder, or who knows what, this can also cause problems with the program and the execution of certain Wiiflow features, like emulators.
Post automatically merged:


My shoot 'em ups run well, even better than on the original NEC PC98. Two of the five Touhou games run perfectly, and I was working on the others when I paused the project, but they were progressing well. Games that require a lot of resources, like Atomic Punker, ran flawlessly. I haven't been able to test certain games yet because I can't find them in the vast PC98 catalog, but I've tested thousands. I've gotten Night Slave to run perfectly, even better than the real machine, along with dozens of other shoot 'em ups. And many puzzle games, including some that are now impossible to find. I've dedicated a lot of time to the NEC PC98 and its emulation on the Wii. I'll never abandon the project; I've only postponed it. The only one I haven't been able to get running yet is the flame zapper kotsujin, although I haven't exhausted all the configurations or changes in the BIOS structure (which varies depending on computer models, sound systems, and so on)
 
Last edited by 0arsoluto,

Site & Scene News

Popular threads in this forum