Files
libbsarch/README.md
T
G'k 77a6be7bcb Wrote a complete OOP wrapper, as well as a convenience class
Added CMake support
Added clang format configuration
Reorganized the file structure, removed VS files
2020-01-04 21:53:31 +01:00

23 lines
930 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.