Skip to content

jackburkhardt/ObsidianKnapper

Repository files navigation

ObsidianKnapper

This tool allows you to unpack narrative content from your favorite Obsidian Entertainment games. Discover cut content, translate games to your language, or explore all of the niche possibilities.

In particular, OEIKnapper can read quests, conversations, global variables, and string tables. To read other assets, please use your unpacking tool of choice depending on the game engine.

Currently supported games include:

  • Pentiment
  • The Outer Worlds
  • Pillars of Eternity II
  • South Park: The Stick of Truth

Check the Wiki page to see detailed game support.

How to Use

  1. Download the latest release of ObsidianKnapper
  2. Get your desired games' assets into a readable form:

Pentiment & POEII Pentiment and POEII are Unity games and they appear to store their narrative data in plain text, so no extra steps are necessary.

Stick of Truth No extra steps are necessary.

Outer Worlds (and other Unreal games) You will need to find a tool which can unpack Unreal Engine asset files. Extract them to a separate folder within the game's install directory.

When you're unpacking assets, look for assets with the following file extensions:

  • .conversationasset
  • .conversationbundle
  • .stringtablebundle
  • .questbundle
  • .globalvariablebundle
  • .oaf
  • .conversationbundle
  1. Run ObsidianKnapper and select the game's data folder. If the game's install location isn't automatically detected, manually locate it.
  2. Start poking around!

State of the Project

This is still a work in progress. Depending on the game, its engine, or the version of OEI it was developed with, the structure of these files may vary. The reference game for development is Pentiment since it is recent and its narrative files are in cleartext.

Writing changes back to the original game files does work but game functionality is not guaranteed. This is an area where help is needed.

Check out the wiki for documentation, feature timeline, and more.

Project Structure

  • OEIKnapper - The main project, intended to be a 1:1 representation of the datatypes used in OEI. OEI is the tool used by Obsidian for creating dialogue.
  • OEIKnapperGUI - A WPF application that runs a GUI for the project.
  • OEIKnapperTests - Tests for various functions of OEIKnapper.

Licensing & redistribution

This is a fan-made project and is not affiliated with Obsidian Entertainment, Microsoft, or any other entity.

You must source your own copies of the games to use this tool. Please do not distribute this tool with content from the games. They're good games! Buy and play them yourself.

Also note the license of the project, which is GPL-3.0.

About

Tool for viewing and modifying dialogue in Obsidian Entertainment games

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages