Difference between revisions of "Install"

From MSX Game Library

Line 10: Line 10:
 
* or Download and unzip the [https://github.com/aoineko-fr/MSXgl/archive/refs/tags/v0.6.5-alpha.zip latest version of the engine].
 
* or Download and unzip the [https://github.com/aoineko-fr/MSXgl/archive/refs/tags/v0.6.5-alpha.zip latest version of the engine].
  
3️⃣ If you want to use the emulator '''auto-launch''' option:
+
3️⃣ ''(Optional)'' If you want to use the emulator '''auto-launch''' option:
 
* Edit <tt>MSXgl\projects\default_config.cmd</tt> file ''(the default Build tool's configuration)'',
 
* Edit <tt>MSXgl\projects\default_config.cmd</tt> file ''(the default Build tool's configuration)'',
 
* Search for "<tt>set Emulator</tt>" and set the path for your favorite emulator (can be [https://openmsx.org OpenMSX], [https://emulicious.net Emulicious], [http://bluemsx.msxblue.com BlueMSX], [https://www.msx.org/news/emulation/en/meisei-132 Meisei], [https://fms.komkon.org/fMSX fMSX] or [http://www.lexlechz.at/en/software/RuMSX.html Ru-MSX]) and add "<tt>set DoRun=1</tt>".
 
* Search for "<tt>set Emulator</tt>" and set the path for your favorite emulator (can be [https://openmsx.org OpenMSX], [https://emulicious.net Emulicious], [http://bluemsx.msxblue.com BlueMSX], [https://www.msx.org/news/emulation/en/meisei-132 Meisei], [https://fms.komkon.org/fMSX fMSX] or [http://www.lexlechz.at/en/software/RuMSX.html Ru-MSX]) and add "<tt>set DoRun=1</tt>".
Line 19: Line 19:
 
== Linux ==
 
== Linux ==
  
For Linux users, you need to manually install Node.js (19.3.0) and SDCC (4.2.0) before you can use MSXgl.
+
For Linux users, you need to manually install [https://nodejs.org/ Node.js] (19.3.0) and [https://sdcc.sourceforge.net/ SDCC] (4.2.0) before you can use MSXgl.

Revision as of 17:39, 22 December 2022

How to install MSXgl

Follow those steps:

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

  • Note: For now (v0.6.5), please use a directory without any space in the full path.

2️⃣ Install the engine:

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

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

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

Linux

For Linux users, you need to manually install Node.js (19.3.0) and SDCC (4.2.0) before you can use MSXgl.