Custom Command Framework (CCF)

Summary

A framework for SFSE plugins to add completely custom commands to the console without needing to overwrite existing commands. This doesn't do anything on its own.

API (For Mod Authors)

If you're a SFSE plugin author and want to add your own custom command to the in-game console, you can copy-paste the API header into your project. All you need to do is call CCF::RegisterCommand() when your plugin receives the kPostLoad SFSE message, with your command name and a function to be called whenever the command is ran. The command's args, the full command string, and a handy console interface are supplied to your function.

With the console interface, you can easily print text to the console, convert a hexadecimal arg to a form pointer, grab the currently selected reference, or prevent the command text from printing to the console.

This framework is compatible with the Papyrus Debug. ExecuteConsole() function, so this can be used as a temporarily workaround for allowing Papyrus scripts to communicate with your SFSE plugin, since SFSE does not yet have custom Papyrus function support.

Credits

linux18 for the name idea

ianpat for Starfield Script Extender

meh321 for Address Library for SFSE Plugins

The Starfield-Reverse-Engineering community for CommonLibSF

Links