Install

How to install MSXgl

Follow those steps:

1️⃣ Create a directory (name it "MSXgl" for example).

• Note: It is recommanded to use a directory without any space in the full path.

2️⃣ Install the engine:

• Clone the Git repository https://github.com/aoineko-fr/MSXgl.git (v0.8.0-alpha tag),
• or Download and unzip the latest version of the engine.

3️⃣ (Optional) If you want to use the emulator auto-launch option:

• Edit MSXgl\projects\default_config.js file (the default Build tool's configuration),
• Search for "Emulator", set the path for your favorite emulator (can be openMSX, Emulicious, BlueMSX, fMSX, Meisei or Ru-MSX) and set "DoRun = true".
• Note: Many other options from default_config.js are overwriten by the project's configuration.

✅ You are done! You can start testing library samples or create your own brand new game!

macOS

For Windows and Linux, all the needed tools are imbedded into MSXgl package, but macOS users need to manually install Node.js (18.12.1 or newer) and SDCC (4.2.0) before they can run the MSXgl's Build tool. See this installation guide.

The path of all the programs used in the Build tool can be changed in the default_config.js file.