This project is a commandline Python-based Borderlands 3 Savegame and Profile Editor. It's a companion to the very similar CLI editor for BL2/TPS, and provides some very similar functionality. It can be used to level up your characters, unlock Mayhem modes early in the game, unlock TVHM, add SDUs, unlock 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:
Abram Hindle is providing a simple web-based version of this utility, so feel free to give that a try:
https://abramhindle.github.io/bl3-cli-saveedit/
Yes, this will install python and bl3-cli-saveedit in your browser and give you a tiny UI to dupe your savefiles or import items.
This editor requires Python 3, and has been tested on 3.9 through 3.12. 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 bl3-cli-saveedit
Once installed, there should be a few new commandline utilities available
to you. The main editor is bl3-save-edit
, and you can see its possible
arguments with -h
/--help
:
bl3-save-edit -h
There's also a bl3-save-info
utility which just shows some information
about a specified savefile. You can see its possible arguments with
-h
/--help
as well:
bl3-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 bl3-save-import-protobuf
:
bl3-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
bl3-save-import-json
:
bl3-save-import-json -h
Finally, there's a utility which I'd used to generate my BL3 Savegame Archive Page. This one won't be useful to anyone but me, but you can view its arguments as well, if you like:
bl3-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
:
bl3-profile-edit -h
bl3-profile-info -h
bl3-profile-import-protobuf -h
bl3-profile-import-json -h
When a new version is available, you can update using pip3
like so:
pip3 install --upgrade bl3-cli-saveedit
You can check your current version by running any of the apps with the
-V
/--version
argument:
bl3-save-info --version
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:
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 bl3-cli-saveedit
command
as mentioned above, and use the commandline scripts to edit to your heart's
content.
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 bl3-save-edit -h
to get help for the main savegame editor, you
would run:
python -m bl3save.cli_edit -h
The equivalents for each of the commands are listed in their individual README files, linked below.
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\Borderlands 3\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.
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.
__init__.py
; I
know that's not very Pythonic, but when dealing with extra-Python data
formats, one must sometimes make exceptions.setup.py
to pyproject.toml
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
Abram Hindle is responsible for getting a web version of this utility online (based on his ttwl-cli-saveedit fork for Wonderlands). Thanks!
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)!
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!
All code in this project is licensed under the zlib/libpng license. A copy is provided in COPYING.txt.
Various BL3 Savegame/Profile editors have been popping up, ever since Gibbed released the encryption details. Here's a few which could be more to your liking, if you didn't want to use this one for whatever reason:
A couple others exist but as of September 2022, are out of date and not really great for use on newer saves. Here they are, though, in case they get updated without me noticing:
In Memoriam: Baysix, the author of the original web-based editor at bl3editor.com, passed away in early 2021, and that editor is now permanently offline. RIP!
v1.19.0 - (unreleased)
v1.18.0 - July 19, 2024
pkg_resources
usage with
importlib.resources
equivalents.v1.17.0 - September 1, 2023
--copy-tvhm
option to copy TVHM state to NVHM.--inventory-wipe
inventory wipe option from ttwl-cli-saveedit
v1.16.0 - November 18, 2021
v1.15.1 - August 11, 2021
v1.15.0 - August 5, 2021
v1.14.0 - July 7, 2021
--mission-paths
to bl3-save-info
--delete-pt1-mission
and --delete-pt2-mission
to bl3-save-edit
v1.13.0 - June 24, 2021
--reverse
option for my Savegame Archive processing script, for some more
flexibility on the CSS when outputting HTMLv1.12.0 - April 11, 2021
--guardian-keys
, --vaultcard1-keys
, and --vaultcard1-chests
arguments
for profile editorv1.11.1 - February 12, 2021
v1.11.0 - February 1, 2021
v1.10.4 - January 21, 2021
v1.10.3 - January 21, 2021
v1.10.2 - November 10, 2020
v1.10.1 - November 10, 2020
v1.10.0 - November 9, 2020
v1.9.2 - October 8, 2020
v1.9.1 - September 30, 2020
v1.9.0 - September 10, 2020
v1.8.2 - July 27, 2020
v1.8.1 - July 14, 2020
--item-mayhem-max
and --item-mayhem-levels
will now apply Mayhem parts to
grenades as well as weapons.v1.8.0 - July 11, 2020
--mayhem-seed
option to bl3-save-edit
, to set the random seed used to
determine active Mayhem modifiers. The seed is now shown in the bl3-save-info
output, as well.v1.7.2 - July 6, 2020
v1.7.1 - June 29, 2020
v1.7.0 - June 26, 2020
--zero-guardian-rank
--min-guardian-rank
, --guardian-rank-rewards
, and
--guardian-rank-tokens
--unlock cubepuzzle
to reset the Eridian Cube puzzle in Desolation's Edge--clear-takedowns
to get rid of the Takedown mission-pickup notifications
for chars you never intend to do Takedowns with.bl3-process-archive-saves
to wipe out Guardian Rank entirelyv1.6.2 - June 18, 2020
v1.6.1 - June 13, 2020
bl3-profile-info
will now include the
"default" cosmetics which are always unlocked, so those counts match the numbers
in-game.v1.6.0 - June 11, 2020
--golden-keys
option to bl3-profile-edit
, to set available Golden Keys--randomize-guid
option to bl3-save-edit
v1.5.2 - May 23, 2020
--csv
option to allow importing/exporting items into CSV files,
instead of just text files (which is the default without --csv
). Has no effect
except on item imports/exports.v1.5.1 - May 5, 2020
bl3-process-archive-saves
to clear out some 3rd-playthrough data
which earlier versions had accidentally introduced (only really of interest
to myself)v1.5.0 - April 28, 2020
--item-mayhem-max
will set items to the max Mayhem level (10
), or
--item-mayhem-levels <num>
will set a specific level (0
to remove Mayhem
from items entirely).v1.4.0 - April 23, 2020
bl3-profile-edit
,
bl3-profile-info
, bl3-profile-import-json
, and bl3-profile-import-protobuf
.
The following functionality is supported:
bl3-save-info
- introduced individual arguments to
show more detailed information as-requested, instead of only having a
global -v
/--verbose
option:
-i
/--items
argument, to show inventory information--fast-travel
argument, to show unlocked fast travel stations--all-challenges
argument, to list all challenges in the save file
and their statuses (note: this will be over 1.5k items!)--all-missions
argument, to list all completed missions in addition
to active ones-v
/--verbose
now implies the four options above.bl3-save-info
will now also report on whether the savegame has finished the
main game or any of the DLCs.--unfinish-nvhm
option to bl3-save-edit
, to completely clear out
any TVHM data and pretend that NVHM was never finished.v1.3.1 - April 14, 2020
v1.3.0 - April 14, 2020
json
output type, to export the protobuf as encoded into JSONbl3-save-import-json
utility, to load JSON into a savegamev1.2.2 - April 12, 2020
v1.2.1 - April 12, 2020
v1.2.0 - April 12, 2020
--items-to-char
or --item-levels
--allow-fabricator
option.bl3-save-info
output-V
/--version
flag to show version numberv1.1.1 - April 7, 2020
v1.1.0 - April 7, 2020
bl3-save-import-protobuf
command, to load a raw protobuf file
into an existing savegame.v1.0.1 - April 5, 2020
bl3-save-info
related to that.v1.0.0 - April 5, 2020