Skip to content

Latest commit

 

History

History
105 lines (94 loc) · 5.91 KB

README.md

File metadata and controls

105 lines (94 loc) · 5.91 KB
Raw

MAXWELL

MAXWELL is an ingame ImGui overlay for the game ANIMAL WELL, featuring an inventory editor, warping map, cheats etc.

It has been tested on the 2024-10-31 version 1.0.0.20 on Windows 10. This is the only version officially supported by the latest autobuild, but it might work for older or newer versions too. There might also be compatibility releases for older versions available in the release section, but those probably won't have the latest features.

Please go away if you haven't finished the game, this will spoil everything for you.

Disclaimer

I shouldn't have to tell you, but you should back up your save file before using a random experimental tool you found on the internet, but there you go. This can cause irreversible damage to your save file, but probably won't if you don't do it on purpose. If you care about your Steam achievements, you should probably use some kind of Steam Emulator before poking around with this, as it doesn't block achievements yet. Your antivirus will probably not like this tool because of the dll injection aspect, but you can handle that like you want to. This is not a virus, but you probably shouldn't believe a random file on the internet telling you that either...

Usage

  • Build with cmake or get the Autobuild
  • Put MAXWELL folder inside the game folder and run MAXWELL.exe from there
    • You can also run or create a shortcut to MAXWELL.exe --launch_game .. to launch the game automatically
    • Check --help for other command line switches
  • MAXWELL.dll also works with other generic DLL injectors
  • Also works with Wine 9 / Proton 9
  • You can also rename MAXWELL.dll to xinput9_1_0.dll and place it next to Animal Well.exe to load it without the injector
    • Use the Steam launch options PROTON_USE_WINED3D=1 WINEDLLOVERRIDES="xinput9_1_0=n,b" %command% to load this on Proton
  • Doesn't seem to work with some builds of Goldberg's emulator if it has overlay enabled
    • To fix this, create a Animal Well/steam_settings/disable_overlay.txt file

Features

  • Spoilers
  • Please go away if you haven't finished the game
  • Edit most things in player inventory in real time
  • Input any coordinates to warp
  • Right click anywhere on screen to teleport
  • Godmode
  • Noclip without cring
  • Save anywhere
  • Adjust window scaling
  • Disable fog of war / darkness
  • Disable spot lights
  • Force bright or funny room palette
  • Hide the game hud
  • Hide the player character
  • Play in b&w gameboy mode
  • Take unobstructed screenshots for mapping
  • Always Groundhog Day mode
  • Minimap
    • Right click to warp to rooms
    • Reveal whole minimap ingame
    • Warp to other dimensions
    • Show other dimension outlines
    • Track wheel position
    • Show destroyed tiles
  • Pause and frame advance
    • PgUp to toggle
    • PgDn to skip one frame
  • Rudimentary runtime level editing
    • WIP
    • Change water level
    • Middle click to pick tile from room
    • Left click to place tile
    • Mouse4 to mark tiles destroyed
    • Hold shift for background layer or fixing destroyed tiles
    • Search for tiles by ID in the current map
    • Highlight and mass replace found tiles
    • Import map files exported from the level editor at runtime
      • Static tiles will update instantly, dynamic tiles need a room reload
  • Bunny sequencer
    • WIP
    • Plays the flute automatically based on pixels on the mural
    • Blues and reds are half notes, beiges full notes
    • Take out the flute to play your song while in the room
  • Keyboard remapping
    • Disable all undocumented game keys and remap your own
    • All hud elements should also display correctly for most keys (all alphanumeric + space)
    • Numpad is left untouched at the moment and works normally

Mods

  • WIP, untested, these things might still change on a whim
  • Loads correctly named and formatted loose files recursively from MAXWELL/Mods
  • No error checking
  • All original maps, assets and textures can be dumped with MAXWELL or the level editor
    • Edited current state of maps can also be dumped with MAXWELL
    • Edited light params (asset 179) can also be dumped with MAXWELL
  • Supports 3 types of modded files (all files in a mod must be placed in one of these subdirectories)
    • Map mods in [Mod Name]/Maps/X.map where X is a map index in 0..4
    • Full asset mods in [Mod Name]/Assets/Y.whatever where Y is an asset number as dumped by the editor
    • Texture atlas mods in [Mod Name]/Tiles/Z.png where Z is a texture number as dumped by the editor, or maybe at least matching an accompanying asset 254 (the texture atlas descriptor)
  • Behavior with multiple conflicting mods is undefined, but probably at least one of the conflicing files will be loaded
  • Behavior with unexpected file formats is almost definitely crashing
  • Examples:
    • MAXWELL/Mods/Epic mod/Maps/0.map replaces well map
    • MAXWELL/Mods/Epic mod/Assets/101.ogg replaces dog barks with farts
    • MAXWELL/Mods/Epic mod/Assets/179.ambient replaces the light params
    • MAXWELL/Mods/Epic mod/Tiles/416.png replaces only the beanie texture in main texture atlas
    • MAXWELL/Mods/Epic mod/Tiles/365.png replaces another thing in main texture atlas
    • MAXWELL/Mods/Bad mod/Assets/255.png replaces whole main texture atlas (don't do this, it's dumb and not compatible with multiple mods)
  • These are the only asset file types currently tested, but others might also work
  • MAXWELL.exe has to be the one launching the game to hook the asset loading functions early
    • This can be done with the --launch_game command line switch or putting it in the right folder and just hitting enter when it asks
    • Or you can use the xinput shim (see Usage)
    • Mods won't load correctly if you just launch the game from Steam and have MAXWELL searching for processes