mirror of
https://github.com/ModOrganizer2/libbsarch.git
synced 2026-07-27 14:06:31 -07:00
Mikaël Capelle
2a544ac3de
* Drop support for Qt. * Reorganize repository to build proper CMake targets. * Add pre-commit hook. * Add GH actions for linting, build and publish (on tag).
26 lines
931 B
Markdown
26 lines
931 B
Markdown
# 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.
|