aoineko-fr / msxgl

The MSX Game Library in C language

MSXgl is a Game Library wrote in C and targeting MSX computers.

The purpose of this library is to provide C programmers with the whole set of functionalities to make a game with high performance. Even though 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. Also, the most expensive features are written in assembler.

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

Many sample programs are available to demonstrate the different features of the library.

The MSXgl Build Tool allows you to create a final program for a large number of formats with just 1 click:

• Plain ROM from 8K to 64K (interrupt handler can be installed 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 V9958) and V9990,
• PSG (AY-3-8910), MSX-Music, MSX-Audio, Konami SCC,
• Keyboard, Joystick, Mouse and Ninja Tap (4 joysticks adaptator),
• ROM mapper, slot manager, and Real Time Clock (RP-5C01).

Here are also the supported audio formats:

• Arkos Tracker 2 (AKG, AKY and AKM)
• Trilo Tracker SCC
• Vortex Tracker II (PT3)
• WYZ Tracker (WYZ)
• 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 MSX Resource Center and MSX Village who have been very helpful. The library is distributed under the Creative Commons BY-SA license. Tools or sources from other authors may use another free license.

Documentation:

• Code documentation: /engine/doc/html/ or https://aoineko.org/msxgl-doc
• Library documentation: https://aoineko.org/msxgl

If you have any question, feel free to join the MSXgl Discord server.

msxgl's Issues

Allow compilation on different OSes

We need some scripts to compile MSXgl and samples on Mac OS and GNU.

VDP_SetMode should not touch the frequency setting

When I do VDP_SetMode(VDP_MODE_SCREEN5); the VDP frequency is set to 50Hz, even if it was set to 60Hz before.
This is undesirable behavior. The VDP frequency should not be touched.

Reproduction scenario:
Program snippet:

#include "msxgl.h"
#include "vdp.h"

void main()
{
    VDP_SetMode(VDP_MODE_SCREEN5);
    while (true) {
        // no need to do anything
    }
}

Start with e.g. CBIOS MSX2+ (which runs at 60Hz normally)

After the screen has been set, you can see in the openMSX / menu / advanced / toys and utilities / info panel that the frequency has been changed to 50Hz.

VDP_Poke_16K problem

VDP_Poke_16K sometimes writes to the wrong memory address in VRAM. It's rare, but it happens. I am using the 128K version as a workaround for now. Can provide example code if needed.

Sample images

Maybe these sample images could be in a docs folder (or you can ignore this issue and just reference them from here since https://msxvillage.fr/ doesn't allow linking from outside, but github allows it). 😉

Allow MSXbin to write size of the imported data as a constant

For instance:

const unsigned char data[] = {
        0x43, 0x33, 0x33, 0x34, 0x43, 0x33, 0x33, 0x34, 0x43, 0x33, 0x33, 0x34, 
        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF 
};
const unsigned int data_length = 24;

smooth scroll code

Your lib inspired me to write a smooth scroll code, it is not as fast as I'd like but I thought about sharing it with you in case you are interested

https://pastebin.com/hiFKPSE7

New ZX0 FAST ROM routine to be included

There's a code for FAST ZX0 decompressor that runs in ROM. I think it's a good addition to MSXgl.
If you want to take a look this is the link: https://github.com/uniabis/z80depacker/blob/master/dzx0_fastrom.asm

Dirty screen with s_text sample in DOS2 mode

Step to reproduce:

• cd projects/samples/
• add Target = "DOS2" to s_text.js
• ./build.sh s_text
• open the emulator using emul/dos2/ as diska (e.g. openmsx -machine Philips_NMS_8250 -ext msxdos2 -diska emul/dos2/)

Using up and down arrows, the other fonts seem to be ok.

Skipping already compiled files

Hi,

I admire your great DOS batch file skills (seriously), but I managed to make an improvement, that makes SDCC skip files for which the compiled output is newer than the source file. This makes compiles instantaneous if only small changes were made, which helps me drink less coffee. Here is the relevant snippet:

rem ***************************************************************************
rem * COMPILE C SOURCE                                                        *
rem ***************************************************************************
if /I %FileExt%==.c (

	rem Find out if the source file changed:
	copy %File% %OutDir% /Y >NUL
	cd %OutDir%
	for /F %%i in ('dir /B /O:D %FileName%.c %FileName%.sym') do set Newest=%%i
	cd ..

	if /I !Newest! NEQ %FileName%.c ( 

		echo Skipping !FileName!.c: up-to-date.
		goto :SkipThisFile
	)

	set AddOpt=%CompileOpt%
	if /I %Optim%==Speed (set AddOpt=!AddOpt! --opt-code-speed)
	if /I %Optim%==Size (set AddOpt=!AddOpt! --opt-code-size)

	set SDCCParam=-c -mz80 --vc -DTARGET=TARGET_%Target% -DMSX_VERSION=MSX_%Machine% -I%ProjDir% -I%LibDir%\src -I%LibDir%\content !AddOpt! %File% -o %OutDir%\

	echo %BLUE%Compiling %1 using SDCC C compiler...%RESET%
	
	echo SDCC !SDCCParam!
	%Compiler% !SDCCParam!

        if errorlevel 1 ( goto :Error )

)

:SkipThisFile

Information from stackoverflow was used:
https://stackoverflow.com/questions/1687014/how-do-i-compare-timestamps-of-files-in-a-batch-script
https://stackoverflow.com/questions/14686330/how-do-i-make-a-windows-batch-script-completely-silent
because I don't know much about batch files. ;)

Greets,
Jacco.

Bug in memory.c

There is a bug in:
void* Mem_DynamicAlloc(u16 size)
The bug is here:
struct MemChunkHeader* newChunk = (struct MemChunkHeader*)(chunk + needSize); // New free sub-chunk
chunk has to be converted to u16 or you allocate 4 times more bytes. This is the fix

struct SptChunkHeader* newChunk = (struct SptChunkHeader*)(((u16)chunk) + needSize); // New free sub-chunk

MBM player

I've done a bit of search for a MBplayer. Accordindlty to mrc,
https://www.msx.org/news/software/en/moonblaster-14-driver-for-msx-basic-update

the latest Moon Blaster player should be the one mantained by BIFI here

http://msxbanzai.tni.nl/dev/MBPLYSRC.LZH

Could you port it to SDCC ?

Cos and Sin tables are unsigned

Cos and sin tables should be signed, this is causing the s_clock.c example to fail with SDCC 4.4
If you need to keep trigonometric tables unsigned you need to cast then to signed each time you use them
In attach the s_clock.c fixed without changing the trigonometric tables

s_clock.c.txt