Skip to content

ThemModdingHerds/velvet-beautifier

Repository files navigation

Velvet Beautifier

Icon

Build (Debug) GitHub License

Mod Loader/Tool for Z-Engine games

Features

  • extract/create .tfhres/.gfs files
  • easy way of modifying .tfhres/.gfs files
  • install mods via:
    • files and links (.zip/.7z,/.rar/.gfs)
    • folders
    • GameBanana links/ids
    • URI Scheme
      • for GameBanana: velvetbeautifier:https://gamebanana.com/mmdl/<id>,Mod,<mod-id> Example
      • for anything else: velvetbeautifier:<url>

Possible Features

  • custom Stages (levels)
  • custom Pixel Lobbies
  • custom Color palettes

Planned features

  • GUI program
  • modding .tfhres a little bit easier

Usage

How do I use this?

Configurations (config.json)

CLI Icon The Command Line (VelvetBeautifier.CLI)
GUI Icon The Graphical User Interface does not exist yet

How do I make mods?

here

How does this work?

here

Frequently asked questions

Q: yo, you can add custom stages?
A: yes but you'll have to modify the worlds.ini and other mods might cause a conflict but I will work on making some kind of sub manager for custom stages

Q: when is the next update?
A: when I can work, I can't work 24/7

Q: can I modify base assets?
A: yes but I hope you know what you're doing

Q: can I get banned for using this?
A: maybe if you're unlucky or stupid like me but of course this is against their TOS so yeah...

Q: I modified a Pixel lobby but I am bugging out on servers
A: you've only changed the lobby on your side, the server should also have the custom lobby installed

Q: I installed a mod but nothing happenend after applying
A: Did you enable the mod?

Q: What's the backup folder and why is it taking so much space?
A: these are backups of games files, required for modding the game, if there's one missing, then you'll have to redownload the game (it means you modified it already without this tool)

3rd-Party Libraries

Building

You need the .NET 8.0 SDK and Visual Studio, open the solution and build. That's it

License

This tool is licensed under the GPL-3.0 license