<div style="float:right">[[NEO mapper|EN]] | [[NEO mapper/JA|JA]]</div>
Here's a proposal for a mapper format operating with a 16-bit segment register and allowing ROMs larger than the 2/4 MB limit of classic mappers.

== Specifications ==

=== Principles ===

This mapper format is designed to facilitate the creation of MSX games, not only by increasing the size of the ROM available for content, but also by offering programmers new possibilities for organizing their code and data.

Like conventional mappers, the basic idea is to use data write signals to the cartridge to change mapper registers value and thus, the ROM segment visible in each of the mapper's banks (sub-pages). So, predefined addresses can be used to write to the mapper registers (see [[#Format|tables below]]).
Read accesses, however, work as normal accesses to the memory visible through the banks.

The format is inspired by ASCII8/16 mappers and is even compatible with most ROMs using these formats (the only exception being the rare programs that use odd-numbered addresses to switch banks). The aim of this proximity to these classic mappers is to facilitate the work of manufacturers to create cartridge in this new mapper format.

Compared to conventional mappers, this proposal is based on two new main features:
* A 16-bit segment register,
* Banks covering page #0 of MSX memory space (address 0000h~3FFFh).

Usage of page #0 makes it easy to have an extra 16 KB accessible at any time (either by temporarily disabling interrupts for the duration of accesses, or by adding its own ISR).

For the time being, we propose to reserve the 2 most significant bits of the 16-bit bank registers for future extensions of the format (such as SRAM or sound chips support for example).
This leaves 14 bits to select which segment is visible in each bank, for a maximum of 16384 segments.
The reserved bits, must be set to 0.

{| class="wikitable"
|-
!colspan="8"| Higher byte
|
!colspan="8"| Lower byte
|-
! 15 || 14 || 13 || 12 || 11 || 10 || 9 || 8
|
! 7 || 6 || 5 || 4 || 3 || 2 || 1 || 0
|-
| 0 || 0
|colspan="6"| Segment MSB
|
|colspan="8"| Segment LSB
|}

The maximum ROM size is therefore 128 MB (for 8 KB segments) or 256 MB (for 16 KB segments).

=== Write Access ===

Write access to the mapper is use to change the value of the bank switching register (where you can select the ROM segment visible through a bank).
Bellow is the list of the predefined segment switching addresses.

As this new mapper uses 16-bit segment switching registers, it uses 2 bytes for the segment number to be selected in each bank.
All even-numbered addresses (bit #0 of the address set to 0) access the low byte of the 16-bit register, while odd-numbered addresses (bit #0 of the address set to 1) access the high byte.
This way, the segment number can be initialized at once with the [[#Bank switching cost|Z80 instructions for 16-bit memory write access]].

==== NEO-8 mapper ====

* Size of a segment: 8 KB
* Segment switching addresses:
{| class="wikitable"
! Bank (8kB) !! Switching address !! Initial segment
|-
| 0: 0000h~1FFFh || 5000h (mirror at 1000h, 9000h and D000h) || 0000h
|-
| 1: 2000h~3FFFh || 5800h (mirror at 1800h, 9800h and D800h) || 0000h
|-
| 2: 4000h~5FFFh || 6000h (mirror at 2000h, A000h and E000h) || 0000h
|-
| 3: 6000h~7FFFh || 6800h (mirror at 2800h, A800h and E800h) || 0000h
|-
| 4: 8000h~9FFFh || 7000h (mirror at 3000h, B000h and F000h) || 0000h
|-
| 5: A000h~BFFFh || 7800h (mirror at 3800h, B800h and F800h) || 0000h
|}
* Maximum number of segments: 16384
* Maximum ROM size: 128 MB

==== NEO-16 mapper ====

* Size of a segment: 16 KB
* Segment switching addresses:
{| class="wikitable"
! Bank (16kB) !! Switching address !! Initial segment
|-
| 0: 0000h~3FFFh || 5000h (mirror at 1000h, 9000h and D000h) || 0000h
|-
| 1: 4000h~7FFFh || 6000h (mirror at 2000h, A000h and E000h) || 0000h
|-
| 2: 8000h~BFFFh || 7000h (mirror at 3000h, B000h and F000h) || 0000h
|}
* Maximum number of segments: 16384
* Maximum ROM size: 256 MB

=== Read Access ===
When mapper is selected, read accesses to memory pages 0, 1 and 2 (addresses 0000h to BFFFh), are redirected to a given ROM segment according to the value of the bank register corresponding to the address.

For page 3, read accesses are invalid and the value returned is undefined and should not be used. Implementations of the NEO mapper should return the value FFh if page 3 is read, but this value is not guaranteed by the mapper specifications.

=== Detection ===
For emulators and flash tool to detect the NEO mappers, the ROM have to include the following 8 bytes signature right after the 16 bytes ROM header:
* "<tt>ROM_NEO8</tt>" for NEO-8 mapper,
* "<tt>ROM_NE16</tt>" for NEO-16 mapper.

The ROM header (starting with "AB") must be in the first ROM segment at offset 0.
The signature is therefore located at offset 16 of the ROM and may be visible to the Z80 on start-up at addresses 0010h, 4010h and 8010h.

<u>Note</u>: Signature characters have been carefully choosed to prevent existing ROMs to generate false positive signature (See [[ROM type signature]]).

== Support ==

=== Hardware ===
Hardware supporting NEO mapper:
* '''[https://www.msxpico.com/ MSX Pico]''' (normal or WiFi): Support for NEO-8 and NEO-16 mappers up to ~15 MB (firmware 1.25 or above).
* '''[https://www.msxpico.com/ MSX Pico+]''': Support for NEO-8 and NEO-16 mappers up to ~14 MB (firmware 2.12 or above).
* '''[https://github.com/cristianoag/msx-picoverse-public PicoVerse] 2040 and 2350''': Support for NEO-8 and NEO-16 mappers up to ~15 MB.
* '''[https://github.com/arkadiuszmakarenko/RISKYMSX RISKY MSX]''': Support for NEO-8 and NEO-16 mappers up to 256 KB.
* '''[https://github.com/piigaa-densetu-two-dai/MSXpi MSXπ]''': Support for NEO-16 mappers up to 16 MB
* '''[https://github.com/piigaa-densetu-two-dai/MSXpi_plus_v2 MSXπ✨V2]''': Support for NEO-16 mappers up to 16 MB

=== Emulator ===
Emulators supporting NEO mapper:
* {{Emulicious}} '''Emulicious''': Full support for NEO-8 and NEO-16 mappers.
* {{MSXEC}} '''MSXEC''': Support NEO-8 and NEO-16 mappers up to 64 MB (version 20260303 or above).
* {{openMSX}} '''openMSX''': Full support for NEO-8 and NEO-16 mappers (version 20.0 or above).
* {{WebMSX}} '''WebMSX''': Full support for NEO-8 and NEO-16 mappers (version 6.0.7 or above).

=== MSXgl ===

Both NEO-8 and NEO-16 mappers are supported. Use respectively <tt>ROM_NEO8</tt> and <tt>ROM_NEO16</tt> as target format.

MSXgl uses macros to wrap quick bank switching mechanisms. It would therefore be totally transparent for a user to switch, for example, from an ASCII8 or even Konami-SCC mapper, to an NEO-8 mapper.

<syntaxhighlight lang="c">
#define SET_BANK_SEGMENT(bank, segment) /* ... */

// Make segment #30 visible through bank #1
SET_BANK_SEGMENT(1, 30);
</syntaxhighlight>

MSXgl initialize the banks with a unique segment each, to offer the largest possible space available to the user:

<img style="width:400px; margin:0.5em;" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/mapper_neo8.png" />
<img style="width:400px; margin:0.5em;" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/mapper_neo16.png" />

<u>Note</u>: When the application start, segment at 0x4000 always point to segment 0 that include the ROM header. See [[Create a mapped ROM#NEO mapper]] for more details.

== Appendix ==

=== Segment switching address format ===

From a software point of view, the segment switching address is defined as:
{| class="wikitable"
|-
!colspan="17"| 16-bit address
|-
! 15 || 14 || 13 || 12 || 11 || 10 || 9 || 8
|
! 7 || 6 || 5 || 4 || 3 || 2 || 1 || 0
|-
| P || P || B || B || B || x || x || x || || x || x || x || x || x || x || x || R
|}
Where:
* 'PP' (0-3) is the page selection for the MSX to redirect access to the mappers slot. Those bits are ignored by the mapper and contribute to mirroring, but the mapper registers can only be accessed from selected pages.
* 'BBB' (0-7) is the bank's register to write in. All unspecified values are discarded.
:{| class="wikitable"
! Bank !! NEO-8 !! NEO-16
|-
| 0 || 010 || 010
|-
| 1 || 011 || 100
|-
| 2 || 100 || 110
|-
| 3 || 101 ||
|-
| 4 || 110 ||
|-
| 5 || 111 ||
|}
* 'R' (0-1) is the segment switching register's byte selector (0: less significant byte; 1: most significant byte).
* 'x' can be any value (generating mirroring).

So, mirroring occurs on all addresses from the given switching address +2 to the switching address +7FEh on all even-numbered addresses. For example, 5000h is mirrored at 5002h~57FEh.

=== Programmable processor and emulation ===
Here is a pseudo code in C to handle NEO mappers for programmable processor based cartridges or for emulators:
{|
|-
| NEO-8 mapper:
<syntaxhighlight lang="c">
const uint8* romData; // ROM data
uint16 bankValue[6]; // Bank switching register value

// Handle device initialization
void NEO8_Init()
{
for (uint8 i=0; i<6; i++)
bankValue[i] = 0;
}

// Handle write access
void NEO8_Write(uint16 address, uint8 value)
{
uint8 bank = ((address >> 11) & 0x07) - 2;
if (bank > 5)
return; // skip
if (address & 1) // Set bank register MSB
bankValue[bank] = ((value & 0x0F) << 8) | (bankValue[bank] & 0x00FF);
else // Set bank register LSB
bankValue[bank] = (bankValue[bank] & 0xFF00) | (value);
}

// Handle read access
uint8 NEO8_Read(uint16 address)
{
uint8 bank = address >> 13;
if (bank > 5)
return 0xFF; // skip
return romData[(bankValue[bank]) << 13 + (address & 0x1FFF)];
}
</syntaxhighlight>
| NEO-16 mapper:
<syntaxhighlight lang="c">
const uint8* romData; // ROM data
uint16 bankValue[3]; // Bank switching register value

// Handle device initialization
void NEO16_Init()
{
bankValue[0] = bankValue[1] = bankValue[2] = 0;
}

// Handle write access
void NEO16_Write(uint16 address, uint8 value)
{
uint8 bank = ((address >> 12) & 0x03) - 1;
if (bank > 2)
return; // skip
if (address & 1) // Set bank register MSB
bankValue[bank] = ((value & 0x0F) << 8) | (bankValue[bank] & 0x00FF);
else // Set bank register LSB
bankValue[bank] = (bankValue[bank] & 0xFF00) | (value);
}

// Handle read access
uint8 NEO16_Read(uint16 address)
{
uint8 bank = address >> 14;
if (bank > 2)
return 0xFF; // skip
return romData[(bankValue[bank]) << 14 + (address & 0x3FFF)];
}
</syntaxhighlight>
|}

=== Sample program ===
A sample program is available for testing purpose on: https://aoineko.org/msx/targets/rom/

It is available in various sizes:
* NEO-8: 256 KB to 32 MB
* NEO-16: 256 KB to 64 MB

=== Bank switching cost ===
For a program using NEO mapper, the cost of switching only the lower or higher byte of the 16-bit segment register is the same that switching segment for standard ASCII/Konami mappers.
<syntaxhighlight lang="ini">
; Direct access (22 t-states)
LD A,n ; 8 t-states
LD (nn),A ; 14 t-states

; Indirect access (22 t-states)
LD HL,nn ; 11 t-states
LD (HL),n ; 11 t-states
</syntaxhighlight>

Although a program can avoid having to change the 2 bytes (16-bit) of the segment register at once, there are cases where this may be necessary. In such cases, the cost is higher, but remains reasonable.
<syntaxhighlight lang="ini">
; Direct access (28 t-states)
LD HL,nn ; 11 t-states
LD (nn),HL ; 17 t-states

; Indirect access (40 t-states)
LD HL,nn ; 11 t-states
LD (HL),n ; 11 t-states
INC HL ; 7 t-states
LD (HL),n ; 11 t-states
</syntaxhighlight>

=== Logos ===
Here are the logos you can use to indicate that a product is compatible with the NEO mapper:

[https://aoineko.org/msx/files/neomapper8b-logo.png <img style="width:128px" src="https://aoineko.org/msx/files/neomapper8b-logo.png" />]
[https://aoineko.org/msx/files/neomapper8w-logo.png <img style="width:128px" src="https://aoineko.org/msx/files/neomapper8w-logo.png" />]
[https://aoineko.org/msx/files/neomapper16b-logo.png <img style="width:128px" src="https://aoineko.org/msx/files/neomapper16b-logo.png" />]
[https://aoineko.org/msx/files/neomapper16w-logo.png <img style="width:128px" src="https://aoineko.org/msx/files/neomapper16w-logo.png" />]

== Change log ==
* Version 1.0 (2024/02/12)
** Original version
* Version 1.1 (2024/02/20)
** Changed mappers signature to minimize the risk of an old cartridge generating a false positive and to comply to [[ROM type signature]] format.
** Added clarification on PP and BBB values for bank switching addresses.
** Added clarification for read access to the mapper and especially when try to read the page 3.
* Version 1.2 (2026/04/06)
** Added optional official logo for NEO mapper product.
** Added bits 12 and 13 to the register value, increasing the maximum number of segments from 4096 to 16384.
[[Category:Proposal]][[Category:Proposal/Mapper]]

Template:JOYMEGA

2026-05-14T20:24:00Z

Aoineko: Created page with "{{LOGO|logo_joymega.png|JoyMega adapter|ext}}"

Samples

2026-05-14T19:46:26Z

Aoineko: /* lVGM */

Here is a list of sample programs included with '''MSXgl''' to illustrate how to use the library’s various features and functions.
To test a sample program, follow these steps:
# Open a command-line interface in the <tt>MSXgl/projects/samples/</tt> directory.
# Run one of the following commands, depending on your operating system:
#* <tt>build.bat s_game</tt> (Windows)
#* <tt>./build.sh s_game</tt> (Linux & macOS)

Replace <tt>s_game</tt> with the name of the sample you wish to test (there’s no need to include the <tt>.c</tt> file extension).

<u>Note:</u> Sample programs use a configuration system that overwrites the default project settings (<tt>project_config.js</tt>) with a sample-specific configuration file (e.g., <tt>s_game.js</tt>). This approach allows multiple projects to coexist in the same directory without conflicts.

For standalone projects, this step is unnecessary. To learn how to set up your own project from scratch, see [[Create my first program|this guide]].

== Core ==

=== Hello World ===
{{SAMPLE_BOX
|name=Hello
|desc=Program showing the minimal code needed to display a "Hello World!" text.
|module1=
|module2=
|module3=
|module4=
|module5=
|file=s_hello.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_hello.jpg
}}

=== BIOS ===
{{SAMPLE_BOX
|name=BIOS
|desc=Program showing the use of default BIOS functions.
|module1=bios
|module2=
|module3=
|module4=
|module5=
|file=s_bios.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_bios.jpg
}}

=== Clock ===
{{SAMPLE_BOX
|name=Clock
|desc=Program showing the use of the MSX2's Real Time Clock (Ricoh RP-5C01) to get current time and save/load data from CMOS memory.
|module1=clock
|module2=
|module3=
|module4=
|module5=
|file=s_clock.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_clock.jpg
}}

=== PSG ===
{{SAMPLE_BOX
|name=PSG
|desc=Program showing the use of direct control over PSG sound chip.
|module1=psg
|module2=
|module3=
|module4=
|module5=
|file=s_psg.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_psg.jpg
}}

=== System ===
{{SAMPLE_BOX
|name=System
|desc=Program showing the retrieval of system information.
|module1=
|module2=
|module3=
|module4=
|module5=
|file=s_sys.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sys.jpg
}}

== Render ==

=== Draw ===
{{SAMPLE_BOX
|name=Draw
|desc=Program showing the use of Draw module with the MSX2 bitmap screen modes.
|module1=vdp
|module2=draw
|module3=
|module4=
|module5=
|file=s_draw.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_draw.jpg
}}

=== Graph Mode 3 ===
{{SAMPLE_BOX
|name=Graph Mode 3
|desc=Program showing the use of Screen 4 (aka Graph mode 3) with various configuration (including unofficial MSX configurations like "Screen 1.5").
|module1=vdp
|module2=
|module3=
|module4=
|module5=
|file=s_gm3.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_gm3_2.png
}}

=== Print ===
{{SAMPLE_BOX
|name=Print
|desc=Program showing the use of graphical print features (bitmap, sprite, effects, etc.).
|module1=print
|module2=
|module3=
|module4=
|module5=
|file=s_print.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_print.jpg
}}

=== Scrolling ===
{{SAMPLE_BOX
|name=Scrolling
|desc=Program showing the use of multi-directionnal tile-based scrolling and screen adjust register for smooth scrolling.
|module1=vdp
|module2=scroll
|module3=
|module4=
|module5=
|file=s_scroll.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_scroll.png
}}

=== Sprite Mode 1 ===
{{SAMPLE_BOX
|name=Sprite
|desc=Program showing the use of sprite mode 1 and a Sprite Attribute Table flip method to reduce sprite disappearance.
|module1=vdp
|module2=
|module3=
|module4=
|module5=
|file=s_sm1.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sm1.jpg
}}

=== Sprite Mode 2 ===
{{SAMPLE_BOX
|name=Sprite
|desc=Program demonstrating the use of sprite mode 2 (including multi-colors) and split screen using the horizontal interrupt to modify VDP parameters during screen rendering.
|module1=vdp
|module2=
|module3=
|module4=
|module5=
|file=s_sprite.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sprite.jpg
}}

=== Sprite FX ===
{{SAMPLE_BOX
|name=Sprite FX
|desc=Program showing the use of Sprite Tool module to modify sprite data (support Cropping, Flipping, Asking and Rotating).
|module1=sprite_fx
|module2=
|module3=
|module4=
|module5=
|file=s_sprtfx.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sprttool.gif
}}

=== Software Sprite ===
{{SAMPLE_BOX
|name=Software Sprite
|desc=Program showing the use of software sprite for all bitmap modes using VDP commands.
|module1=vdp
|module2=
|module3=
|module4=
|module5=
|file=s_swsprt.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_swsprt.png
}}

=== Software Tile ===
{{SAMPLE_BOX
|name=Software Tile
|desc=Program showing the use of software tile mode for MSX2 bitmap modes (only Screen 5 & 8 has been tested).
|module1=vdp
|module2=
|module3=
|module4=
|module5=
|file=s_swtile.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_swtile.png
}}

=== Text ===
{{SAMPLE_BOX
|name=Text
|desc=Program showing the use of print module with text modes (all MSX1 and MSX2 text/tiled mode).
|module1=print
|module2=
|module3=
|module4=
|module5=
|file=s_text.c
|machine=MSX12
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_text.jpg
}}

=== VDP Command ===
{{SAMPLE_BOX
|name=VDP
|desc=Program showing the use of VDP command to draw several effect in all bitmap modes.
|module1=vdp
|module2=
|module3=
|module4=
|module5=
|file=s_vdpcmd.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_vdpcmd.jpg
}}

== Target format ==

=== Boot Disk ===
{{SAMPLE_BOX
|name=Boot Disk
|desc=Program showing the use boot disk target format. The program will be start from disk without going through MSX-DOS but allow to use BDOS function.
|module1=dos
|module2=
|module3=
|module4=
|module5=
|file=s_dos0.c
|machine=MSX2
|target=DOS0
|ext=
|state=PARTIAL
|img=
}}

=== MSX-DOS ===
{{SAMPLE_BOX
|name=MSX-DOS
|desc=Program showing the use of MSX-DOS 1 routines to load and display image from file.
|module1=dos
|module2=
|module3=
|module4=
|module5=
|file=s_dos.c
|machine=MSX22+
|target=DOS1
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_dos.png
}}

=== MSX-DOS 2 ===
{{SAMPLE_BOX
|name=MSX-DOS 2
|desc=Program showing the use of various MSX-DOS 2 routines to load and display image, get disk information or handle mapped memory.
|module1=dos
|module2=dos_mapper
|module3=
|module4=
|module5=
|file=s_dos2.c
|machine=MSX2
|target=DOS2
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_dos2.png
}}

=== Mapped ROM ===
{{SAMPLE_BOX
|name=Mapped ROM
|desc=Program showing usage of mapped ROM and segments switching.
|module1=
|module2=
|module3=
|module4=
|module5=
|file=s_mapper.c
|machine=MSX1
|target=ROM_ASCII8_128K
|ext=
|state=FUNCTIONAL
|img=
}}

=== NEO mapper ===
{{SAMPLE_BOX
|name=NEO mapper
|desc=Program showing usage of NEO-8 mapped ROM and segments switching.
|module1=
|module2=
|module3=
|module4=
|module5=
|file=s_neomap.c
|machine=MSX1
|target=ROM_NEO8_8M
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_neomap.png
}}

== Utilities ==

=== BASIC USR ===
{{SAMPLE_BOX
|name=BASIC USR
|desc=Program showing the creation of binary to be load and used from BASIC.
|module1=basic_usr
|module2=
|module3=
|module4=
|module5=
|file=s_usr.c
|machine=MSX1
|target=BIN_USR
|ext={{NINJATAP}}
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_usr.png
}}

=== Compressor ===
{{SAMPLE_BOX
|name=Compressor
|desc=Program showing the use of several compression algorithms (RLEp, Bitbuster 1 & 2, ZX0 and Pletter).
|module1=compress/bitbuster
|module2=compress/bitbuster2
|module3=compress/lz48
|module4=compress/pletter
|module5=compress/zx0
|file=s_zip.c
|machine=MSX2
|target=DOS1
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_zip.png
}}

=== Driver ===
{{SAMPLE_BOX
|name=Driver
|desc=Program showing the creation of the driver, a code designed to be placed in memory and executed from a main program. Used in [[#MSX-DOS 2]] sample.
|module1=
|module2=
|module3=
|module4=
|module5=
|file=s_drv.c
|machine=MSX1
|target=RAW
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_drv.png
}}

=== Encryption ===
{{SAMPLE_BOX
|name=Encryption
|desc=Program showing the use of an encoding system to encrypt data. Useful for creating backup codes, for example.
|module1=crypt
|module2=
|module3=
|module4=
|module5=
|file=s_crypt.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_crypt.png
}}

=== Game ===
{{SAMPLE_BOX
|name=Game
|desc=Program showing the use of Game state and Game pawn modules. The Game state module offers state management while Game pawn allows to manage characters (display, animation, movement, collision, etc.)
|module1=game/state
|module2=game/pawn
|module3=
|module4=
|module5=
|file=s_game.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_game.png
}}

=== Localize ===
{{SAMPLE_BOX
|name=Localize
|desc=Demonstration of the localization management module with support for multiple languages and management of different character sets.
|module1=localize
|module2=
|module3=
|module4=
|module5=
|file=s_loc.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_loc.png
}}

=== Math ===
{{SAMPLE_BOX
|name=Math
|desc=Program showing the use of mathematics pre-computed tables, pseudo-random generator and quick-computation functions.
|module1=math
|module2=
|module3=
|module4=
|module5=
|file=s_math.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_math.jpg
}}

=== Menu ===
{{SAMPLE_BOX
|name=Menu
|desc=Program showing the use of Menu module.
|module1=game/menu
|module2=
|module3=
|module4=
|module5=
|file=s_menu.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=PARTIAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_menu.png
}}

=== QR Code ===
{{SAMPLE_BOX
|name=QR Code
|desc=Program showing the use of QR Code module.
|module1=tool/qrcode
|module2=
|module3=
|module4=
|module5=
|file=s_qrcode.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_qrcode.png
}}

=== QR Code Tiny ===
{{SAMPLE_BOX
|name=QR Code
|desc=Program showing the use of QR Code Tiny module (version optimized for fixed size).
|module1=tool/qrcode_tiny
|module2=
|module3=
|module4=
|module5=
|file=s_qrtiny.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_qrtiny.png
}}

=== Save ===
{{SAMPLE_BOX
|name=Save
|desc=Program showing the use of data save from cartridge (supporting floppy disk and PAC cartridge).
|module1=tool/disk_save
|module2=device/pac
|module3=
|module4=
|module5=
|file=s_save.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_save.png
}}

=== WaveGame ===
{{SAMPLE_BOX
|name=WaveGame
|desc=Program demonstrate the use WaveGame feature for the Pico+ cartridge.
|module1=device/wavegame
|module2=
|module3=
|module4=
|module5=
|file=s_wavegm.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_wavegm.png
}}

== Devices ==

=== Joystick ===
{{SAMPLE_BOX
|name=Joystick
|desc=Program showing the use of joystick and input manager.
|module1=input
|module2=input_manager
|module3=
|module4=
|module5=
|file=s_joystk.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_joystick.jpg
}}

=== Keyboard ===
{{SAMPLE_BOX
|name=Keyboard
|desc=Program showing the use of keyboard and input manager.
|module1=input
|module2=input_manager
|module3=
|module4=
|module5=
|file=s_keybrd.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_keyboard.jpg
}}

=== Mouse ===
{{SAMPLE_BOX
|name=Mouse
|desc=Program showing the use of mouse device and universal port (joystick port) device detection.
|module1=input
|module2=
|module3=
|module4=
|module5=
|file=s_mouse.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_mouse.png
}}

=== Ninja Tap ===
{{SAMPLE_BOX
|name=Ninja Tap
|desc=Program showing the use of NinjaTap device to connect up to 8 joysticks on one MSX machine.
|module1=device/ninjatap
|module2=
|module3=
|module4=
|module5=
|file=s_ntap.c
|machine=MSX1
|target=ROM_32K
|ext={{NINJATAP}}
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_ntap.png
}}

=== JoyMega ===
{{SAMPLE_BOX
|name=JoyMega
|desc=Program showing the use of JoyMega adapter to use 8 buttons Megadrive joystick on MSX.
|module1=device/joymega
|module2=device/msx-hid
|module3=
|module4=
|module5=
|file=s_jmega.c
|machine=MSX1
|target=ROM_32K
|ext={{JOYMEGA}}
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_jmega.png
}}

=== Lightgun ===
{{SAMPLE_BOX
|name=Lightgun
|desc=Program showing the use of 'ASCII Plus-X Terminator' and 'MHT Gun-Stick' lightguns on MSX.
|module1=device/lightgun
|module2=
|module3=
|module4=
|module5=
|file=s_lgun.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=PARTIAL
|img=
}}

=== ObsoNET ===
{{SAMPLE_BOX
|name=ObsoNET
|desc=Program showing the use of ObsoNET cartridge using network stack.
|module1=network/obsonet
|module2=
|module3=
|module4=
|module5=
|file=s_onet.c
|machine=MSX1
|target=ROM_16K
|ext=OBSONET
|state=WIP
|img=
}}

=== PAC ===
{{SAMPLE_BOX
|name=PAC
|desc=Program showing the use of PAC or FM-PAC to load/save data into SRAM.
|module1=device/pac
|module2=
|module3=
|module4=
|module5=
|file=s_pac.c
|machine=MSX1
|target=ROM_32K
|ext={{PAC}}
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_pac.png
}}

=== Paddle ===
{{SAMPLE_BOX
|name=Paddle
|desc=Program showing the use of Arkanoid Vaus Paddle module.
|module1=device/paddle
|module2=
|module3=
|module4=
|module5=
|file=s_paddle.c
|machine=MSX1
|target=ROM_48K_ISR
|ext=PADDLE
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_paddle.png
}}

=== V9990 ===
{{SAMPLE_BOX
|name=V9990
|desc=Program showing the use of Yamaha V9990 based video cartridge.
|module1=v9990
|module2=
|module3=
|module4=
|module5=
|file=s_v9990.c
|machine=MSX1
|target=ROM_32K
|ext={{V9990}}
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_v9990.png
}}

== Audio Format ==

=== Arkos ===
{{SAMPLE_BOX
|name=Arkos
|desc=Program to demonstrate the use of the different Arkos Tracker (AT2 and AT3) music replayers.
|module1=arkos/akg_player
|module2=arkos/akm_player
|module3=arkos/aky_player
|module4=
|module5=
|file=s_arkos.c
|machine=MSX1
|target=ROM_ASCII8_128K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_arkos.png
}}

=== ayFX ===
{{SAMPLE_BOX
|name=ayFX
|desc=Program showing the use of ayFX sound effect replayer (both using a bank or a single sound file).
|module1=ayfx/ayfx_player
|module2=
|module3=
|module4=
|module5=
|file=s_ayfx.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_ayfx.jpg
}}

=== lVGM ===
{{SAMPLE_BOX
|name=Light VGM
|desc=Program showing the use of light-VGM's replayer (PSG).
|module1=vgm/lvgm_player
|module2=dos_mapper
|module3=
|module4=
|module5=
|file=s_lvgm.c
|machine=MSX1
|target=DOS2
|ext={{SCC}} {{MSXMUSIC}} {{MSXAUDIO}}
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_lvgm.png
}}

=== NDP ===
{{SAMPLE_BOX
|name=NDP
|desc=Program showing the use of NDP replayer (PSG).
|module1=ndp/ndp_player
|module2=
|module3=
|module4=
|module5=
|file=s_ndp.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_ndp.png
}}

=== PCM-Encoder ===
{{SAMPLE_BOX
|name=PCM Encoder
|desc=Program showing the use of the PCM Encoder's replayer (aka. ''Crystal clean PCM 8bit samples on the poor PSG'').
|module1=pcm/pcmenc
|module2=
|module3=
|module4=
|module5=
|file=s_pcmenc.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_pcm.jpg
}}

=== PCM Play ===
{{SAMPLE_BOX
|name=PCM Play
|desc=Program showing the use of the PCM Play's replayer.
|module1=pcm/pcmplay
|module2=
|module3=
|module4=
|module5=
|file=s_pcmplay.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_pcmplay.png
}}

=== PT3 ===
{{SAMPLE_BOX
|name=PT3
|desc=Program showing the use of Vortex Tracker II's replayer.
|module1=pt3/pt3_player
|module2=
|module3=
|module4=
|module5=
|file=s_pt3.c
|machine=MSX2
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_pt3.jpg
}}

=== Trilo Tracker SCC ===
{{SAMPLE_BOX
|name=Trilo Tracker SCC
|desc=Program showing the use of Trilo Tracker SCC's replayer.
|module1=trilo/trilo_scc_player
|module2=
|module3=
|module4=
|module5=
|file=s_trilo.c
|machine=MSX1
|target=ROM_KONAMI_SCC_128K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_trilo.png
}}

=== VGM ===
{{SAMPLE_BOX
|name=VGM
|desc=Program showing the use of VGM's replayer (PSG, SCC, MSX-Music, MSX-Audio).
|module1=vgm/vgm_player
|module2=
|module3=
|module4=
|module5=
|file=s_vgm.c
|machine=MSX1
|target=ROM_ASCII16_256K
|ext={{SCC}} {{MSXMUSIC}} {{MSXAUDIO}}
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_vgm.jpg
}}

=== WYZ ===
{{SAMPLE_BOX
|name=WYZ
|desc=Program showing the use of WYZ Tracker's replayer (version 0.3).
|module1=wyz/wyz_player
|module2=
|module3=
|module4=
|module5=
|file=s_wyz.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_wyz.png
}}

=== WYZ2 ===
{{SAMPLE_BOX
|name=WYZ2
|desc=Program showing the use of WYZ Tracker's replayer (version 0.3 47d).
|module1=wyz/wyz_player2
|module2=
|module3=
|module4=
|module5=
|file=s_wyz2.c
|machine=MSX1
|target=ROM_32K
|ext=
|state=FUNCTIONAL
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/refs/heads/main/engine/doc/img/project/s_wyz2.png
}}

Template:MSXAUDIO

2026-05-14T19:45:15Z

Aoineko:

Template:MSXAUDIO

2026-05-14T19:43:30Z

Aoineko:

Aoineko:

Projects

2026-05-11T22:11:28Z

Template:LOGO

2026-05-10T19:32:39Z

Aoineko:

{{#switch: {{{3|msx}}}
|msx= <img style="height:24px; vertical-align:bottom; margin:0.2em 0.1em 0.2em 0.1em;" src="https://aoineko.org/msx/img/logo/{{{1|logo_msx.png}}}" title="{{{2|}}}"/>
|ext= <img style="height:32px; vertical-align:bottom; margin:0.2em 0.1em 0.2em 0.1em;" src="https://aoineko.org/msx/img/logo/{{{1|logo_msx.png}}}" title="{{{2|}}}"/>
}}

Template:LOGO

2026-05-10T19:31:41Z

Aoineko:

{{#switch: {{{3|msx}}}
|msx= <img style="height:24px; vertical-align:bottom; margin:0.1em;" src="https://aoineko.org/msx/img/logo/{{{1|logo_msx.png}}}" title="{{{2|}}}"/>
|ext= <img style="height:32px; vertical-align:bottom; margin:0.1em;" src="https://aoineko.org/msx/img/logo/{{{1|logo_msx.png}}}" title="{{{2|}}}"/>
}}