LPAR (File Format)

LPAR (LE-CODE Parameters) is a text file format defined by Wiimm. It is used to define parameters for LE-CODE.

Introduction

A LE-CODE binary file (e.g. lecode-PAL.bin) contains a binary section with magic »LPAR«. It defines how the LE-CODE executor works. Up to Wiimms SZS Tools v2.14a, LE-CODE parameters had to be set via options when patching. As of v2.15a there is also the possibility to define the parameters by a LPAR file. So a LPAR file is a text version of the binary LPAR section. Options are still accepted and have higher priority than a LPAR file.

Using a LPAR file is recommended, because some parameters can only be set by a LPAR file. A typical command looks like this:

wlect patch lecode-PAL.bin --le-define DEFINITION --lpar lecode-param.txt  ....

Here and in this whole article we use filename lecode-param.txt for the LPAR file. See it as recommendation. Read »Use a LPAR file« for more details.

A LPAR file is a text files that always beginns with the magic »#LE-LPAR«. It is divided into sections. At the moment 2 sections are supported, one for General Parameters and one for Chat Messages. So a LPAR file looks like this:

#LE-LPAR

[LECODE-PARAMETERS]

ENGINE          = 10,60,30
ENABLE-200CC    = 0
PERF-MONITOR    = 0
CUSTOM-TT       = 0
XPFLAGS         = 1


[CHAT-MESSAGE-MODES]
# ....

Section »Create a LPAR file« explains how to create and modify a LPAR file.

Under construction

See »LE-CODE: Distribution Tutorial: LE-CODE parameters« for details until this pages is completed.