Difference between revisions of "Install"

From MSX Game Library

Line 6: Line 6:
  
 
2️⃣ Install the '''engine''':
 
2️⃣ Install the '''engine''':
* Clone the Git repository https://github.com/aoineko-fr/MSXgl.git,
+
* Clone the Git repository https://github.com/aoineko-fr/MSXgl.git (<tt>v0.3.0-alpha</tt> tag),
* or Download and unzip the latest version of the engine.
+
* or Download and unzip the [https://github.com/aoineko-fr/MSXgl/releases/download/v0.3.0-alpha/MSXgl-v0.3.0-alpha.zip latest version of the engine].
  
 
3️⃣ Install '''SDCC''' [https://sourceforge.net/projects/sdcc/files/snapshot_builds/ version 4.1.12 or newer] (in "<tt>MSXgl\tools\SDCC</tt>" e.g.).
 
3️⃣ Install '''SDCC''' [https://sourceforge.net/projects/sdcc/files/snapshot_builds/ version 4.1.12 or newer] (in "<tt>MSXgl\tools\SDCC</tt>" e.g.).

Revision as of 14:59, 16 January 2022

Note: For the moment, the Build Tool is only compatible with Windows OS.

Mandatory steps

1️⃣ Create a directory (name it "MSXgl" e.g.).

2️⃣ Install the engine:

3️⃣ Install SDCC version 4.1.12 or newer (in "MSXgl\tools\SDCC" e.g.).

  • If you use an other directory to install SDCC, change the SDCC path in "MSXgl\project\build_config.cmd".

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

Optional steps

Recommended: To allow the Build Tool to launch your game after building, please install an MSX emulator (here the list of supported emulators).

For example, install OpenMSX in \tools\openMSX (or change the path to emulator in "MSXgl\project\build_config.cmd)