Difference between revisions of "Samples"

From MSX Game Library

Line 3: Line 3:
 
== Samples ==
 
== Samples ==
  
=== Target format ===
+
=== Core ===
 
 
 
 
=== Misc ===
 
  
 +
==== Hello World ====
 +
{{SAMPLE_BOX
 +
|name=Hello
 +
|desc=Program showing the minimal needs to display a text.
 +
|file=s_hello.c
 +
|machine=MSX1
 +
|state=Fonctional
 +
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_hello.jpg
 +
}}
  
 
==== BIOS ====
 
==== BIOS ====
Line 19: Line 25:
 
}}
 
}}
  
==== Clock ====
+
==== System ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Clock
+
|name=System
|desc=Program showing the use of the Real Time Clock (Ricoh RP-5C01).
+
|desc=blablabla...
|file=s_clock.c
+
|file=s_sys.c
|machine=MSX2
+
|machine=MSX1
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_clock.jpg
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sys.jpg
 
}}
 
}}
 +
 +
=== Render ===
  
 
==== Draw ====
 
==== Draw ====
Line 39: Line 47:
 
}}
 
}}
  
==== Game ====
+
==== Sprite Mode 1 ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Game
+
|name=Sprite
|desc=Program showing the use of game and game's pawn modules.
+
|desc=Program showing the use of sprite mode 1 and SAT flip method.
|file=s_game.c
+
|file=s_sm1.c
 
|machine=MSX1
 
|machine=MSX1
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_game.png
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sm1.jpg
 +
}}
 +
 
 +
==== Sprite Mode 2 ====
 +
{{SAMPLE_BOX
 +
|name=Sprite
 +
|desc=Program showing the use of sprite mode 2 and split screen.
 +
|file=s_sprite.c
 +
|machine=MSX2
 +
|state=Fonctional
 +
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sprite.jpg
 
}}
 
}}
  
==== Hello World ====
+
==== Software Sprite ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Hello
+
|name=Software
|desc=Program showing the minimal needs to display a text.
+
|desc=Program showing the use of software sprite using VDP commands.
|file=s_hello.c
+
|file=s_swsprt.c
|machine=MSX1
+
|machine=MSX2
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_hello.jpg
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_swsprt.png
 
}}
 
}}
  
==== Joystick ====
+
==== Text ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Joystick
+
|name=Text
|desc=Program showing the use of joystick and input manager.
+
|desc=blablabla...
|file=s_joystk.c
+
|file=s_text.c
|machine=MSX1
+
|machine=MSX1}}/{{MSX2
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_joystick.jpg
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_text.jpg
 
}}
 
}}
  
==== Keyboard ====
+
==== VDP Command ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Keyboard
+
|name=VDP
|desc=Program showing the use of keyboard and input manager.
+
|desc=blablabla...
|file=s_keybrd.c
+
|file=s_vdpcmd.c
|machine=MSX1
+
|machine=MSX2
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_keyboard.jpg
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_vdpcmd.jpg
 
}}
 
}}
 +
 +
=== Target format ===
  
 
==== ROM Mapper ====
 
==== ROM Mapper ====
Line 87: Line 107:
 
|state=Fonctional
 
|state=Fonctional
 
|img=
 
|img=
 +
}}
 +
 +
=== Utilities ===
 +
 +
==== Game ====
 +
{{SAMPLE_BOX
 +
|name=Game
 +
|desc=Program showing the use of game and game's pawn modules.
 +
|file=s_game.c
 +
|machine=MSX1
 +
|state=Fonctional
 +
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_game.png
 
}}
 
}}
  
Line 107: Line 139:
 
|state=Fonctional
 
|state=Fonctional
 
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_print.jpg
 
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_print.jpg
}}
 
 
==== PSG ====
 
{{SAMPLE_BOX
 
|name=PSG
 
|desc=Program showing the use of direct control over PSG chip.
 
|file=s_psg.c
 
|machine=MSX1
 
|state=Fonctional
 
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_psg.jpg
 
 
}}
 
}}
  
Line 129: Line 151:
 
}}
 
}}
  
==== Sprite Mode 1 ====
+
==== Compress ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Sprite
+
|name=Compress
|desc=Program showing the use of sprite mode 1 and SAT flip method.
+
|desc=blablabla...
|file=s_sm1.c
+
|file=s_zip.c
|machine=MSX1
+
|machine=MSX2
|state=Fonctional
+
|state=WIP
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sm1.jpg
+
|img=
 
}}
 
}}
  
==== Sprite Mode 2 ====
+
=== Devices ===
{{SAMPLE_BOX
 
|name=Sprite
 
|desc=Program showing the use of sprite mode 2 and split screen.
 
|file=s_sprite.c
 
|machine=MSX2
 
|state=Fonctional
 
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sprite.jpg
 
}}
 
  
==== Software Sprite ====
+
==== Clock ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Software
+
|name=Clock
|desc=Program showing the use of software sprite using VDP commands.
+
|desc=Program showing the use of the Real Time Clock (Ricoh RP-5C01).
|file=s_swsprt.c
+
|file=s_clock.c
 
|machine=MSX2
 
|machine=MSX2
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_swsprt.png
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_clock.jpg
 
}}
 
}}
  
==== System ====
+
==== Joystick ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=System
+
|name=Joystick
|desc=blablabla...
+
|desc=Program showing the use of joystick and input manager.
|file=s_sys.c
+
|file=s_joystk.c
 
|machine=MSX1
 
|machine=MSX1
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_sys.jpg
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_joystick.jpg
 
}}
 
}}
  
==== Text ====
+
==== Keyboard ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=Text
+
|name=Keyboard
|desc=blablabla...
+
|desc=Program showing the use of keyboard and input manager.
|file=s_text.c
+
|file=s_keybrd.c
|machine=MSX1}}/{{MSX2
+
|machine=MSX1
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_text.jpg
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_keyboard.jpg
 
}}
 
}}
  
==== VDP Command ====
+
==== PSG ====
 
{{SAMPLE_BOX
 
{{SAMPLE_BOX
|name=VDP
+
|name=PSG
|desc=blablabla...
+
|desc=Program showing the use of direct control over PSG chip.
|file=s_vdpcmd.c
+
|file=s_psg.c
|machine=MSX2
+
|machine=MSX1
 
|state=Fonctional
 
|state=Fonctional
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_vdpcmd.jpg
+
|img=raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/sample_psg.jpg
}}
 
 
 
==== Compress ====
 
{{SAMPLE_BOX
 
|name=Compress
 
|desc=blablabla...
 
|file=s_zip.c
 
|machine=MSX2
 
|state=WIP
 
|img=
 
 
}}
 
}}
  

Revision as of 12:50, 17 May 2023

The samples marked as "WIP" state are not functional.
Trying to test them for now is useless.

Samples

Core

Hello World

Program showing the minimal needs to display a text.
32K

BIOS

Program showing the use of basic BIOS functions.
32K

System

blablabla...
32K

Render

Draw

Program showing the use of Draw module in different screen mode.
32K

Sprite Mode 1

Program showing the use of sprite mode 1 and SAT flip method.
32K

Sprite Mode 2

Program showing the use of sprite mode 2 and split screen.
32K

Software Sprite

Program showing the use of software sprite using VDP commands.
32K

Text

blablabla...
32K
/

VDP Command

blablabla...
32K

Target format

ROM Mapper

Program showing usage of ROM mapper segments.
32K

Utilities

Game

Program showing the use of game and game's pawn modules.
32K

Math

Program showing the use of mathematics pre-calculated tables and pseudo-random generator.
32K

Print

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

Scrolling

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

Compress

blablabla...
32K

Devices

Clock

Program showing the use of the Real Time Clock (Ricoh RP-5C01).
32K

Joystick

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

Keyboard

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

PSG

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

Audio Format

Arkos

blablabla...
32K

ayFX

blablabla...
32K

PCM-Encoder

blablabla...
32K

PT3

blablabla...
32K

VGM

blablabla...
32K

WYZ

blablabla...
32K

Targets

blablabla...
32K

Template

Template MSX1

blablabla...
32K

Template MSX2

blablabla...
32K