/Sonic-Frontiers-Mod-Hub

This repo is an attempt to reduce fragmentation by serving as a central hub for Sonic Frontiers modding by providing convenient links to modding tools, guides on making mods and also linking high quality mods to help mod authors and players easily find what they need.

Primary LanguagePython

Logo

  • This repo is an attempt to reduce fragmentation by serving as a central hub for Sonic Frontiers modding. It provides convenient links to modding tools, guides, and high quality mods to help mod authors and players easily find what they need. It is not intended to replace any existing wiki, community or mod hosting site - but rather bring multiple resources together.
  • Contributions are greatly appreciated, please follow the existing formatting as a template!
  • Join the Hedgehog Engine Modding Discord.
  • Also see HedgeDocs.

Tools

Mods

File Structure

  • SonicFrontiers\image\x64\raw

    • \bmpfont\ : empty
    • \boss\ : boss textures, materials, models, levels and animations
    • \character\ : character textures models, materials and animations
    • \decotext\ : unknown
    • \dlc\ : additional content
    • \enemy\ : boss textures, materials, models and levels and animations
    • \event\ : real-time cutscenes/events?
    • \gedit\ : setdata/object layout
    • \general\ : unknown
    • \hedgehog\ : engine related level, debug, sound and fonts; mostly empty
    • \miniboss\ : mini boss textures, materials, models, levels and animations
    • \misc\ : miscellaneous textures and levels; needs to be looked into more
    • \movie\ : pre rendered custscenes
    • \navmesh\ : NPC navigation path meshes
    • \scalablefont\ : fonts
    • \script\ : various scripts and functions, .lua format is common
    • \sound\ : sounds and music
    • \stage\ : world/level textures, materials, models and LODs; most of the games textures can be found here
    • \text\ : subtitles, skills and other text popups
    • \texture_streaming\ : unknown, most likely engine related files for streaming in textures
    • \ui\ : user interface textures

  • Saves

    • YOUR_DRIVE\Users\%UserName%\AppData\Roaming\SEGA\SonicFrontiers\steam

  • Configs

    • Windows
      • %APPDATA%\Sega\SonicFrontiers\steam\x64\screen_setting.xml
      • %APPDATA%\Sega\SonicFrontiers\steam\<user-id>\option\optiondata
    • Linux
      • <Steam-folder>/steamapps/compatdata/1237320/pfx/

File Formats

  • USM: holds video.
  • PAC: Hedgehog Engine 2 compression format.

Video Guides

