README.md

CommonLibSF

A collaborative reverse-engineered library for Starfield

Requirements

• CMake v3.30+ or XMake v2.8.2+
  • Add this to your PATH
• vcpkg
  • Create a Windows environment variable called VCPKG_ROOT with the value as the path to your vcpkg install directory
• Visual Studio 2022 Build Tools
  • LLVM if using clang-cl presets
• PowerShell

Developing with CommonLibSF

Using the CommonLibSF plugin templates

• CLibSFPluginTemplate
  • Uses CMake. Consumes CommonLibSF as vcpkg port.
• commonlibsf-template-xmake
  • Uses XMake. Consumes CommonLibSF as an xrepo package, a git submodule, or a local fork.

Please see the Using CommonLibSF wiki page for more information about using CommonLibSF.

End-User Requirements

• Starfield Script Extender
• Address Library for SFSE Plugins

Notes

CommonLibSF is intended to replace SFSE as a static dependency. However, the runtime component of SFSE is still required.

You may download the PDB for the latest build of CommonLibSF via the Update PDB workflow. This is useful for importing the latest type information into IDA using the "Import PDB" feature.

License

GPL-3.0-or-later WITH Modding Exception AND GPL-3.0 Linking Exception (with Corresponding Source).

Specifically, the Modded Code is Starfield (and its variants) and Modding Libraries include SFSE (GitHub link).

It is recommended to read the FSF FAQ for a full explanation on what this license requires.

The main requirement of this license is: if you link your mod against CommonLibSF, and you distribute the binaries for that mod, you must also distribute the source code under the same license as CommonLibSF along with the source code for any other libraries you link against, with the exception of the Modded Code and Modding Libraries defined above.

Contributors

Credits

This work is based on CommonLibSSE created by Ryan-rsm-McKenzie under an MIT License. Without him putting that together, much of the joint Bethesda RE scene would be drastically different. The MIT License is kept for historical purposes only and the GPL governs this work. To the extent that you want the MIT licensed code, please reference CommonLibSSE and its forks.