View source for What is MSXgl?

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

The goal of this library is to offer to C programmers, the whole set of functionalities to create a game with high performances.<br/>
Even if a C program can never be as efficient as a program written entirely in assembler, the goal is to try to get as close as possible.

To achieve this goal, the library is dynamically compiled to allow the user to configure the functionalities to best suit his needs.<br/>
Also, the most expensive features are written in assembler.

The other goal was to create a library that can be totally independent of the BIOS. This makes it much easier to use the 16K of page 0.<br/>
The library also provides interrupt handling code to create ROMs that always remain on page 0.

Many [[samples|sample]] programs are available to demonstrate the different [[modules|features]] of the library.
<html><div>
<img width="20%" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/finalsmash.jpg" />
<img width="20%" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_draw.jpg" />
<img width="20%" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_psg.jpg" />
<img width="20%" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_game.png" />
<img width="20%" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_scroll.png" />
<img width="20%" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_print.jpg" />
<img width="20%" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sprite.jpg" />
<img width="20%" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_clock.jpg" />
</div></html>

The Build Tool allows in 1 click to create a final program for a large number of target formats: 
* Plain ROM from 8K to 64K (interrupt handler can be install in page 0),
* Mapped ROM from 64K to 4096K (ASCII-8, ASCII-16, Konami and Konami SCC mappers),
* MSX-DOS 1 or 2 binary program,
* BASIC binary program.

The library supports the following devices:
* VDP (TMS9918, V9938 and V9990), 
* Audio: PSG (AY-3-8910), MSX-Music, MSX-Audio, Konami SCC,
* Input: Keyboard, Joystick, Mouse and Paddle,
* ROM mapper, slot manager, and Real Time Clock (RP-5C01).

Here are also the supported audio formats:
* PT3 ([https://github.com/ivanpirog/vortextracker Vortex Tracker II])
* WYZ ([https://github.com/AugustoRuiz/WYZTracker WYZTracker])
* AKG, AKY and AKM ([https://www.julien-nevo.com/arkostracker/ Arkos Tracker 2])
* ayFX
* VGM (for all supported audio chip)
* lVGM (a light-VGM format for PSG)
* PCM-Encoder (aka. ''Crystal clean PCM 8bit samples on the poor PSG'')

Many thanks to the members of the [https://msx.org MSX Ressource Center] and [http://msxvillage.fr MSX Village] who have been very helpful.<br/>

The library is distribute under [https://creativecommons.org/licenses/by-sa/4.0/ Creative Commons BY-SA] license. Tools or sources from other authors could use [[credits|other free license]].


== Directories ==
 📁 MSXgl
 ├─📁 engine          | MSXgl library
 │ ├─📁 content       | Data ready to include (font, math table)
 │ ├─📁 datasrc       | Data source
 │ ├─📁 doc           | Documentation
 │ ├─📁 lib           | Static library binaries (perhaps one day...)
 │ ├─📁 script        | Build Tool scripts
 │ └─📁 src           | Library sources (.c and .h)
 ├─📁 projects        | Programs (this is where you will create your own project)
 │ ├─📁 example       | Example game
 │ ├─📁 samples       | Sample programs (VDP, PSG, Sprite, ...)
 │ ├─📁 targets       | Samples to test all target (ROM, DOS)
 │ ├─📁 template      | MSX 1 template sample (can be use as base to create a new program)
 │ └─📁 template_msx2 | MSX 2 template sample (can be use as base to create a new program)
 └─📁 tools           | Tools
   ├─📁 MSXtk         | MSX tool kit utilities (MSXhex is used in the build process)
   ├─📁 audio         | Tools used with audio 
   ├─📁 build         | Tools used by the [[Build tool]]
   ├─📁 compress      | Tools used to compress data
   └─📁 sdcc          | SDCC (binaries for Windows and Linux, and z80 lib)

== How to... ==
* [[Install|Install and setup MSXgl]]
* [[Create my first program]]