Difference between revisions of "Install"
From MSX Game Library
| Line 1: | Line 1: | ||
| − | + | == How to install MSXgl == | |
Follow those steps: | Follow those steps: | ||
| − | 1️⃣ '''Create''' a directory (name it "<tt>MSXgl</tt>" | + | 1️⃣ '''Create''' a directory (name it "<tt>MSXgl</tt>" for example). |
| − | * ''<u>Note</u>: For now (v0. | + | * ''<u>Note</u>: For now (v0.6.5), please use a directory without any space in the full path. |
2️⃣ Install the '''engine''': | 2️⃣ Install the '''engine''': | ||
| − | * Clone the Git repository https://github.com/aoineko-fr/MSXgl.git (<tt>v0. | + | * Clone the Git repository https://github.com/aoineko-fr/MSXgl.git (<tt>v0.6.5-alpha</tt> tag), |
| − | * or Download and unzip the [https://github.com/aoineko-fr/MSXgl/archive/refs/tags/v0. | + | * 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️⃣ If you want to use the emulator '''auto-launch''' option: | ||
| Line 14: | Line 14: | ||
* 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>". | ||
* ''<u>Note</u>: Many other options from <tt>default_config.cmd</tt> are overwriten by samples' build script.'' | * ''<u>Note</u>: Many other options from <tt>default_config.cmd</tt> are overwriten by samples' build script.'' | ||
| + | |||
✅ '''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]]! | ||
| + | |||
| + | == Linux == | ||
| + | |||
| + | For Linux users, you need to manually install Node.js (19.3.0) and SDCC (4.2.0) before you can use MSXgl. | ||
Revision as of 17:36, 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️⃣ 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.