OpenBLCMM

OpenBLCMM is a fully-opensource fork of the Borderlands Community Mod Manager, which is the tool for managing text-based mods for Borderlands 2 and The Pre-Sequel. BLCMM was written by LightChaosman with some contributions from other community members and officially released in 2018. In 2022, LightChaosman opensourced the "core" BLCMM code on github. In 2023, OpenBLCMM development was started to fix up some longstanding issues with BLCMM, and to provide a fully-opensource version of the entire BLCMM application.

Download / Install

Downloads can be found here:

• OpenBLCMM Releases: https://github.com/BLCM/OpenBLCMM/releases
• Object Explorer Datapacks: https://github.com/BLCM/OpenBLCMM-Data/releases

NOTE: OpenBLCMM is not compatible with the original BLCMM game data packages. New prepackaged data files are available at the link above. To use those datapacks, download and save them inside the same directory as OpenBLCMM.exe/OpenBLCMM.jar. OpenBLCMM should see the data on the next startup and have them available for use.

Changelog

A Changelog can be found at src/CHANGELOG.md.

User Data Location

OpenBLCMM needs to store some information on the filesystem as it runs. This includes things like application preferences, logfiles, patch file backups, and extracted Object Explorer data. You can access the log directory using the "Open Log Dir" button on the Help -> About dialog, and the patch backups can be accessed via a button on the various file dialogs. If you want to know the location in general, though, here they are:

• Windows: %LOCALAPPDATA%\OpenBLCMM (Most likely something like C:\Users\[username]\AppData\Local\OpenBLCMM, though some systems might also include OneDrive in the path there.)
• Linux: ~/.local/share/OpenBLCMM (This should honor the $XDG_DATA_HOME environment var, as well.)
• Mac: ~/Library/Application Support/OpenBLCMM

Commandline Arguments

There are a few commandline arguments which can be used with OpenBLCMM. Most users can safely ignore these. These args can be specified from cmd.exe or your usual shell, or added to GUI shortcuts.

Creator Mode

Creator Mode is mostly just intended for people actively developing OpenBLCMM, and is enabled by default when run via the Netbeans IDE. It can be toggled on with the -creator argument, such as:

java -jar OpenBLCMM.jar -creator

The effects of Creator Mode are:

• Will use the current directory to store preferences, logfiles, backup files, etc (instead of using %LOCALAPPDATA% or ~/.local/share, for instance)
• Does not do new-version checks while starting
• Will not attempt to import original BLCMM settings on first startup

Setting User/Install Directory

These settings are similar in nature, and were put in place while investigating some options for Mac app bundling. The -userdir=<foo> argument will set the current "user directory," which is ordinarily only really used to provide shortcut buttons in the File dialogs. If you have Creator Mode active, this will also determine where the app's prefs/logfiles/backups are stored. It can be enabled like so:

java -jar OpenBLCMM.jar -userdir=dirname

The -installdir=<foo> argument overrides the app's understanding of where its Jarfile is, and is mostly just used to figure out where to look for Object Explorer Datapacks. It can be enabled like so:

java -jar OpenBLCMM.jar -installdir=dirname

Opening Mod Files

You can also specify a filename at the end of the argument list to have OpenBLCMM open up that file initially. This should allow you to drag mod files on top of the app icon, too, when interacting via a GUI.

java -jar OpenBLCMM.jar patch.txt

If you want to open a mod file whose filename starts with a dash, you'll have to do the usual UNIX/Linux convention of first putting a double-dash in front of the filename. Any argument after that double-dash will be interpreted as a filename, not another argument:

java -jar OpenBLCMM.jar -- -a_mod_file_with_a_dash.blcm

Development

We've got a document with notes about developing OpenBLCMM if you'd like to help out, want to build it yourself, or are just curious. Enjoy!

Bugs / Feature Requests / TODO

Bugs, Feature Requests, and TODO type things should all be tracked at the OpenBLCMM Github Issues page. If an Issue has a target-* tag applied to it, it's slated to be taken care of by the specified release number in the tag -- if not, we haven't really prioritized it yet. Note, of course, that priorities can change, and those target tags might come and go over time.

Contributions

The Borderlands Community Mod Manager was developed by LightChaosman, and the majority of the code in this project remains his! Many thanks to him for opensourcing the core BLCMM code in 2022. Apocalyptech's taken the recent lead in 2023 of building up the OpenBLCMM fork. Other contributors to both BLCMM and OpenBLCMM throughout the years have included: apocalyptech, apple1417, Bugworm, c0dycode, FromDarkHell, and ZetaDæmon. Thanks, too, to the countless members of the community who have contributed by testing, providing support, and spreading the word. Apologies to anyone we've missed!

Third-Party Content

OpenBLCMM makes use of the following third party libraries/resources:

• Java Libraries:
  • StidOfficial's SteamVDF library for some Steam data parsing, available under the GPLv3.
  • Apache Commons Text and Apache Commons Lang, available under the Apache License v2.0.
  • Xerial's sqlite-jdbc, available under the Apache License v2.0.
  • Vincent Durmont's semver4j, available under the MIT License.
  • CommonMark's commonmark-java, available under the 2-clause BSD License.
  • Rob Camick's ScrollablePanel.java, available without restriction.
• Resources:
  • Custom Assault on Dragon Keep icon from Julia @ steamgriddb.com, used with permission.
  • Some icons from Dave Gandy's Font Awesome set, available under CC BY 3.0.
  • An icon from Fathema Khanom's User Interface set, available under Flaticon's Free License.
  • An icon from Smashicons' Essential Collection set, available under Flaticon's Free License.
• Toolset:
  • Apache Netbeans is the development environment
  • GraalVM Native Image / Liberica NIK provides Windows EXE compilation
  • Visual Studio provides the C++ compiler for GraalVM/Liberica
  • Winrun4j provides a utility to set icons on Windows EXEs
  • Inno Setup is used to create the Windows installer

License

OpenBLCMM is licensed under the GNU General Public License v3. A copy can be found at LICENSE.txt.