Difference between revisions of "LPAR (File Format)"
Line 9: | Line 9: | ||
[[#usage|Using a LPAR file]] is recommended, because some parameters can only be set by a LPAR file. A typical command looks like this: | [[#usage|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 lpar.txt .... | + | wlect patch lecode-PAL.bin --le-define DEFINITION '''--lpar lpar.txt''' .... |
Here and in this whole article the filename ''lpar.txt'' is used for the LPAR file, but any other filenames like ''lecode-param.txt'' are possible too. Read »[[#use|Use a LPAR file]]« for more details. | Here and in this whole article the filename ''lpar.txt'' is used for the LPAR file, but any other filenames like ''lecode-param.txt'' are possible too. Read »[[#use|Use a LPAR file]]« for more details. | ||
− | A LPAR file is a text | + | A LPAR file is a text file that always begins with the magic »#LE-LPAR« as identification. It is divided into sections. At the moment 2 sections are supported, one for [[#param|General Parameters]] and one for [[#chatmsg|Chat Messages]]. So a LPAR file looks like this: |
<pre> | <pre> | ||
#LE-LPAR | #LE-LPAR | ||
Line 49: | Line 49: | ||
|- | |- | ||
| <tt>PERF-MONITOR</tt> || <tt>int</tt> || <tt>--perf-mon</tt> | | <tt>PERF-MONITOR</tt> || <tt>int</tt> || <tt>--perf-mon</tt> | ||
− | | Enable (1) or disable (0) the performance monitor. The special value 2 enables the it for Dolphin too, but it doesn't work correctly with Dolphin. | + | | Enable (1) or disable (0) the performance monitor for [[Wii]] and [[Wii U]]. The special value 2 enables the it for [[Dolphin]] too, but it doesn't work correctly with Dolphin. |
|- | |- | ||
| <tt>CUSTOM-TT</tt> || <tt>int</tt> || <tt>--custom-tt</tt> | | <tt>CUSTOM-TT</tt> || <tt>int</tt> || <tt>--custom-tt</tt> |
Revision as of 14:10, 5 April 2020
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 lpar.txt ....
Here and in this whole article the filename lpar.txt is used for the LPAR file, but any other filenames like lecode-param.txt are possible too. Read »Use a LPAR file« for more details.
A LPAR file is a text file that always begins with the magic »#LE-LPAR« as identification. 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.
Sections
General Parameters [LECODE-PARAMETERS]
This section defines general LE-CODE parameters. The corresponding options have a higher priority. Remove or comment-out a parameter if its value should not be changed. All values will be limited to the allowed ranges.
Parameter Name |
Value | Related Option |
Description |
---|---|---|---|
ENGINE | int,int,int | --engine | Define probabilities for engine classes. A list for »100cc,150cc,mirror« is expected. If 200cc is enabled, the values are for »150cc,200cc,mirror«. Any numbers are accepted. They are normalized to get a total of 100 percent. Use »0,1,0« to force 150cc. Use »0,0,0« to reset to Nintendos VR based choice. |
ENABLE-200CC | int | --200cc | Enable (1) or disable (0) 200cc support. LE-CODE hasn't implemented this feature yet! |
PERF-MONITOR | int | --perf-mon | Enable (1) or disable (0) the performance monitor for Wii and Wii U. The special value 2 enables the it for Dolphin too, but it doesn't work correctly with Dolphin. |
CUSTOM-TT | int | --custom-tt | Enable (1) or disable (0) time trial for custom tracks. |
XPFLAGS | int | --xpflags | Enable (1) or disable (0) support for extended presence flags. Disable it only for tests! |
Chat Messages [CHAT-MESSAGE-MODES]
Manage LPAR files
Create a LPAR file
Use a LPAR file
Under construction
See »LE-CODE: Distribution Tutorial: LE-CODE parameters« for details until this pages is completed.