ttwl-cli-saveedit 1.0.0

Description:

ttwlclisaveedit 1.0.0

Tiny Tina's Wonderlands Commandline Savegame/Profile Editor
This project is a commandline Python-based Wonderlands Savegame
and Profile Editor. It's based on apocalyptech's CLI editor for BL3,
and provides some very similar functionality. It can be used
to level up your characters, level up your gear, set character
stats (Hero Skills, Myth Rank), and unlock a variety of character
features early: feats/companions, second skill tree (including
re-selecting via Quick Change), Chaos Mode, SDUs, equipment slots,
and more.
This editor has only been tested on PC Savegames -- other platforms'
savegames are not supported at the moment.
Please keep the following in mind:

This app does not have any graphical interface. You must be
on a commandline in order to use it. (A rudimentary web interface
is available, though -- see below.)
The app has only very limited item-editing capability at the
moment, which is restricted to:

Item Levels can be changed
Chaos Level can be set on items
Enchantment Reroll count can be cleared


Unlike in BL3, when creating new savegames for Wonderlands, the
savegame GUID must be randomized, otherwise the game won't
recognize the new save. Therefore, rather than having a
--randomize-guid option for the save editor, this Wonderlands
version instead defaults to randomizing the GUID, and provides
a --dont-randomize-guid argument.
While I have not experienced any data loss with the app,
take backups of your savegames before using this, and
keep in mind that it could end up corrupting your saves. If
you do encounter any data loss problems, please contact me
and I'll try to at least fix whatever bug caused it.

Table of Contents

Web UI
Installation

Upgrading
Notes for People Using Windows
Running from Github
Finding Savegames


Editor Usage
TODO
Credits
License
Other Utilities
Changelog

Web UI
Abram Hindle, who took an early lead in getting this ported over to
Wonderlands, is providing a simple web-based version of this utility,
so feel free to give that a try:
https://abramhindle.github.io/ttwl-cli-saveedit/
Yes, this will install python and ttwl-cli-saveedit in your browser and
give you a tiny UI to dupe your savefiles or import items.
Installation
This editor requires Python 3, and has been
tested on 3.7 through 3.10. It also requires the protobuf package.
The easiest way to install this app is via pip/pip3. Once Python 3 is
installed, you should be able to run this to install the app:
pip3 install ttwl-cli-saveedit

Or, for Abram Hindle's development version:
pip3 install --user git+https://github.com/abramhindle/ttwl-cli-saveedit

Once installed, there should be a few new commandline utilities available
to you. The main editor is ttwl-save-edit, and you can see its possible
arguments with -h/--help:
ttwl-save-edit -h

There's also a ttwl-save-info utility which just shows some information
about a specified savefile. You can see its possible arguments with
-h/--help as well:
ttwl-save-info -h

If you've got a raw savegame protobuf file that you've hand-edited (or
otherwise processed) that you'd like to import into an existing savegame,
you can do that with ttwl-save-import-protobuf:
ttwl-save-import-protobuf -h

Alternatively, if you've got a savegame exported as JSON that you'd like
to import into an existing savegame, you can do that with
ttwl-save-import-json:
ttwl-save-import-json -h

Finally, there's a utility which is intended to be used to generate the
WL Savegame Archive Page.
This one won't be useful to anyone but apocalyptech, but you can view its
arguments as well, if you like:
ttwl-process-archive-saves -h

There are also profile-specific versions of most of those commands, which
can be used to edit the main BL3 profile.sav:
ttwl-profile-edit -h
ttwl-profile-info -h
ttwl-profile-import-protobuf -h
ttwl-profile-import-json -h

Upgrading
When a new version is available, you can update using pip3 like so:
pip3 install --upgrade ttwl-cli-saveedit

You can check your current version by running any of the apps with the
-V/--version argument:
ttwl-save-info --version

Notes for People Using Windows
This is a command-line utility, which means there's no graphical interface,
and you'll have to run it from either a Windows cmd.exe prompt, or presumably
running through PowerShell should work, too. The first step is to
install Python:

The recommended way is to install Python from python.org.
Grab what's available in the 3.x series (at time of writing, that's 3.9.4),
and when it's installing, make sure to check the checkbox which says something
like "add to PATH", so that you can run Python from the commandline directly.
If you're on Windows 10, you can apparently just type python3 into a command
prompt to be taken to the Windows store, where you can install Python with
just one click. I've heard reports that this method does not provide the
ability to add Python to your system PATH, though, so it's possible that
running it would be more complicated.

When it's installed, test that you can run it from the commandline. Open up
either cmd.exe or PowerShell, and make sure that you see something like this
when you run python -V:
C:\> python -V
Python 3.9.4

If that works, you can then run the pip3 install ttwl-cli-saveedit command
as mentioned above, and use the commandline scripts to edit to your heart's
content.
Notes for people on Steam Deck
Miniconda is a user space python distribution that works on Steam Deck.
Once you've installed it open a new terminal session and it's executables
will be in your path.
https://docs.conda.io/en/latest/miniconda.html
Running from Github
Alternatively, if you want to download or run the Github version of
the app: clone the repository and then install protobuf (you can
use pip3 install -r requirements.txt to do so, though a pip3 install protobuf
will also work just fine).
You can then run the scripts directly from the Github checkout, though
you'll have to use a slightly different syntax. For instance, rather than
running ttwl-save-edit -h to get help for the main savegame editor, you
would run:
python -m ttwlsave.cli_edit -h

The equivalents for each of the commands are listed in their individual
README files, linked below.
Finding Savegames
This app doesn't actually know where your savegames or profiles are located.
When you give it a filename, it'll expect that the file lives in your "current"
directory, unless the filename includes all its path information. When launching
a cmd.exe on Windows, for instance, you'll probably start out in your home
directory (C:\Users\username), but your savegames will actually live in a
directory more like C:\Users\username\My Documents\My Games\Tiny Tina's Wonderlands\Saved\SaveGames\<numbers>\.
The easiest way to run the utilities is to just use cd to go into the dir
where your saves are (or otherwise launch your commandline in the directory you
want). Otherwise, you could copy the save into your main user dir (and then
copy back after editing), or even specify the full paths with the filenames.
Editor Usage
Full documentation for both savegames and profiles are linked immediately below,
but as a quick example, here's a command to list information about 2.sav,
followed by an edit which saves out to a new 3.sav
ttwl-save-info -i 2.sav

ttwl-save-edit --name 'CoolNewName' --save-game-id 3 --level 40 2.sav 3.sav

For instructions on using the Savegame portions of the editor, see
README-saves.md.
For instructions on using the Profile portions of the editor, see
README-profile.md.
TODO

Unlock overworld abilities early?
Customization Randomization improvements:

Maybe would be nice to have a magic all value for --randomize-customizations
to assume that all customizations are available, rather than having to read
the list from a profile?
Allow only randomizing specific things? (Char, Emotes, Banner, etc). The
backend functions already support that.
Option to copy customizations from one char to another?
For that matter, would it be worth having an explicit customization-export
function which writes out just customizations to a file, which could then be
imported via a different arg/util? Probably not -- I think I'd probably just
content myself with copy-from-another-char, but something to think about.
Expose symmetry chance to CLI arg
I'd kind of like to do custom weighting on facial accessory randomization. I
personally tend to prefer being able to see the character's face to having it
covered up...


Would be nice to have some enchantment-setting functions in here.
Redo how we handle serial editing in datalib.py; it's super inefficient as-is
Use a smarter wrapper around challenge data -- pull them into a dict so that we can
alter them by name without having to loop through the whole list.
Might be nice to pull some common item-handling argparse options into cli_common.py.
The actual functionality is handled in there (levelling items, reroll counts, etc)
but there's a fair bit of duplicated code in cli_edit.py and cli_prof_edit.py
to handle argument parsing.
Relatedly, there's a silly amount of code duplication inside cli_common.py related
to properly pluralizing some of our item-editing user reporting. Would be nice to
roll that up a little more properly.
PS4 Support (for already-unlocked saves, anyway)
If we fail to read a savefile or profile, might be nice to actually check
if it's the other of profile-or-savefile, and give a more helpful message in
those cases.
Unit tests?

