Official Xar Journal

Back

---

What the Mod Does

This is a mod to add a journal to the xar package. When you read certain text boxes, the text will be added to your journal which you can read later by pressing the J key (although you can rebind it to another key).

Text boxes show up in different colors depending on whether or not you have added them to your journal.

This mod comes with the console command journal which can be used for advanced configuration.

---

How it Works

The mod itself is basically a simple dumb client which communicates to the internal journal system of the xar package.

That internal system assigns "paths" to every text box, and those paths determine where the text boxes appear in the journal. The internal system allows for the possibility of another mod to modify these paths.

The internal system also assigns an "API name" to every text box, and allows the mapping of API names to actual text box text. Often we literally map API names to text box text strings. Other times, we map API names to callback functions which are called when it is time to render the text (because such text is procedurally generated).

---

Download

Here is the mod. It must be installed to Input/Packages.