Text Guides

  • Model Ripping (credits to stix#1997)

    • First off, you're gonna want to extract the .pac files using HedgeArcPack
    • Depending on what pac file you extract there may be no textures, inorder to fix this, use SkythTools NeedleTextureStreamingPackage
    • Some .model files may need to be extracted using HedgeNeedle
    • Import the model using [Hedgehog Engine 2 Mesh Blender Importer] (https://github.com/Turk645/Hedgehog-Engine-2-Mesh-Blender-Importer). Extract the zip and install the py files instead of installing the zip.
    • Make sure after using Hedgeneedle, you copy the skl.pxd into the folder of the extracted models and rename the model to the same name as the skeleton except for extension, leave the skl.pxd files name the same

  • Maps Required For Textures

    • Abd = Albedo/Base Color Map
    • Nrm = Normal Map
    • Fal = Fresnel Color Map
    • CDR = Subsurface Scattering Color basically
    • Ems = Emission
    • PRM_R = Reflectivity (Specular F0)
    • PRM_G = Smoothness
    • PRM_B = Metalness
    • PRM_A = Ambient Occlusion

  • Audio Ripping (credits to ✨Kat✨#1234)

    • Tools needed
      • Sonic Audio Tools on Skyth's Github
      • Eternity Audio Tool
      • Foobar
      • VGMStream
      • Go to the .acb which you wish to extract (In this case for BGM you'll want to go into sound folder and find bgm.acb), drag and drop the .acb file onto AcbEditor.exe in Sonic Audio Tools and after a while you'll get a folder in the sound folder named after the .acb you just extracted, open it and you will see all of the audio files in .hca form.
      • To playback these tracks you will need Foobar2000 with VGMStream, install Foobar2000 and click on VGMStream and apply it. Then go to the main menu of Foobar2000, go to file and click open, press CTRL+A on the folder with all of the files you want to listen to and play them all back. If you wish to extract the audio, right click it, go to convert and quick convert, I recommend converting to either .wav or .ogg.
      • To edit the tracks, make sure you copy both of the extracted folder .acb and the original .acb to a different folder. Listen to the audio track you wish to use and use Foobar2000 to listen to the audio tracks in that folder, once you have the name of a track you wish to replace. Make a sound file (.wav/.ogg) you wish to replace that track with, open Eternity's Audio Tool 1.0b, click File and Convert to .hca, select the audio file you want to change into a .hca and rename it to the audio file you want to change inside of the extracted .acb folder. Then replace the track and drag and drop the extracted folder .acb onto AcbEditor.exe. You've now changed audio in Sonic Frontiers, you can do the rest.

  • Video Modding (written by Saviour 1#4257)

    • Tools Needed
      • Scaleform Video Encoder
      • ffmpeg + ff-prompt.bat
      • Your video (Needs to be 30FPS, and needs to be under or the same length as the original video.)
      • get the filename of the .USM you are going to replace
    • Place ff-prompt.bat in the root folder of your ffmpeg folder.
    • Add a folder with the name "video" to the "bin" folder. Place your video (30FPS) inside.
    • Start ff-prompt.bat.
    • do ffmpeg -i ./video/video.mp4 ./video/video.wav ./video/video%03d.tga. ffmpeg will now generate the frames as tga files, and the sound as a wav file.
    • Open Scaleform Video Encoder.
    • In the "Input Name", select video001.tga.
    • Scroll down to other audio and set it to "Mono/Stereo", and then find and choose video.wav.
    • On the right, set your Bitrate to 40000 kbps, and Framerate to 29.97 fps.
    • Enable Encode audio as HCA codec.
    • Press "Encode" at the bottom right of the window. Scaleform will now encode your video into HCA, and it will be located in the same folder as the tga and wav. It will be named video001.usm.
    • Rename video001.usm to whatever the filename of the USM from the game is. For example, zev_sonic_ring_max.usm.
    • Make a copy of zev_sonic_ring_max.usm and rename the copy to zev_sonic_ring_max_4k.usm. (You can make a 4K encode, but it's up to you.)
    • Create a mod in HedgeModManager with the path: "/raw/movie/"
    • Add both of your USM files to the /movie/ folder.

  • In-Game Text Editing

    • Tools Needed
    • Unpack the .pac file including the text you want using HedgeArcPack
    • Drag and drop the cnvrs-text file you want to edit onto PuyoTextEditor.exe. This will create an XML file with the same filename in the folder where you have the cnvrs-text file.
    • Edit the text that you want.
    • Open a Command Prompt, and navigate to the folder where you have PuyoTextEditor.exe. (The command for this is cd \<Directory>)
    • Run the following command: PuyoTextEditor.exe -f cnvrs-text <XML_FILE> where "<XML-FILE>" is the file you edited in step 3.
    • This will create a new cnvrs-text file in the same directory as the XML file.
    • Repack the files by dragging the directory including all the files for that pac onto HedgeArcPack.exe

FAQ

  • Q: How do I import the .model into blender?
    • A: Google "How to install a blender add-on and follow the tutorial", here's the plugin if you missed it.
  • Q: ALT+R isn't working in blender, why?
    • A: Turn off hotkeys/keybindings for AMD or NVIDIA overlays.
  • Q: My model is invisible, why?
    • A: Make sure your materials all have proper names. Don't leave them as the default.