Skip to content

Instantly share code, notes, and snippets.

@apocalyptech
Created May 23, 2024 13:42
Show Gist options
  • Save apocalyptech/b2a70ecad774c423b992157246f6b424 to your computer and use it in GitHub Desktop.
Save apocalyptech/b2a70ecad774c423b992157246f6b424 to your computer and use it in GitHub Desktop.
CLI Animal Well Savegame Editor
positional arguments:
filename Savefile to open
options:
-h, --help show this help message and exit
-i, --info Show known information about the save
--fix, --fix-checksum
Update the savegame checksum, even if no other edit
actions have been specified.
-s {0,1,2,3}, --slot {0,1,2,3}
Operate on the specified slot (specify 0 for "all
slots")
--import FILENAME, --import-slot FILENAME
Import slot data from a standalone file into the
specified slot. The file must be exactly 159,760
bytes, though no other checking is done for validity.
The import will be done prior to any other specified
actions.
--export FILENAME, --export-slot FILENAME
Export the specified slot data to a standalone file.
The file will not be loadable by Animal Well directly,
but can be imported into a different save. The export
will be done after any other specified actions.
-f, --force When exporting slot data, do not prompt to confirm
overwriting a file
--health HEALTH Sets health (number of hearts)
--gold-hearts GOLD_HEARTS
Sets the number of gold hearts
--spawn X,Y Room coordinates to spawn in. Specify two numbers with
a comma inbetwen them, such as "11,11" for the main
hallway.
--steps STEPS Set the number of steps taken
--deaths DEATHS Set the number of deaths
--saves SAVES Set the number of times-saved
--bubbles-popped BUBBLES_POPPED
Set the number of bubbles popped
--ticks TICKS Set the number of ticks that have elapsed in-game (by
both internal measures)
--ticks-copy-ingame Overwrite the with-paused tick counter to just ingame
time
--egg-enable {reference,brown,raw,pickled,big,swan,forbidden,shadow,vanity,service,depraved,chaos,upside_down,evil,sweet,chocolate,value,plant,red,orange,sour,post_modern,universal_basic,laissez_faire,zen,future,friendship,truth,transcendental,ancient,magic,mystic,holiday,rain,razzle,dazzle,virtual,normal,great,gorgeous,planet,moon,galaxy,sunset,goodnight,dream,travel,promise,ice,fire,bubble,desert,clover,brick,neon,iridescent,rust,scarlet,sapphire,ruby,jade,obsidian,crystal,golden,all}
Enable the specified egg. Can be specified more than
once, or use 'all' to enable all
--bunny-enable {tutorial,origami,crow,ghost,fish_mural,map,tv,uv,bulb,chinchilla,bunny_mural,duck,ghost_dog,dream,floor_is_lava,spike_room,all}
Enable the specified bunny. Can be specified more than
once, or use 'all' to enable all
--bunny-disable {tutorial,origami,crow,ghost,fish_mural,map,tv,uv,bulb,chinchilla,bunny_mural,duck,ghost_dog,dream,floor_is_lava,spike_room,all}
Disable the specified bunny. Can be specified more
than once, or use 'all' to enable all
--respawn-consumables
Respawn map consumables (fruit and firecrackers)
--clear-ghosts Clear all ghosts from the map
--respawn-ghosts Respawn ghosts to the map
--respawn-squirrels Respawn squirrels to the map
--firecrackers FIRECRACKERS
Set the number of firecrackers in your inventory. Will
unlock the Firecracker equipment as well, if not
already active
--keys KEYS Set the number of keys in your inventory
--matches MATCHES Set the number of matches in your inventory
--light-candles {room_04_06,room_08_06,room_04_07,room_06_07,room_06_09,room_15_09,room_05_13,room_10_13,room_16_13,all}
Light the specified candles. Can be specified more
than once, or use 'all' to enable all
--equip-enable {firecracker,flute,lantern,top,disc,wand,yoyo,slink,remote,ball,wheel,uvlight,all}
Enable the specified equipment. Can be specified more
than once, or use 'all' to enable all
--equip-disable {firecracker,flute,lantern,top,disc,wand,yoyo,slink,remote,ball,wheel,uvlight,all}
Disable the specified equipment. Can be specified more
than once, or use 'all' to disable all
--inventory-enable {mock_disc,s_medal,house_key,office_key,e_medal,pack,all}
Enable the specified inventory item. Can be specified
more than once, or use 'all' to enable all
--inventory-disable {mock_disc,s_medal,house_key,office_key,e_medal,pack,all}
Disable the specified inventory item. Can be specified
more than once, or use 'all' to disable all
--teleport-enable {frog,fish,bear,dog,bird,squirrel,hippo,all}
Enable the specified teleport. Can be specified more
than once, or use 'all' to enable all
--map-enable {unlock_map,unlock_stamps,unlock_pencil,all}
Enable the specified map feature. Can be specified
more than once, or use 'all' to enable all
--reveal-map Reveals the entire map on the minimap
--clear-map Clears the entire map on the minimap
--clear-pencil Clears any pencil drawings on the minimap
--clear-stamps Clears any stamps on the minimap
--pencil-image-export FILENAME
Exports the current pencil minimap layer as an image
with the specified filename. The image export will
always be the "full" image size, not just the playable
area.
--pencil-image-import FILENAME
Import the specified image filename to the minimap
"pencil" layer. The image will be blindly resized to
the minimap size without respect to aspect ratio. The
usual import area is 800x528, or 640x352 when using
`--pencil-image-playable`. The image will be converted
to monochrome and dithered. To prevent major artifacts
when passing in pre-dithered monochrome images, be
sure to use the exact image dimensions.
--pencil-image-playable
When importing an image to the pencil layer, only
import into the playable area, rather than the entire
map space.
--pencil-image-invert
When importing an image to the pencil layer, invert
the black/white pixels.
--mural-clear Clear all mural pixels to the background color
--mural-default Revert the mural to its default state
--mural-solved Set the mural to its solved state
--flame-collect {b,p,v,g,all}
Mark the specified flames as collected (but not placed
in the pedestals). Can be specified more than once, or
use 'all' to do all at once
--flame-use {b,p,v,g,all}
Mark the specified flames as used (but not placed in
the pedestals). Can be specified more than once, or
use 'all' to do all at once
--upgrade-wand Upgrade the B. Wand to B.B. Wand
--downgrade-wand Downgrade the B.B. Wand to B. Wand
--unlocks-enable {stopwatch,pedometer,pink_phone,souvenir_cup,origami,two_rabbits,owl,cat,fish,donkey,deco_rabbit,mama_cha,giraffe,incense,peacock,otter,duck,all}
Enable the specified global unlockable. Can be
specified more than once, or use 'all' to enable all
--unlocks-disable {stopwatch,pedometer,pink_phone,souvenir_cup,origami,two_rabbits,owl,cat,fish,donkey,deco_rabbit,mama_cha,giraffe,incense,peacock,otter,duck,all}
Disable the specified global unlockable. Can be
specified more than once, or use 'all' to disable all
--egg65-enable Enable Egg 65
--egg65-disable Disable Egg 65
--cring-enable Enable C. Ring
--cring-disable Disable C. Ring
--quest-state-enable {house_open,closet_open,unlock_map,unlock_stamps,unlock_pencil,defeated_chameleon,cring,used_s_medal,bb_wand,egg_65,used_e_medal,defeated_bat,freed_ostrich,defeated_ostrich,fighting_eel,defeated_eel,shrine_no_disc,statue_no_disc,all}
Enable the specified quest state flag. These are
generally not recommended to mess with by hand --
various flags in here are already wrapped up in
dedicated arguments. Messing with them could cause
strange behavior ingame. Caveat emptor! Can be
specified more than once, or use 'all' to enable all.
--quest-state-disable {house_open,closet_open,unlock_map,unlock_stamps,unlock_pencil,defeated_chameleon,cring,used_s_medal,bb_wand,egg_65,used_e_medal,defeated_bat,freed_ostrich,defeated_ostrich,fighting_eel,defeated_eel,shrine_no_disc,statue_no_disc,all}
Disable the specified quest state flag. These are
generally not recommended to mess with by hand --
various flags in here are already wrapped up in
dedicated arguments. Messing with them could cause
strange behavior ingame. Caveat emptor! Can be
specified more than once, or use 'all' to disable all.
--dont-fix-disc-state
When enabling the Disc (in equipment) or Mock Disc (in
inventory), this utility will attempt to normalize the
game's quest variables to prevent ghost dog spawning
and other progression weirdness. To avoid making these
corrections, specify this argument. Without this
option, the utility will *not* allow you to enable
both the Disc and Mock Disc at the same time, since
there is no valid game state with that combination.
Note that the quest state alterations happen *after*
this fix, so you can also manually set those flags
with that option.
--prefer-disc-shrine-state
When enabling the Disc equipment, with fixing disc
state enabled (see `--dont-fix-disc-state` option
above), by default this utility will set the game
state to having swapped the Mock Disc at the first
statue. To instead fix the state to having moved the
Mock Disc to the M. Disc Shrine, specify this option.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment