MSX Game Library - User contributions [en]

Template:GITHUB

2024-01-07T17:51:29Z

Guest: Created page with "[https://github.com/aoineko-fr/MSXgl GitHub Repository] 16px"

[https://github.com/aoineko-fr/MSXgl GitHub Repository] [[Image:Github_Logo.png|16px]]

Main Page

2024-01-07T17:50:56Z

Guest:

__NOTOC__{{TITLE}}

{{MSXGL}} is a free and open source Game Library wrote in C and targeting MSX computers.

GitHub: https://github.com/aoineko-fr/MSXgl

== Get Starting ==
* [[What is MSXgl?]]
* [[Install|Install and Setup]]
* [[Create my first program]]
* [[Types]]
* [[Samples]] (showcase programs)
* [[Code documentation]] (library source documentation)
* [[Roadmap]] (what coming next?)
* [[Projects]]
* [[Ressources]]
* [[Help]]

== Modules ==
{{:Modules}}

== Build ==
* [[Build tool]]
* [[Defines]]
* [[Target|Target format]] (Basic, DOS, ROM & MegaROM)
* [[Emulators]]

== Data ==
* [[:category:Font|Font]]
* [[:category:Cursor|Cursor]]

== Tools ==
* [[MSXtk]] (tool kit)
** [[MSXbin]] (binary data convertor)
** [[MSXcrypt]] (encryption tool)
** [[MSXhex]] (binary generator from IHX file)
** [[MSXimg]] (image convertor)
** [[MSXmath]] (precompute table generator)
** [[MSXzip]] (compressor)

== Link ==
* {{GITHUB}}
* {{DISCORD}}

Main Page

2024-01-07T17:47:10Z

Guest:

Template:DISCORD

2024-01-07T17:45:41Z

Guest: Created page with "[https://discord.gg/REmAhcw6rp MSXgl Discord server] <img src="https://assets-global.website-files.com/6257adef93867e50d84d30e2/636e0a6a49cf127bf92de1e2_icon_clyde_blurple_RGB..."

[https://discord.gg/REmAhcw6rp MSXgl Discord server] <img src="https://assets-global.website-files.com/6257adef93867e50d84d30e2/636e0a6a49cf127bf92de1e2_icon_clyde_blurple_RGB.png" style="width:16px;" />

Modules/bios/Usage

2024-01-07T17:45:19Z

Guest:

This module simply wraps the BIOS routines. For its use, please refer to the documents describing BIOS features:
* ''[https://map.grauw.nl/resources/msxbios.php MSX BIOS calls]'' (MSX Assembly Page),
* ''[https://www.msx.org/wiki/Main-ROM_BIOS Main-ROM BIOS]'' (MSX Resource Center).

<u>Note</u>: Not all BIOS routines have function in this module to encapsulate them in C (some are of very limited use in games). If you want certain functions to be added, please ask on the {{DISCORD}}.

Template:FRAME DOC

2024-01-07T17:41:28Z

Guest:

<html><iframe class="inlineCodeDoc" id="{{{1}}}"
width="100%"
height="700px"
title="Inline Code Documentation"
src="https://aoineko.org/msxgl-doc/</html>{{#if:{{{1| }}}|<nowiki>#File:</nowiki>{{{1}}}.h|index.html}}<html>">
</iframe></html>

Install/macOS

2023-10-01T12:17:29Z

Guest: /* Build */

For the [[install]]ation, '''macOS''' users need to manually setup their environment before they can run the MSXgl's [[Build tool]].
Here is a guide provided by user Syntrax to help you in this process.

== Node.js ==
* Install [https://nodejs.org/ Node.js] (18.12.1 or newer), or use [https://github.com/nvm-sh/nvm NVM] (<tt>brew install nvm</tt>)

== SDCC ==
* Install [https://sdcc.sourceforge.net/ SDCC] 4.2.0 (<tt>brew install sdcc</tt>)

== Tools ==
Go in to the MSXgl folder and recompile all the enclosed tools. As sources are included, its mostly running <tt>./build.sh</tt> on every folder.
At minimum, you require the Xcode Command line tools (<tt>xcode-select --install</tt>).
That will compile for example <tt>MSXhex</tt>, <tt>MSXbin</tt> and <tt>msxtar</tt>.

== Build ==
Then the project/sample's <tt>build.sh</tt> script will start calling SDCC components or the binaries.
macOS will block that for security reasons, so build.sh will fail.
You must de-quarantine the freshly built/downloaded binaries:

<tt>xattr -r -d com.apple.quarantine ./MSXgl</tt>

The full process takes about 10~15 minutes to get it up and running.

Note:
* <tt>[[MSXhex]]</tt> is used to convert .IHX files generated by SDCC into final binary file (.ROM, .COM or .BIN).
* <tt>msxtar</tt> (not part of [[MSXtk]]) is used to generate .DSK file for MSX-DOS or BASIC binary target.
* Other tools from MSXtk are not part of the build process.

Install/macOS

2023-10-01T12:14:13Z

Guest: /* SDCC */

For the [[install]]ation, '''macOS''' users need to manually setup their environment before they can run the MSXgl's [[Build tool]].
Here is a guide provided by user Syntrax to help you in this process.

== Node.js ==
* Install [https://nodejs.org/ Node.js] (18.12.1 or newer), or use [https://github.com/nvm-sh/nvm NVM] (<tt>brew install nvm</tt>)

== SDCC ==
* Install [https://sdcc.sourceforge.net/ SDCC] 4.2.0 (<tt>brew install sdcc</tt>)

== Tools ==
Go in to the MSXgl folder and recompile all the enclosed tools. As sources are included, its mostly running <tt>./build.sh</tt> on every folder.
At minimum, you require the Xcode Command line tools (<tt>xcode-select --install</tt>).
That will compile for example <tt>MSXhex</tt>, <tt>MSXbin</tt> and <tt>msxtar</tt>.

== Build ==
Then the project/sample's <tt>build.sh</tt> script will start calling SDCC components or the binaries.
macOS will block that for security reasons, so build.sh will fail.
* Go to system setting, security and privacy.
* There you will find a small part that says ''"allow appstore and third parties"'' or ''"allow appstore"'' and a button ''"Allow anyway"''.
* Then macOS will ask your administrator credentials and register the binary as safe.
* When you run <tt>build.sh</tt>, a new popup will appear warning the user about an unknown source but you will have a button "Open".
* Press that and the binary will start.
* Repeat this for every step in <tt>build.sh</tt>.
* Once the first project has been build, you probably won't need it anymore unless a previously not used tool is started, which hasn't been authorized yet.

The full process takes about 10~15 minutes to get it up and running.

Note:
* <tt>[[MSXhex]]</tt> is used to convert .IHX files generated by SDCC into final binary file (.ROM, .COM or .BIN).
* <tt>msxtar</tt> (not part of [[MSXtk]]) is used to generate .DSK file for MSX-DOS or BASIC binary target.
* Other tools from MSXtk are not part of the build process.

Install/macOS

2023-10-01T12:13:53Z

Guest: /* Node.js */

For the [[install]]ation, '''macOS''' users need to manually setup their environment before they can run the MSXgl's [[Build tool]].
Here is a guide provided by user Syntrax to help you in this process.

== Node.js ==
* Install [https://nodejs.org/ Node.js] (18.12.1 or newer), or use [https://github.com/nvm-sh/nvm NVM] (<tt>brew install nvm</tt>)

== SDCC ==
* Install [https://sdcc.sourceforge.net/ SDCC] 4.2.0 (brew install sdcc)

== Tools ==
Go in to the MSXgl folder and recompile all the enclosed tools. As sources are included, its mostly running <tt>./build.sh</tt> on every folder.
At minimum, you require the Xcode Command line tools (<tt>xcode-select --install</tt>).
That will compile for example <tt>MSXhex</tt>, <tt>MSXbin</tt> and <tt>msxtar</tt>.

== Build ==
Then the project/sample's <tt>build.sh</tt> script will start calling SDCC components or the binaries.
macOS will block that for security reasons, so build.sh will fail.
* Go to system setting, security and privacy.
* There you will find a small part that says ''"allow appstore and third parties"'' or ''"allow appstore"'' and a button ''"Allow anyway"''.
* Then macOS will ask your administrator credentials and register the binary as safe.
* When you run <tt>build.sh</tt>, a new popup will appear warning the user about an unknown source but you will have a button "Open".
* Press that and the binary will start.
* Repeat this for every step in <tt>build.sh</tt>.
* Once the first project has been build, you probably won't need it anymore unless a previously not used tool is started, which hasn't been authorized yet.

The full process takes about 10~15 minutes to get it up and running.

Note:
* <tt>[[MSXhex]]</tt> is used to convert .IHX files generated by SDCC into final binary file (.ROM, .COM or .BIN).
* <tt>msxtar</tt> (not part of [[MSXtk]]) is used to generate .DSK file for MSX-DOS or BASIC binary target.
* Other tools from MSXtk are not part of the build process.

Install/macOS

2023-10-01T12:13:29Z

Guest: /* Tools */

For the [[install]]ation, '''macOS''' users need to manually setup their environment before they can run the MSXgl's [[Build tool]].
Here is a guide provided by user Syntrax to help you in this process.

== Node.js ==
* Install [https://nodejs.org/ Node.js] (18.12.1 or newer), or use [https://github.com/nvm-sh/nvm NVM] (brew install nvm)

== SDCC ==
* Install [https://sdcc.sourceforge.net/ SDCC] 4.2.0 (brew install sdcc)

== Tools ==
Go in to the MSXgl folder and recompile all the enclosed tools. As sources are included, its mostly running <tt>./build.sh</tt> on every folder.
At minimum, you require the Xcode Command line tools (<tt>xcode-select --install</tt>).
That will compile for example <tt>MSXhex</tt>, <tt>MSXbin</tt> and <tt>msxtar</tt>.

== Build ==
Then the project/sample's <tt>build.sh</tt> script will start calling SDCC components or the binaries.
macOS will block that for security reasons, so build.sh will fail.
* Go to system setting, security and privacy.
* There you will find a small part that says ''"allow appstore and third parties"'' or ''"allow appstore"'' and a button ''"Allow anyway"''.
* Then macOS will ask your administrator credentials and register the binary as safe.
* When you run <tt>build.sh</tt>, a new popup will appear warning the user about an unknown source but you will have a button "Open".
* Press that and the binary will start.
* Repeat this for every step in <tt>build.sh</tt>.
* Once the first project has been build, you probably won't need it anymore unless a previously not used tool is started, which hasn't been authorized yet.

The full process takes about 10~15 minutes to get it up and running.

Note:
* <tt>[[MSXhex]]</tt> is used to convert .IHX files generated by SDCC into final binary file (.ROM, .COM or .BIN).
* <tt>msxtar</tt> (not part of [[MSXtk]]) is used to generate .DSK file for MSX-DOS or BASIC binary target.
* Other tools from MSXtk are not part of the build process.

Install/macOS

2023-10-01T12:10:15Z

Guest: /* SDCC */

For the [[install]]ation, '''macOS''' users need to manually setup their environment before they can run the MSXgl's [[Build tool]].
Here is a guide provided by user Syntrax to help you in this process.

== Node.js ==
* Install [https://nodejs.org/ Node.js] (18.12.1 or newer), or use [https://github.com/nvm-sh/nvm NVM] (brew install nvm)

== SDCC ==
* Install [https://sdcc.sourceforge.net/ SDCC] 4.2.0 (brew install sdcc)

== Tools ==
Go in to the MSXgl folder and recompile all the enclosed tools. As sources are included, its mostly <tt>./build.sh</tt>.
At minimum, you require the xcode terminal environment.
That will compile for example <tt>MSXhex</tt>, <tt>MSXbin</tt> and <tt>msxtar</tt>.

== Build ==
Then the project/sample's <tt>build.sh</tt> script will start calling SDCC components or the binaries.
macOS will block that for security reasons, so build.sh will fail.
* Go to system setting, security and privacy.
* There you will find a small part that says ''"allow appstore and third parties"'' or ''"allow appstore"'' and a button ''"Allow anyway"''.
* Then macOS will ask your administrator credentials and register the binary as safe.
* When you run <tt>build.sh</tt>, a new popup will appear warning the user about an unknown source but you will have a button "Open".
* Press that and the binary will start.
* Repeat this for every step in <tt>build.sh</tt>.
* Once the first project has been build, you probably won't need it anymore unless a previously not used tool is started, which hasn't been authorized yet.

The full process takes about 10~15 minutes to get it up and running.

Note:
* <tt>[[MSXhex]]</tt> is used to convert .IHX files generated by SDCC into final binary file (.ROM, .COM or .BIN).
* <tt>msxtar</tt> (not part of [[MSXtk]]) is used to generate .DSK file for MSX-DOS or BASIC binary target.
* Other tools from MSXtk are not part of the build process.

Install/macOS

2023-10-01T12:09:19Z

Guest: /* Node.js */

For the [[install]]ation, '''macOS''' users need to manually setup their environment before they can run the MSXgl's [[Build tool]].
Here is a guide provided by user Syntrax to help you in this process.

== Node.js ==
* Install [https://nodejs.org/ Node.js] (18.12.1 or newer), or use [https://github.com/nvm-sh/nvm NVM] (brew install nvm)

== SDCC ==
* Install [https://sdcc.sourceforge.net/ SDCC] 4.2.0
: Unpack archive: <tt>sudo cp -R * /usr/opt/.</tt>

== Tools ==
Go in to the MSXgl folder and recompile all the enclosed tools. As sources are included, its mostly <tt>./build.sh</tt>.
At minimum, you require the xcode terminal environment.
That will compile for example <tt>MSXhex</tt>, <tt>MSXbin</tt> and <tt>msxtar</tt>.

== Build ==
Then the project/sample's <tt>build.sh</tt> script will start calling SDCC components or the binaries.
macOS will block that for security reasons, so build.sh will fail.
* Go to system setting, security and privacy.
* There you will find a small part that says ''"allow appstore and third parties"'' or ''"allow appstore"'' and a button ''"Allow anyway"''.
* Then macOS will ask your administrator credentials and register the binary as safe.
* When you run <tt>build.sh</tt>, a new popup will appear warning the user about an unknown source but you will have a button "Open".
* Press that and the binary will start.
* Repeat this for every step in <tt>build.sh</tt>.
* Once the first project has been build, you probably won't need it anymore unless a previously not used tool is started, which hasn't been authorized yet.

The full process takes about 10~15 minutes to get it up and running.

Note:
* <tt>[[MSXhex]]</tt> is used to convert .IHX files generated by SDCC into final binary file (.ROM, .COM or .BIN).
* <tt>msxtar</tt> (not part of [[MSXtk]]) is used to generate .DSK file for MSX-DOS or BASIC binary target.
* Other tools from MSXtk are not part of the build process.