Running the renderer server

Why is this in the FFL-Testing repo under another branch? This server is built off of the FFL-Testing sample by Abood (or in other words, hackily patched from it).

I keep telling myself that, after a rewrite, it can be moved into its own repo, so bare with me...

1. Follow the instructions included below, which are also in master.
   • I don't think the server portion will work on a Wii U due to use of hardcoded OpenGL calls here, so don't try.
   • Get to the point where it shows you spinny Mii heads.
   • ... But if you are running on a VPS/headless system, see step 4.
2. The service requires two parts: the renderer, which is in ffl_testing_2, and the web server. You'll need to run either the Python or the Go web server.
   • Python
     • Needs Flask, also note that it's more limited in features and performance
     • Run server-impl/ffl-testing-web-server-old.py
   • Go
     • Inside server-impl just go run . or run the Go file
3. Make sure FFL-Testing is running and listening, and try a request like this to the server: http://localhost:5000/miis/image.png?data=005057676b565c6278819697bbc3cecad3e6edf301080a122e303a381c235f4a52595c4e51494f585c5f667d848b96&width=512
4. If that works, great! Keep these in mind:
   • If you are hosting this, always use the --server argument when running.
     • Hides the window, doesn't swap buffers, and pauses when idle.
   • If you are running this on a VPS, build with OSMesa support so that you don't have to run an X11 server.
     • Build and also pass in optimizations into CMake: -DCMAKE_CXX_FLAGS="-O3 -march=native" -DRIO_USE_OSMESA=ON
     • Note that OSMesa does NOT support hardware rendering, and should only be used if you don't have a GPU! If you do, you'll need to constantly run Xvfb or something.

5. Advanced: If you want to "scale" this... (longer, so read more)

• .. My only solution is to run multiple processes right now.
  • This actually needs my nwf-mii-cemu-toy, ffl-renderer-proto-integrate branch.
  • Clone it like so: git clone -b ffl-renderer-proto-integrate https://github.com/ariankordi/nwf-mii-cemu-toy, build and run.
• I recommend setting this up as a systemd socket activated, instanced service.
  • This means you can run it like so: systemctl start ffl-testing@31100 - where 31100 is the port number, which you can change, and also enable the service to start it at boot.
  • You will need to rebuild, once again, with USE_SYSTEMD_SOCKET as a def.
    • If you're following along on your VPS, it's this: CXXFLAGS="-O3 -march=native" DEFS="-DRIO_USE_OSMESA -DUSE_SYSTEMD_SOCKET" make
  • Edit ffl-testing@.service. Adjust the WorkingDirectory, ExecStart (program path), and potentially user.
  • Copy the systemd units in this repo: sudo cp ffl-testing@.service ffl-testing@.socket /etc/systemd/system/

Please be aware of the limitations to this in production - probably won't scale well. * TBD: Improved accuracy (accurate per-bone body scaling), server rewrite, multi-threading, all-in-one renderer and HTTP server in the same binary.

Note: For the frontend on mii-unsecure.ariankordi.net, I am using nwf-mii-cemu-toy, ffl-renderer-proto-integrate branch as the HTTP server for now, where I've more or less copied the Go server. It supports load balancing to multiple instances of this server. That is where my client-side HTML, JS, and NNID fetch API and more are hosted, so if you want to rehost any of that, PLEASE see that repo's readme!

FFL-Testing

Sample using the FFL decomp and RIO framework, all originally written by AboodXD, to render Miis on PC and Wii U via WUT.

Screen.Recording.2024-10-16.at.8.34.31.PM.mp4

• Note that it's a known issue for Mii textures to look corrupted on Wii U. This does not happen with the original decompilation, only the RIO branch.

Running

1. Clone the repo, recursively.

   git clone --recursive https://github.com/ariankordi/FFL-Testing
   

If you forgot or want to update, then after git pull, do this: git submodule update --init

2. Install requirements.

   This project needs GLFW3 and zlib. The commands below will install them.

   • Ubuntu/Debian: sudo apt install libglfw3-dev zlib1g-dev libgl1-mesa-dev
   • Fedora/RHEL: sudo dnf install glfw-devel zlib-devel mesa-libGL-devel
   • Arch/Manjaro: sudo pacman -S glew glfw zlib (⚠️ UNTESTED)
   • Windows MSYS2 MINGW64: pacman -S mingw-w64-x86_64-glfw mingw-w64-x86_64-zlib
     • Make sure to also install the basics: pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake mingw-w64-x86_64-pkg-config (untested)
   • Windows MSVC/Visual Studio: Use vcpkg. Follow Microsoft's tutorial...
     • ... and then: vcpkg install glfw3 zlib
     • Don't forget to pass CMAKE_TOOLCHAIN_FILE when you use vcpkg with CMake. Read here for more info: https://learn.microsoft.com/en-us/vcpkg/users/buildsystems/cmake-integration

