Difference between revisions of "Install"

From MSX Game Library

Line 1: Line 1:
''<u>Note</u>: For the moment, the [[Build Tool]] is only compatible with Windows OS.''
+
''<u>Note</u>: For the moment, the [[Build Tool]] is only compatible with Windows 64-bits OS.''
 
 
== Mandatory steps ==
 
  
 
1️⃣ '''Create''' a directory (name it "<tt>MSXgl</tt>" e.g.).
 
1️⃣ '''Create''' a directory (name it "<tt>MSXgl</tt>" e.g.).
Line 9: Line 7:
 
* 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].
 
* 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️⃣ If you want to use program auto-launch option
* If you use an other directory to install SDCC, change the SDCC path in "<tt>MSXgl\project\build_config.cmd</tt>".
+
* Edit <tt>MSXgl\projects\default_config.cmd</tt> file,
 +
* Search for "set Emulator" and set the path for your favorite emulator (can be OpenMSX, BlueMSX, Meisei, Emulicious, fMSX or Ru-MSX).
  
 
✅ '''You are done!''' You can start [[testing library samples]] or [[Create my first program|create your own brand new game]]!
 
✅ '''You are done!''' You can start [[testing library samples]] or [[Create my first program|create your own brand new game]]!
 
== Optional steps ==
 
 
<u>Recommended</u>: 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 <tt>\tools\openMSX</tt> (or change the path to emulator in "<tt>MSXgl\project\build_config.cmd</tt>)
 

Revision as of 14:02, 16 January 2022

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

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

2️⃣ Install the engine:

3️⃣ If you want to use program auto-launch option

  • Edit MSXgl\projects\default_config.cmd file,
  • Search for "set Emulator" and set the path for your favorite emulator (can be OpenMSX, BlueMSX, Meisei, Emulicious, fMSX or Ru-MSX).

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