aboutsummaryrefslogtreecommitdiff
path: root/libs/libbsarch/README.md
diff options
context:
space:
mode:
authorSulfurNitride <SulfurNitride@users.noreply.github.com>2026-02-11 02:37:39 -0600
committerSulfurNitride <SulfurNitride@users.noreply.github.com>2026-02-11 02:37:39 -0600
commit7ee008e150bc5bcf76082d726f719ee0fdfda982 (patch)
tree27fb39be241fdb5ac2734c574de678977d1856d0 /libs/libbsarch/README.md
Fluorine Manager: full Linux port of Mod Organizer 2
Complete native Linux port with FUSE-based virtual filesystem, Proton/umu-run integration, and Flatpak packaging. Key features: - FUSE VFS replacing Windows USVFS (in-process + standalone helper for Flatpak) - Proton/GE-Proton/umu-run launcher with env var forwarding - Flatpak support (sandbox-aware VFS, NXM handler, umu-run) - Wine prefix management UI - Case-insensitive path resolution for Linux filesystems - QSettings-safe INI handling (avoids Bethesda INI corruption) - Portable instance support with auto-generated launcher scripts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Diffstat (limited to 'libs/libbsarch/README.md')
-rw-r--r--libs/libbsarch/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/libs/libbsarch/README.md b/libs/libbsarch/README.md
new file mode 100644
index 0000000..671b6ff
--- /dev/null
+++ b/libs/libbsarch/README.md
@@ -0,0 +1,25 @@
+# BSArchive DLL and C++ bindings
+
+BSArchive Dynamic Link Library and C++ bindings
+
+## How to build
+
+1) Create a `XEditPath` environment variable and set it to the directory containing the XEdit code
+2) Build the DLL in Delphi by opening the `libbsarch.dproj` project
+3) Build the LIB in Visual Studio by opening the `libbsarch.sln` project
+
+## How to use
+
+With CMake:
+Use ``add_subdirectory`` and ``target_link_library``
+Then ``#include "libbsarch.h"`` for the C wrapper, or ``#include "bs_archive_auto"`` for the C++ wrapper.
+See the example for code use.
+
+Without CMake:
+Use `libbsarch.dll` (provided in delphi/lib), `libbsarch.lib` and `libbsarch.h` in your project.
+
+## Credits
+
+The original BSArchive can be found at: https://github.com/TES5Edit/TES5Edit/tree/dev/Tools/BSArchive
+The version in this project had been modified for better compatibility with C/C++ and
+allow the users to allocate their own memory in some cases.