Skip to content

ozooma10/osf-animation

Repository files navigation

OSF Animation

OSF Animation is a native animation and scene-runtime framework for Starfield.

Key Features:

  • Synced multi-actor AF/GLTF/GLB playback
  • Engine-native Wwise loose-file audio playback (rides the game mix; no private-device fallback)
  • Actor anchoring/pinning in the world
  • A shared scene registry loaded from Data/OSF/**/*.osf.json
  • Player-control and camera locks
  • Optional full-screen fade effects
  • Equipment hide/restore and scene-scoped equip
  • Scene graphs with nodes, cues, actions, callbacks, and navigation

Documentation

Requirements

  • SFSE matching that game version.
  • Address Library for SFSE Plugins

Build (to compile from source)

  • XMake 3.0.0+
  • C++23 compiler, usually MSVC

Build

xmake f -m releasedbg
xmake

When XSE_SF_MODS_PATH is set, xmake installs the plugin and distribution files under:

%XSE_SF_MODS_PATH%\OSF Animation\

The Papyrus API is exposed as OSF.*.

Intellisense

xmake project -k compile_commands   

Test Harness

xmake build osf-import-test
osf-import-test.exe <file.glb>

xmake build osf-af-import-test
osf-af-import-test.exe <clip.af> <skeleton.rig>

These harnesses exercise the offline GLTF/GLB and AF import paths without launching the game.

License & Credits

OSF Animation is licensed under the GNU General Public License v3.0 (LICENSE), with an additional modding/linking exception - see EXCEPTIONS.

It adapts and builds on several open-source projects; full attributions and licenses are in THIRD_PARTY.md. Most notably:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages