Build tool

From MSX Game Library

Revision as of 01:05, 23 December 2022 by Aoineko (talk | contribs) (Project)

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}}}]

Tools

Compiler: Path to the C compile program (string) [type: `${ToolsDir}sdcc\bin\sdcc` | default: {{{4}}}]

Assembler: Path to the assembler program (string) [type: `${ToolsDir}sdcc\bin\sdasz80` | default: {{{4}}}]

Linker: Path to the linker program (string) [type: `${ToolsDir}sdcc\bin\sdcc` | default: {{{4}}}]

MakeLib: Path to the program to generate lib file (string) [type: `${ToolsDir}sdcc\bin\sdar`; | default: {{{4}}}]

Hex2Bin: Path to IHX to binary convertor (string) [type: `${ToolsDir}MSXtk\bin\MSXhex` | default: {{{4}}}]

MSXDOS: Path to the MSX-DOS files (string) [type: `${ToolsDir}build\MSXDOS` | default: {{{4}}}]

DskTool: Path to the tool to generate DSK file (string) [type: `${ToolsDir}build\DskTool\dsktool` | default: {{{4}}}]

Emulator: Path to the emulator to launch the project (string) [type: | default: {{{4}}}]

Debugger: Path to the debugger to test the project (string) [type: | default: {{{4}}}]

Project

ProjName: Project name (string). Will be use for output filename [type: "" | default: {{{4}}}]

ProjModules: List of project modules to build (array). If empty, ProjName will be added [type: [] | default: {{{4}}}]

ProjSegments: Project segments base name (string). ProjName will be used if not defined [type: "" | default: {{{4}}}]

LibModules: List of library modules to build (array) [type: [] | default: {{{4}}}]

AddSources: Additional sources to be compiled and linked with the project (array) [type: [] | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

xxx: xxx [type: xxx | default: {{{4}}}]

Misc