Credits
Abram Hindle took an early lead in
porting the BL3 CLI editor over to Wonderlands, which is much
appreciated! All the initial Wonderlands-support framework, and the
basic editor functionality is thanks to him.
The encryption/decryption stanzas in BL3Save.__init__ and BL3Save.save_to
were helpfully provided by Gibbed
(rick 'at' gibbed 'dot' us), so many thanks for that! The protobuf definitions
are also provided by Gibbed, from his
Borderlands3Protos repo,
and used with permission. Gibbed also kindly provided the exact hashing
mechanism used to work with weapon skins and trinkets.
The rest of the savegame format was gleaned from 13xforever/Ilya's
gvas-converter project: https://github.com/13xforever/gvas-converter
Many thanks also to Baysix, who endured an awful lot of basic questions about
pulling apart item serial numbers. Without their help, we wouldn't have
item level editing (or nice item names in the output)!
Many thanks to shroomz for figuring out the Myth Rank XP-to-Rank calculation.
Basically what I'm saying is that anything remotely "hard" in here is all thanks
to lots of other folks. I'm just pasting together all their stuff. Thanks, all!
License
All code in this project is licensed under the
zlib/libpng license. A copy is
provided in COPYING.txt.
Other Utilities
There aren't too many Wonderlands save editors in the wild yet. One
fork of FromDarkHell's BL3 Save/Profile Editor
is currently being maintained by a third party, though:

somefunguy's WL fork of FDH's Editor -
Written in C#, has EXE downloads for ease of use on Windows.

Changelog
v1.0.0 - October 15, 2022

Official 1.0 release!
Fixed up --fake-tvhm to handle some edge cases, and removed --unfinish-missions
Cleaned up documentation

v0.0.16

New extraction and update to chaos level 100

v0.0.15

Mythrank Updates thanks to Shroomz

v0.0.13

Updated DLC4 definitions

v0.0.12

Apocalyptech contributions

Adding missing Fealty Oath ring from DLC3
Shuffling this custom exception around -- I did want that to live inside TTWLProfile, I suppose.
Option to see chosen customizations with ttwl-save-info
Slight bit of rearranging, and making some fuctions behave a bit more consistently
Turns out the DLCs have some Ear Shape customizations I missed
Missing EarShape and Exception in the wrong place?
Version update
Fixing link
Oh yeah, one more thing I'd wanted to add
A few more things for the TODO
A few more comments -- I suppose I probably should've waited another few tens of minutes before committing originally. Ah, well.
Adding a bit of docs to this class
Add customization randomization
Updating this to take advantage of our simplified playthrough handling
Ah right, something else I'd wanted to look into
Rewording
May as well add that simple example back in to the main README; probably a good idea.
Get my savegame archive script up to theoretical snuff



v0.0.10

Mega patch from Apocalyptech

v0.0.9

Updated Inventory for Molten Mirrors (20220623)

v0.0.8

Added options to turn everything into chaotics, volatiles, or primordials

v0.0.7

Updated Inventory

v0.0.6

Updated Inventory
Added Primary and Secondary Class Reporting

v0.0.5

Changes to deploy it in the browser.

v0.0.4

Dealt with pet names. Missing profile.

v0.0.3

Updated from Gibbed's repo again for coiled captors. Made the profile info work.

v0.0.2

Updated the item defs from Gibbed from https://github.com/gibbed/WonderlandsDumps/blob/master/Inventory%20Serial%20Number%20Database.json

v0.0.1

Initial porting work to Tina Tiny's Wonderlands from
bl3-cli-saveedit v1.16.0