Difference between revisions of "Samples"

From MSX Game Library

(Target format)
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
The samples marked as "WIP" state are not functional.<br/>Trying to test them for now is useless.
+
Here is a list of sample programs supplied with '''MSXgl''' to demonstrate the use of the library's various functions.
  
== Samples ==
+
To try out the different samples, simply open a command line in the <tt>MSXgl/projects/samples/</tt> directory and execute:
 +
* <tt>build.bat s_game</tt> (Windows)
 +
* <tt>./build.sh s_game</tt> (Linux & macOS)
  
=== Core ===
+
Replace "<tt>s_game</tt>" with the name of the sample you want to try out (sample's <tt>.c</tt> file extension is not needed).
  
==== Hello World ====
+
<u>Note:</u> Samples use a system to overwrites the project configuration (<tt>project_config.js</tt>) with a sample-specific configuration file (e.g. <tt>s_game.js</tt>). This makes it possible to have several projects in the same directory. This is not necessary for a stand-alone project. See how to [[Create my first program|create your own new program]].
 +
 
 +
== Core ==
 +
 
 +
=== Hello World ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Hello
 
|name=Hello
Line 22: Line 28:
 
}}
 
}}
  
==== BIOS ====
+
=== BIOS ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=BIOS
 
|name=BIOS
Line 39: Line 45:
 
}}
 
}}
  
==== Clock ====
+
=== Clock ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Clock
 
|name=Clock
|desc=Program showing the use of the Real Time Clock (Ricoh RP-5C01) to get current time and save/load from CMOS memory.
+
|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
 
|module1=clock
 
|module2=
 
|module2=
Line 56: Line 62:
 
}}
 
}}
  
==== PSG ====
+
=== PSG ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=PSG
 
|name=PSG
Line 73: Line 79:
 
}}
 
}}
  
==== System ====
+
=== System ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=System
 
|name=System
Line 90: Line 96:
 
}}
 
}}
  
=== Render ===
+
== Render ==
  
==== Draw ====
+
=== Draw ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Draw
 
|name=Draw
Line 109: Line 115:
 
}}
 
}}
  
==== Graph Mode 3 ====
+
=== Graph Mode 3 ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Graph Mode 3
 
|name=Graph Mode 3
Line 123: Line 129:
 
|ext=
 
|ext=
 
|state=Functional
 
|state=Functional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_gm3.png
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_gm3_2.png
 
}}
 
}}
  
==== Print ====
+
=== Print ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Print
 
|name=Print
Line 143: Line 149:
 
}}
 
}}
  
==== Sprite Mode 1 ====
+
=== Sprite Mode 1 ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Sprite
 
|name=Sprite
Line 160: Line 166:
 
}}
 
}}
  
==== Sprite Mode 2 ====
+
=== Sprite Mode 2 ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Sprite
 
|name=Sprite
Line 177: Line 183:
 
}}
 
}}
  
==== Software Sprite ====
+
=== 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
 
{{SAMPLE_BOX
 
|name=Software Sprite
 
|name=Software Sprite
Line 194: Line 217:
 
}}
 
}}
  
==== Software Tile ====
+
=== Software Tile ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Software Tile
 
|name=Software Tile
Line 211: Line 234:
 
}}
 
}}
  
==== Text ====
+
=== Text ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Text
 
|name=Text
Line 228: Line 251:
 
}}
 
}}
  
==== VDP Command ====
+
=== VDP Command ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=VDP
 
|name=VDP
Line 245: Line 268:
 
}}
 
}}
  
=== Target format ===
+
== Target format ==
  
==== Boot Disk ====
+
=== Boot Disk ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Boot Disk
 
|name=Boot Disk
Line 264: Line 287:
 
}}
 
}}
  
==== MSX-DOS ====
+
=== MSX-DOS ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=MSX-DOS
 
|name=MSX-DOS
Line 281: Line 304:
 
}}
 
}}
  
==== MSX-DOS 2 ====
+
=== MSX-DOS 2 ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=MSX-DOS 2
 
|name=MSX-DOS 2
Line 298: Line 321:
 
}}
 
}}
  
==== Mapped ROM ====
+
=== Mapped ROM ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Mapped ROM
 
|name=Mapped ROM
Line 309: Line 332:
 
|file=s_mapper.c
 
|file=s_mapper.c
 
|machine=MSX1
 
|machine=MSX1
|target=ROM_ASCII8_128
+
|target=ROM_ASCII8_128K
 
|ext=
 
|ext=
 
|state=Functional
 
|state=Functional
Line 315: Line 338:
 
}}
 
}}
  
=== Utilities ===
+
=== NEO mapper ===
 
 
==== Game ====
 
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Game
+
|name=NEO mapper
|desc=Program showing the use of Game and Game pawn modules. The Game module offers state management while Game pawn allows to manage characters (display, animation, movement, collision, etc.)
+
|desc=Program showing usage of NEO-8 mapped ROM and segments switching.
|module1=game
+
|module1=
|module2=game_pawn
+
|module2=
 
|module3=
 
|module3=
 
|module4=
 
|module4=
 
|module5=
 
|module5=
|file=s_game.c
+
|file=s_neo0.c
 
|machine=MSX1
 
|machine=MSX1
|target=ROM_32K
+
|target=ROM_NEO8_8M
 
|ext=
 
|ext=
|state=Functional
+
|state=WIP
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_game.png
+
|img=
 
}}
 
}}
  
==== Math ====
+
== Utilities ==
 +
 
 +
=== BASIC USR ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Math
+
|name=BASIC USR
|desc=Program showing the use of mathematics pre-calculated tables and pseudo-random generator.
+
|desc=Program showing the creation of binary to be load and used from BASIC.
|module1=
+
|module1=basic_usr
 
|module2=
 
|module2=
 
|module3=
 
|module3=
 
|module4=
 
|module4=
 
|module5=
 
|module5=
|file=s_math.c
+
|file=s_usr.c
 +
|machine=MSX1
 +
|target=BIN_USR
 +
|ext={{NINJATAP}}
 +
|state=Functional
 +
|img=
 +
}}
 +
 
 +
=== Compressor ===
 +
{{SAMPLE_BOX
 +
|name=Compressor
 +
|desc=Program showing the use of several compression algorithms (RLEp, Bitbuster 1 & 2, ZX0 and Pletter).
 +
|module1=compress
 +
|module2=compress/bitbuster
 +
|module3=compress/bitbuster2
 +
|module4=compress/zx0
 +
|module5=compress/pletter
 +
|file=s_zip.c
 
|machine=MSX2
 
|machine=MSX2
|target=ROM_32K
+
|target=DOS1
 
|ext=
 
|ext=
 
|state=Functional
 
|state=Functional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_math.jpg
+
|img=
 
}}
 
}}
  
==== Scrolling ====
+
=== Game ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Scrolling
+
|name=Game
|desc=Program showing the use of multi-directionnal tile-based scrolling and screen adjust register for smooth scrolling.
+
|desc=Program showing the use of Game and Game pawn modules. The Game module offers state management while Game pawn allows to manage characters (display, animation, movement, collision, etc.)
|module1=
+
|module1=game
|module2=
+
|module2=game_pawn
 
|module3=
 
|module3=
 
|module4=
 
|module4=
 
|module5=
 
|module5=
|file=s_scroll.c
+
|file=s_game.c
|machine=MSX2
+
|machine=MSX1
 
|target=ROM_32K
 
|target=ROM_32K
 
|ext=
 
|ext=
 
|state=Functional
 
|state=Functional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_scroll.png
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_game.png
 
}}
 
}}
  
==== Compress ====
+
=== Localize ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Compress
+
|name=Localize
|desc=blablabla...
+
|desc=Show case of the localization handling module.
|module1=
+
|module1=localize
 
|module2=
 
|module2=
 
|module3=
 
|module3=
 
|module4=
 
|module4=
 
|module5=
 
|module5=
|file=s_zip.c
+
|file=s_loc.c
|machine=MSX2
+
|machine=MSX1
 
|target=ROM_32K
 
|target=ROM_32K
 
|ext=
 
|ext=
|state=Partial
+
|state=Functional
|img=
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_loc.png
 
}}
 
}}
  
==== BASIC USR ====
+
=== Math ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=BASIC USR
+
|name=Math
|desc=.
+
|desc=Program showing the use of mathematics pre-computed tables, pseudo-random generator and quick-computation functions.
|module1=
+
|module1=math
 
|module2=
 
|module2=
 
|module3=
 
|module3=
 
|module4=
 
|module4=
 
|module5=
 
|module5=
|file=s_usr.c
+
|file=s_math.c
|machine=
+
|machine=MSX2
 
|target=ROM_32K
 
|target=ROM_32K
 
|ext=
 
|ext=
 
|state=Functional
 
|state=Functional
|img=
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_math.jpg
 
}}
 
}}
  
==== Compressor ====
+
=== Scrolling ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Compressor
+
|name=Scrolling
|desc=.
+
|desc=Program showing the use of multi-directionnal tile-based scrolling and screen adjust register for smooth scrolling.
|module1=
+
|module1=vdp
|module2=
+
|module2=scroll
 
|module3=
 
|module3=
 
|module4=
 
|module4=
 
|module5=
 
|module5=
|file=s_zip.c
+
|file=s_scroll.c
|machine=
+
|machine=MSX2
 
|target=ROM_32K
 
|target=ROM_32K
 
|ext=
 
|ext=
 
|state=Functional
 
|state=Functional
|img=
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_scroll.png
 
}}
 
}}
  
=== Devices ===
+
== Devices ==
  
==== Joystick ====
+
=== Joystick ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Joystick
 
|name=Joystick
 
|desc=Program showing the use of joystick and input manager.
 
|desc=Program showing the use of joystick and input manager.
|module1=
+
|module1=input
|module2=
+
|module2=input_manager
 
|module3=
 
|module3=
 
|module4=
 
|module4=
Line 438: Line 478:
 
}}
 
}}
  
==== Keyboard ====
+
=== Keyboard ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Keyboard
 
|name=Keyboard
 
|desc=Program showing the use of keyboard and input manager.
 
|desc=Program showing the use of keyboard and input manager.
|module1=
+
|module1=input
|module2=
+
|module2=input_manager
 
|module3=
 
|module3=
 
|module4=
 
|module4=
Line 455: Line 495:
 
}}
 
}}
  
==== Mouse ====
+
=== Mouse ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Mouse
 
|name=Mouse
|desc=.
+
|desc=Program showing the use of mouse device and universal port (joystick port) device detection.
|module1=
+
|module1=input
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 465: Line 505:
 
|module5=
 
|module5=
 
|file=s_mouse.c
 
|file=s_mouse.c
|machine=
+
|machine=MSX1
 
|target=ROM_32K
 
|target=ROM_32K
 
|ext=
 
|ext=
Line 472: Line 512:
 
}}
 
}}
  
==== Ninja Tap ====
+
=== Ninja Tap ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Ninja Tap
 
|name=Ninja Tap
|desc=Program showing the use of NinjaTap device.
+
|desc=Program showing the use of NinjaTap device to connect up to 8 joysticks on one MSX machine.
|module1=
+
|module1=device/ninjatap
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 484: Line 524:
 
|machine=MSX1
 
|machine=MSX1
 
|target=ROM_32K
 
|target=ROM_32K
|ext={{NinjaTap}}
+
|ext={{NINJATAP}}
 
|state=Functional
 
|state=Functional
 
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_ntap.png
 
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_ntap.png
 
}}
 
}}
  
==== ObsoNET ====
+
=== ObsoNET ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=ObsoNET
 
|name=ObsoNET
|desc=.
+
|desc=Program showing the use of ObsoNET cartridge using network stack.
|module1=
+
|module1=network/obsonet
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 499: Line 539:
 
|module5=
 
|module5=
 
|file=s_onet.c
 
|file=s_onet.c
|machine=
+
|machine=MSX1
|target=ROM_32K
+
|target=ROM_16K
 
|ext=
 
|ext=
 
|state=Partial
 
|state=Partial
Line 506: Line 546:
 
}}
 
}}
  
==== PAC ====
+
=== PAC ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=PAC
 
|name=PAC
|desc=.
+
|desc=Program showing the use of PAC or FM-PAC to load/save data into SRAM.
|module1=
+
|module1=device/pac
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 523: Line 563:
 
}}
 
}}
  
==== V9990 ====
+
=== V9990 ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=V9990
 
|name=V9990
|desc=.
+
|desc=Program showing the use of Yamaha V9990 based video cartridge.
|module1=
+
|module1=v9990
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 533: Line 573:
 
|module5=
 
|module5=
 
|file=s_v9990.c
 
|file=s_v9990.c
|machine=
+
|machine=MSX1
 
|target=ROM_32K
 
|target=ROM_32K
|ext=
+
|ext={{V9990}}
 
|state=Functional
 
|state=Functional
|img=
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_v9990.png
 
}}
 
}}
  
=== Audio Format ===
+
== Audio Format ==
  
==== Arkos ====
+
=== Arkos ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Arkos
 
|name=Arkos
|desc=blablabla...
+
|desc=Program showing the use of Arkos Tracker II's replayers.
|module1=
+
|module1=arkos/akg_player
|module2=
+
|module2=arkos/akm_player
|module3=
+
|module3=arkos/aky_player
 
|module4=
 
|module4=
 
|module5=
 
|module5=
 
|file=s_arkos.c
 
|file=s_arkos.c
 
|machine=MSX1
 
|machine=MSX1
|target=ROM_32K
+
|target=ROM_ASCII8_128K
 
|ext=
 
|ext=
 
|state=Functional
 
|state=Functional
Line 559: Line 599:
 
}}
 
}}
  
==== ayFX ====
+
=== ayFX ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=ayFX
 
|name=ayFX
|desc=blablabla...
+
|desc=Program showing the use of ayFX's replayer.
|module1=
+
|module1=ayfx/ayfx_player
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 576: Line 616:
 
}}
 
}}
  
==== lVGM ====
+
=== lVGM ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Light VGM
 
|name=Light VGM
|desc=.
+
|desc=Program showing the use of light-VGM's replayer (PSG).
|module1=
+
|module1=lvgm/lvgm_player
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 586: Line 626:
 
|module5=
 
|module5=
 
|file=s_lvgm.c
 
|file=s_lvgm.c
|machine=
+
|machine=MSX1
 
|target=ROM_32K
 
|target=ROM_32K
 
|ext=
 
|ext=
Line 593: Line 633:
 
}}
 
}}
  
==== PCM-Encoder ====
+
=== PCM-Encoder ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=PCM Encoder
 
|name=PCM Encoder
|desc=.
+
|desc=Program showing the use of the PCM Encoder's replayer (aka. ''Crystal clean PCM 8bit samples on the poor PSG'').
|module1=
+
|module1=pcm/pcmenc
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 610: Line 650:
 
}}
 
}}
  
==== PCM Play ====
+
=== PCM Play ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=PCM Play
 
|name=PCM Play
|desc=.
+
|desc=Program showing the use of the PCM Play's replayer.
|module1=
+
|module1=pcm/pcmplay
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 620: Line 660:
 
|module5=
 
|module5=
 
|file=s_pcmplay.c
 
|file=s_pcmplay.c
|machine=
+
|machine=MSX1
 
|target=ROM_32K
 
|target=ROM_32K
 
|ext=
 
|ext=
Line 627: Line 667:
 
}}
 
}}
  
==== PT3 ====
+
=== PT3 ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=PT3
 
|name=PT3
|desc=blablabla...
+
|desc=Program showing the use of Vortex Tracker II's replayer.
|module1=
+
|module1=pt3/pt3_player
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 644: Line 684:
 
}}
 
}}
  
==== Trilo Tracker SCC ====
+
=== Trilo Tracker SCC ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=Trilo Tracker SCC
 
|name=Trilo Tracker SCC
|desc=.
+
|desc=Program showing the use of Trilo Tracker SCC's replayer.
|module1=
+
|module1=trilo/trilo_scc_player
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 654: Line 694:
 
|module5=
 
|module5=
 
|file=s_trilo.c
 
|file=s_trilo.c
|machine=
+
|machine=MSX1
|target=ROM_32K
+
|target=ROM_KONAMI_SCC_128K
 
|ext=
 
|ext=
 
|state=Functional
 
|state=Functional
Line 661: Line 701:
 
}}
 
}}
  
==== VGM ====
+
=== VGM ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=VGM
 
|name=VGM
|desc=blablabla...
+
|desc=Program showing the use of VGM's replayer (PSG, SCC, MSX-Music, MSX-Audio).
|module1=
+
|module1=vgm/vgm_player
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 672: Line 712:
 
|file=s_vgm.c
 
|file=s_vgm.c
 
|machine=MSX1
 
|machine=MSX1
|target=ROM_32K
+
|target=ROM_ASCII16_256K
|ext=
+
|ext={{SCC}} {{MSXMUSIC}} {{MSXAUDIO}}
 
|state=Functional
 
|state=Functional
 
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_vgm.jpg
 
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_vgm.jpg
 
}}
 
}}
  
==== WYZ ====
+
=== WYZ ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=WYZ
 
|name=WYZ
|desc=blablabla...
+
|desc=Program showing the use of WYZ Tracker's replayer (version 0.3).
|module1=
+
|module1=wyz/wyz_player
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 695: Line 735:
 
}}
 
}}
  
==== WYZ2 ====
+
=== WYZ2 ===
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
 
|name=WYZ2
 
|name=WYZ2
|desc=.
+
|desc=Program showing the use of WYZ Tracker's replayer (version 0.3 47d).
|module1=
+
|module1=wyz/wyz_player2
 
|module2=
 
|module2=
 
|module3=
 
|module3=
Line 706: Line 746:
 
|file=s_wyz2.c
 
|file=s_wyz2.c
 
|machine=MSX1
 
|machine=MSX1
|target=ROM_32K
 
|ext=
 
|state=Functional
 
|img=
 
}}
 
 
== Targets ==
 
{{SAMPLE_BOX
 
|name=Targets
 
|desc=blablabla...
 
|module1=
 
|module2=
 
|module3=
 
|module4=
 
|module5=
 
|file=s_target.c
 
|machine=MSX1
 
|target=ROM_32K
 
|ext=
 
|state=Functional
 
|img=
 
}}
 
 
== Template ==
 
 
=== Template MSX1 ===
 
{{SAMPLE_BOX
 
|name=Template
 
|desc=blablabla...
 
|module1=
 
|module2=
 
|module3=
 
|module4=
 
|module5=
 
|file=template.c
 
|machine=MSX1
 
|target=ROM_32K
 
|ext=
 
|state=Functional
 
|img=
 
}}
 
 
=== Template MSX2 ===
 
{{SAMPLE_BOX
 
|name=Template MSX2
 
|desc=blablabla...
 
|module1=
 
|module2=
 
|module3=
 
|module4=
 
|module5=
 
|file=template_msx2.c
 
|machine=MSX2
 
 
|target=ROM_32K
 
|target=ROM_32K
 
|ext=
 
|ext=

Latest revision as of 21:20, 13 January 2024

Here is a list of sample programs supplied with MSXgl to demonstrate the use of the library's various functions.

To try out the different samples, simply open a command line in the MSXgl/projects/samples/ directory and execute:

  • build.bat s_game (Windows)
  • ./build.sh s_game (Linux & macOS)

Replace "s_game" with the name of the sample you want to try out (sample's .c file extension is not needed).

Note: Samples use a system to overwrites the project configuration (project_config.js) with a sample-specific configuration file (e.g. s_game.js). This makes it possible to have several projects in the same directory. This is not necessary for a stand-alone project. See how to create your own new program.

Core

Hello World

Program showing the minimal code needed to display a text.
32K

BIOS

Program showing the use of default BIOS functions.
32K

Clock

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.
32K

PSG

Program showing the use of direct control over PSG sound chip.
32K

System

Program showing the retrieval of system information.
  • File: s_sys.c
  • State: ✔️ Functional
32K

Render

Draw

Program showing the use of Draw module with the MSX2 bitmap screen modes.
32K

Graph Mode 3

Program showing the use of Screen 4 (aka Graph mode 3) with various configuration (including unofficial MSX configurations like "Screen 1.5").
32K

Print

Program showing the use of graphical print features (bitmap, sprite, effects, etc.).
32K

Sprite Mode 1

Program showing the use of sprite mode 1 and a Sprite Attribute Table flip method to reduce sprite disappearance.
32K

Sprite Mode 2

Program showing the use of sprite mode 2 and split screen to change VDP setting during screen rendering.
32K

Sprite FX

Program showing the use of Sprite Tool module to modify sprite data (support Cropping, Flipping, Asking and Rotating).
32K

Software Sprite

Program showing the use of software sprite for all bitmap modes using VDP commands.
32K

Software Tile

Program showing the use of software tile mode for MSX2 bitmap modes (only Screen 5 & 8 has been tested).
32K

Text

Program showing the use of print module with text modes (all MSX1 and MSX2 text/tiled mode).
32K

VDP Command

Program showing the use of VDP command to draw several effect in all bitmap modes.
32K

Target format

Boot Disk

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.
  • Showcased modules:
  • File: s_dos0.c
  • State: ❓ Partially functional
BOOT

MSX-DOS

Program showing the use of MSX-DOS 1 routines to load and display image from file.
MSX-DOS

MSX-DOS 2

Program showing the use of various MSX-DOS 2 routines to load and display image, get disk information or handle mapped memory.
MSX-DOS 2

Mapped ROM

Program showing usage of mapped ROM and segments switching.
ASCII8 128K

NEO mapper

Program showing usage of NEO-8 mapped ROM and segments switching.
NEO8 8M

Utilities

BASIC USR

Program showing the creation of binary to be load and used from BASIC.
BIN (USR)

Compressor

Program showing the use of several compression algorithms (RLEp, Bitbuster 1 & 2, ZX0 and Pletter).
MSX-DOS

Game

Program showing the use of Game and Game pawn modules. The Game module offers state management while Game pawn allows to manage characters (display, animation, movement, collision, etc.)
32K

Localize

Show case of the localization handling module.
32K

Math

Program showing the use of mathematics pre-computed tables, pseudo-random generator and quick-computation functions.
32K

Scrolling

Program showing the use of multi-directionnal tile-based scrolling and screen adjust register for smooth scrolling.
32K

Devices

Joystick

Program showing the use of joystick and input manager.
32K

Keyboard

Program showing the use of keyboard and input manager.
32K

Mouse

Program showing the use of mouse device and universal port (joystick port) device detection.
32K

Ninja Tap

Program showing the use of NinjaTap device to connect up to 8 joysticks on one MSX machine.
32K

ObsoNET

Program showing the use of ObsoNET cartridge using network stack.
16K

PAC

Program showing the use of PAC or FM-PAC to load/save data into SRAM.
32K

V9990

Program showing the use of Yamaha V9990 based video cartridge.
32K

Audio Format

Arkos

Program showing the use of Arkos Tracker II's replayers.
ASCII8 128K

ayFX

Program showing the use of ayFX's replayer.
32K

lVGM

Program showing the use of light-VGM's replayer (PSG).
32K

PCM-Encoder

Program showing the use of the PCM Encoder's replayer (aka. Crystal clean PCM 8bit samples on the poor PSG).
32K

PCM Play

Program showing the use of the PCM Play's replayer.
32K

PT3

Program showing the use of Vortex Tracker II's replayer.
32K

Trilo Tracker SCC

Program showing the use of Trilo Tracker SCC's replayer.
KONAMI 128K

VGM

Program showing the use of VGM's replayer (PSG, SCC, MSX-Music, MSX-Audio).
ASCII16 256K

WYZ

Program showing the use of WYZ Tracker's replayer (version 0.3).
32K

WYZ2

Program showing the use of WYZ Tracker's replayer (version 0.3 47d).
32K