Difference between revisions of "Install"
From MSX Game Library
| Line 11: | Line 11: | ||
3️⃣ ''(Optional)'' 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.js</tt> file ''(the default [[Build tool]]'s | + | * Edit <tt>MSXgl\projects\default_config.js</tt> file ''(the default [[Build tool]]'s configuration)'', |
* Search for "<tt>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 set "<tt>DoRun = true</tt>". | * Search for "<tt>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 set "<tt>DoRun = true</tt>". | ||
| − | * ''<u>Note</u>: Many other options from <tt>default_config.js</tt> are overwriten by project's | + | * ''<u>Note</u>: Many other options from <tt>default_config.js</tt> are overwriten by the project's configuration.'' |
✅ '''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]]! | ||
| Line 19: | Line 19: | ||
== Linux == | == Linux == | ||
| − | 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. | + | 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. |
| + | The path of all the programs used in the [[Build tool]] can be changed in the <tt>default_config.js</tt> file. | ||
Revision as of 17:45, 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:
- Clone the Git repository https://github.com/aoineko-fr/MSXgl.git (v0.6.5-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" and set the path for your favorite emulator (can be OpenMSX, Emulicious, BlueMSX, Meisei, fMSX 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!
Linux
For Linux users, you need to manually install Node.js (19.3.0) and SDCC (4.2.0) before you can use MSXgl. The path of all the programs used in the Build tool can be changed in the default_config.js file.