Latest revision as of 00:12, 10 June 2021

This tutorial will describe the various files that Korman can export aside from the basic Age files, such as py, sdl, and loc.

Introduction

With PyPRP, files such as Python scripts and SDL files had to be edited outside of Blender with separate programs such as PlasmaShop.

With newer versions of Korman, those files can be now edited and exported with ease along with the Age itself using Blender's Text Editor.

Python Files

One no longer needs to do their Age coding elsewhere. It can now all be done in Korman.

To start a new Python file, switch to the Text Editor and press the + key on the menu bar.

The new text block can be named most anything (within Python rules) as long as the .py extension is added to the end.

Also, when using the Python node, when a script is opened, it is then copied into Blender's Text Editor for future modification.

A few things to note about exporting Python scripts:

• It's highly recommended that any Cyan Python scripts be left as-is. You can create a new custom script, preferably prefixed with your Age's name (ie MyAgesPuzzleCode.py).
  • If a custom script uses Cyan's, or any other coder's, as a basis, do NOT remove the copyright/credit blurb at the top of the script!
• If you're using SDL states, you'll need a default Age Python script (ie YourAgeName.py). Korman will also create one for you if needed.
• Try not to export any scripts designated global (beginning with an x).
  • Note that new global scripts are not frowned upon or outright rejected, but they will need more discussion within the community for inclusion as well as thorough testing.

To export a script, on the Menu bar on the far right (you may need to scroll to the end using your mouse' middle click), check Export. This will export the script to your URU installation, and in the case of Path of the Shell/Complete Chronicles, pack the script into your Age's PAK file.

SDL Files

You can also create your Age's SDL file in Blender for your various SDL states.

Formatting is the same as before, as is the need for new versions when new states are added.

Here's an example of a basic SDL file:

STATEDESC YourAgeName
{
    VERSION 1
     
    VAR BOOL StateOne[1]    DEFAULT=0    DEFAULTOPTION=VAULT
    VAR INT StateTwo[1]     DEFAULT=0
    VAR BYTE StateThree[1]  DEFAULT=0    DEFAULTOPTION=hidden

}   

If you have the Age Global SDL option checked in Plasma Settings but no existing SDL text block, Korman will generate a default one for you.

LOC and TXT files

Korman can also export journal content thanks to the journal modifier.

To do this, you need only to create a new text block with any name. Try to leave out spaces and special characters, just in case. Only basic letters and numbers.

When you export for Myst Online shards, all the journal text files (if properly inserted into journal mods) will export into a single LOC file, usually YourAgeName.LOC.

When exporting for Path of the Shell/Complete Chronicles, each journal is exported as a TXT file usable for those URU installations with the Offline KI installed, such as the Deep Island shard.