Difference between revisions of "Build tool"

From MSX Game Library

(Build Tool)
Line 13: Line 13:
 
=== Build Tool ===
 
=== Build Tool ===
  
{{PARAM|Verbose|Compile verbose mode (true or false)|false}}
+
{{PARAM|Verbose|Activate verbose mode and get more build information (boolean)|false}}
  
 +
{{PARAM|LogStdout|Output build information to the standard console (boolean)|true}}
  
 +
{{PARAM|LogFile|Output build information to a log file (boolean)|false}}
  
// Compile verbose mode (true or false)
+
{{PARAM|LogFileName|Name of the log file (string)|"log_YYYYMMDD_HHMMSS.txt"}}
global.LogStdout = true;
 
  
// Compile verbose mode (true or false)
+
=== Path ===
global.LogFile = true;
 
global.LogFileName = "";
 
  
 +
{{PARAM|ProjDir|Project directory (string)|}}
 +
 +
{{PARAM|OutDir|Intermediate files directory (string)|`${ProjDir}out/`}}
 +
 +
{{PARAM|RootDir|MSXgl root directory (string)|}}
 +
 +
{{PARAM|LibDir|Library directory (string)|`${RootDir}engine/`}}
 +
 +
{{PARAM|ToolsDir|Tools directory (string)|`${RootDir}tools/`}}
  
 
=== Compilation ===
 
=== Compilation ===

Revision as of 00:45, 23 December 2022

Configuration

The Build tool configuration's parameters are defined in the engine (engine/script/js/setup_global.js) and can be modified by the user using at two levels:

  • The default configuration (projects/default_config.js), commun for all the projects.
  • The project configuration (projects/myProject/project_config.js), specific for a given project.

The value of the parameters redefined in a higher level replaces that of a lower level. The order of priority is: Project > Default > Engine.

Parameters

Build Tool

Verbose: Activate verbose mode and get more build information (boolean) [type: false | default: {{{4}}}]

LogStdout: Output build information to the standard console (boolean) [type: true | default: {{{4}}}]

LogFile: Output build information to a log file (boolean) [type: false | default: {{{4}}}]

LogFileName: Name of the log file (string) [type: "log_YYYYMMDD_HHMMSS.txt" | default: {{{4}}}]

Path

ProjDir: Project directory (string) [type: | default: {{{4}}}]

OutDir: Intermediate files directory (string) [type: `${ProjDir}out/` | default: {{{4}}}]

RootDir: MSXgl root directory (string) [type: | default: {{{4}}}]

LibDir: Library directory (string) [type: `${RootDir}engine/` | default: {{{4}}}]

ToolsDir: Tools directory (string) [type: `${RootDir}tools/` | default: {{{4}}}]

Compilation

  • InstallRAMISR: Set RAM in slot 0 and install ISR there (false, true)
  • AppSignature: Add application signature to binary data (false, true)

Misc