Difference between revisions of "Install"
From MSX Game Library
| (34 intermediate revisions by the same user not shown) | |||
| 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>: | + | * ''<u>Note</u>: It is recommanded to 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> | + | * Clone the Git repository https://github.com/aoineko-fr/MSXgl.git (<tt>v1.0.0</tt> tag), |
| − | * or Download and unzip the [https://github.com/aoineko-fr/MSXgl/releases/ | + | * or Download and unzip the [https://github.com/aoineko-fr/MSXgl/releases latest version of the engine]. |
| + | |||
| + | 3️⃣ ''(Optional)'' If you want to use the emulator '''auto-launch''' option: | ||
| + | * [[Create_my_first_program#Test_template_program|Build any sample program]] to generate <tt>MSXgl\projects\default_config.js</tt> file ''(the default [[Build tool]]'s configuration)'' and edit it, | ||
| + | * Search for "<tt>Emulator</tt>", set the path for your favorite [[Emulators|emulator]] (can be [https://openmsx.org openMSX], [https://emulicious.net Emulicious], [http://bluemsx.msxblue.com BlueMSX], [https://fms.komkon.org/fMSX fMSX], [https://www.msx.org/news/emulation/en/meisei-132 Meisei] 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 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]]! | ||
| + | |||
| + | === macOS === | ||
| + | |||
| + | For '''Windows''' and '''Linux''', all the needed tools are imbedded into MSXgl package, but '''macOS''' users need to manually install [https://nodejs.org/ Node.js] (18.12.1 or newer) and [https://sdcc.sourceforge.net/ SDCC] (4.2.0) before they can run the MSXgl's [[Build tool]]. See this [[Install/macOS|installation guide]]. | ||
| + | |||
| + | The path of all the programs used in the [[Build tool]] can be changed in the <tt>default_config.js</tt> file. | ||
| + | |||
| + | == Annexe == | ||
| + | |||
| + | See also: | ||
| + | * [[Alternative file layout]] (to have the MSXgl directory inside your project directory) | ||
Latest revision as of 23:01, 1 June 2024
How to install MSXgl
Follow those steps:
1️⃣ Create a directory (name it "MSXgl" for example).
- Note: It is recommanded to 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 (v1.0.0 tag),
- or Download and unzip the latest version of the engine.
3️⃣ (Optional) If you want to use the emulator auto-launch option:
- Build any sample program to generate MSXgl\projects\default_config.js file (the default Build tool's configuration) and edit it,
- Search for "Emulator", set the path for your favorite emulator (can be openMSX, Emulicious, BlueMSX, fMSX, Meisei 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!
macOS
For Windows and Linux, all the needed tools are imbedded into MSXgl package, but macOS users need to manually install Node.js (18.12.1 or newer) and SDCC (4.2.0) before they can run the MSXgl's Build tool. See this installation guide.
The path of all the programs used in the Build tool can be changed in the default_config.js file.
Annexe
See also:
- Alternative file layout (to have the MSXgl directory inside your project directory)