3. Build using the CMake.

   If you don't already have them, you will also need: git, g++, cmake, pkg-config.

   cmake -S . -B build  # Configure project.
   cmake --build build  # Compile to "build".
   

   Here are some additional things to know.

   • To list options, use cmake -LH.

     • To apply an option: cmake -S . -B build -DRIO_GLES=1 -DNO_GLTF=1, etc.

   • Settings:

     • Build type: cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
     • CXXFLAGS/Optimizations: cmake -S . -B build -DCMAKE_CXX_FLAGS="-O3 -march=native"
     • LDFLAGS, you may need to add some if you see undefined reference to symbol...:
       • cmake -S . -B build -DCMAKE_EXE_LINKER_FLAGS="-ldl" (Needed on Debian 11??)
     • Jobs: cmake --build build -j4 (4 = num of jobs/cores)

   • Clean:

     • To clean, delete build like: rm -r build
     • (be careful, make sure that really IS the folder you're deleting)

   • (On Visual Studio: As long as you have vcpkg configured and everything installed, it should? just work by loading the folder)

4. Obtain the resource file, FFLResHigh.dat.

   • This contains the meshes and textures needed to render Mii characters and is absolutely required to get anywhere with this.
   • You can get it from many sources:
     • It can be extracted from a Wii U using an FTP program:
       • sys/title/0005001b/10056000/content/FFLResHigh.dat
     • You can extract it from a Miitomo install (it's not in the APK/IPA):
       • In cache (Library/Application Support/cache on iOS), here: res/asset/model/character/mii/AFLResHigh_2_3.dat
     • It can also be downloaded from archive.org:
       • https://web.archive.org/web/20180502054513/http://download-cdn.miitomo.com/native/20180125111639/android/v2/asset_model_character_mii_AFLResHigh_2_3_dat.zip
       • Extract the above and rename AFLResHigh_2_3.dat to FFLResHigh.dat.
     • (As well as AFLResHigh_2_3.dat, AFLResHigh.dat will work too. All AFL resources have to be renamed to FFLResHigh.dat.)
     • In the Kadokawa breach, there is a Wii U tool called FFLUtility, located here: dwango/projects/マルチデバイス/品証/WiiU/Tool/FFL/downloadimage/FFLUtilityJP_p01 - if you decrypt it with dev keys, then in fs/content/nonproduct/miicapture/resource/, you will find FFLResPoster.dat. This is a copy of FFLResHigh.dat with extremely high quality (512px) textures. If you successfully find this, share the love and enjoy.
   • Place that file in the root of this repo.
     • This file contains models and textures needed to render Miis and this program will not work without it.

5. Run ffl_testing_2, and pray that it works.

   • If it crashes with a segfault or shows you a blank screen, make sure you have FFLResHigh.dat and it can open it.

Showing your own Miis

As of 2024-06-14, I added a change that would let you change which Miis this program renders, by reading files in the place_ffsd_files_here folder.

As the name implies, you should be able to take any Mii in a 96 byte FFSD/FFLStoreData file, and place it in that folder.

• Only the length of the file is checked, not the extension or name. It needs to be 96 bytes.

• Then, it will just read each file sequentially, looping through all of them.

• You can also just put one file there and that one Mii will spin continuously.

If you don't have any FFSD files...

• You can search for any *.ffsd or *.cfsd (CFLStoreData = FFLStoreData) file in this repo:

  • https://github.com/HEYimHeroic/MiiDataFiles

• Grab the Mii from your Nintendo Network ID using the mii-unsecure.ariankordi.net API, if it is still up by the time you are reading this.

  • curl --verbose --header "Accept: application/octet-stream" https://mii-unsecure.ariankordi.net/mii_data/JasmineChlora --output JasmineChlora.ffsd
    • Replace JasmineChlora with your own NNID, of course.

• I believe this script decrypts Mii QR Code data directly to FFSD/CFSD format: https://gist.github.com/jaames/96ce8daa11b61b758b6b0227b55f9f78

  • I use it with ZBar like so: zbarimg --quiet --raw --oneshot -Sbinary image.jpg | python3 mii-qr.py /dev/stdin ./mii.ffsd
    • Replace: image.jpg, mii.ffsd
  • I also made a scanner in JS, though it gives you Base64 that you have to decode: https://jsfiddle.net/arian_/h31tdg7r/1/

Compiling GLFW3

GLFW3 is needed to run any RIO application on PC, which this is.

If you can't install it (not on Linux or MSYS2), or need the latest version, let's build it.

(You probably don't need to follow these)

GLFW3:

• git clone https://github.com/glfw/glfw && cd glfw
• cmake -S . -B build
  • If you are cross compiling, append: -D CMAKE_TOOLCHAIN_FILE=CMake/x86_64-w64-mingw32.cmake -D CMAKE_INSTALL_PREFIX=/usr/local/x86_64-w64-mingw32/
• cmake --build build -j8
• (sudo) cmake --install build

Now it should be available to pkg-config

Try: pkg-config --libs zlib glfw3

(Unless it complains about needing glu)

If you are still reading

NOTE from 2024-06-02: To cross compile this from Linux to Windows, I used the following command: TOOLCHAIN_PREFIX=x86_64-w64-mingw32- make LDFLAGS="-L/dev/shm/glfw/build/src/ -lz -L/dev/shm/glew/lib/ -lglew32 -lglfw3 -lopengl32 -lgdi32 -lws2_32

Where I have glew and glfw built at /dev/shm.

While pkg-config worked, letting me need only the TOOLCHAIN_PREFIX set, for whatever reason it wasn't building and threw lots of linking errors saying it couldn't link tons of symbols from glew32 even though it literally finds it and opens the library, so... IDK.