ugBASIC User Manual

This small example shows how to load a file in a compressed way, by using the MSC1 compressor. File from this repository.

 
 a := LOAD("examples/levels_pain.bin") COMPRESSED
 

• contrib_compressor.bas

The instructions here refer to compiling the example from the command line. For Microsoft Windows users we suggest using UGBASIC-IDE, which allows you to compile the example with just one click.

In order to compile and run the example, you need to have the Altirra emulator, and in particular that the altirra executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.atari contrib_compressor.bas -o example.xex
 altirra example.xex
 
 # Windows 
 ugbc.atari.exe contrib_compressor.bas -o example.xex
 altirra example.xex

In order to compile and run the example, you need to have the Altirra emulator, and in particular that the altirra executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.atarixl contrib_compressor.bas -o example.xex
 altirra example.xex
 
 # Windows 
 ugbc.atarixl.exe contrib_compressor.bas -o example.xex
 altirra example.xex

In order to compile and run the example, you need to have the VICE emulator, and in particular that the x64sc executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.c64 contrib_compressor.bas -o example.prg
 x64sc example.prg
 
 # Windows 
 ugbc.c64.exe contrib_compressor.bas -o example.prg
 x64sc example.prg

In order to run the example, you need to have the YAPE emulator. In particular that the yape executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.plus4 contrib_compressor.bas -o example.prg
 yape example.prg
 
 # Windows 
 ugbc.plus4.exe contrib_compressor.bas -o example.prg
 yape example.prg

In order to run the example, you need to have the VICE emulator. In particular that the xplus4 executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.plus4 contrib_compressor.bas -o example.prg
 xplus4 example.prg
 
 # Windows 
 ugbc.plus4.exe contrib_compressor.bas -o example.prg
 xplus4 example.prg

In order to compile and run the example, you need to have the XROAR emulator, and in particular that the xroar executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.d32 contrib_compressor.bas -o example.bin
 xroar -rompath (your rom path) example.bin
 
 # Windows 
 ugbc.d32.exe contrib_compressor.bas -o example.bin
 xroar.exe -rompath (your rom path) example.bin

In order to compile and run the example, you need to have the XROAR emulator, and in particular that the xroar executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.d64 contrib_compressor.bas -o example.bin
 xroar -rompath (your rom path) example.bin
 
 # Windows 
 ugbc.d64.exe contrib_compressor.bas -o example.bin
 xroar.exe -rompath (your rom path) example.bin

In order to compile and run the example, you need to have the DCMOTO emulator, and in particular that the dcmoto executable is accessible.

Then, type this command on the command line and on the emulator:

 # Linux 
 ugbc.pc128op contrib_compressor.bas -o example.k7
 dcmoto
 (choose BASIC 128)
 CLEAR,&H2FFF: LOADM"CASS:",R: EXEC
 
 # Windows 
 ugbc.pc128op.exe contrib_compressor.bas -o example.k7
 dcmoto
 (choose example.k7)
 (choose BASIC 128)
 CLEAR,&H2FFF: LOADM"CASS:",R: EXEC

In order to compile and run the example, you need to have the DCMOTO emulator, and in particular that the dcmoto executable is accessible.

Then, type this command on the command line and on the emulator:

 # Linux 
 ugbc.pc128op contrib_compressor.bas -o example.k7
 dcmoto
 (choose BASIC 128)
 CLEAR,&H2FFF: LOADM"CASS:",R: EXEC
 
 # Windows 
 ugbc.pc128op.exe contrib_compressor.bas -o example.k7
 dcmoto
 (choose example.k7)
 (choose BASIC 128)
 CLEAR,&H2FFF: LOADM"CASS:",R: EXEC

In order to compile and run the example, you need to have the VICE emulator, and in particular that the xvic executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.vic20 contrib_compressor.bas -o example.prg
 xvic --memory 24k example.prg
 
 # Windows 
 ugbc.vic20.exe contrib_compressor.bas -o example.prg
 xvic --memory 24k example.prg

In order to compile and run the example, you need to have the Speccy emulator, and in particular that the speccy executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.zx contrib_compressor.bas -o example.tap
 Speccy example.tap
 
 # Windows 
 ugbc.zx.exe contrib_compressor.bas -o example.tap
 Speccy example.tap

In order to compile and run the example, you need to have the openMsx or the BlueMSX emulator, and in particular that its executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.msx1 contrib_compressor.bas -o example.rom
 openmsx -cart example.rom
 
 # Windows 
 ugbc.msx1.exe contrib_compressor.bas -o example.rom
 openmsx -cart example.rom

 # Linux 
 ugbc.msx1 contrib_compressor.bas -o example.rom
 bluemsx example.rom
 
 # Windows 
 ugbc.msx1.exe contrib_compressor.bas -o example.rom
 bluemsx example.rom

In order to compile and run the example, you need to have the openMsx or the BlueMSX emulator, and in particular that its executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.coleco contrib_compressor.bas -o example.rom
 openmsx -machine \"COL - ColecoVision\" -cart example.rom
 
 # Windows 
 ugbc.coleco.exe contrib_compressor.bas -o example.rom
 bluemsx -machine \"COL - ColecoVision\" example.rom

 # Linux 
 ugbc.coleco contrib_compressor.bas -o example.rom
 bluemsx /machine \"COL - ColecoVision\" /rom1 example.rom
 
 # Windows 
 ugbc.coleco.exe contrib_compressor.bas -o example.rom
 bluemsx  /machine \"COL - ColecoVision\" /rom1 example.rom

In order to compile and run the example, you need to have the BlueMSX emulator, and in particular that its executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.sc3000 contrib_compressor.bas -o example.rom
 bluemsx /machine \"SEGA - SC-3000\" /rom1 example.rom
 
 # Windows 
 ugbc.sc3000.exe contrib_compressor.bas -o example.rom
 bluemsx  /machine \"SEGA - SC-3000\" /rom1 example.rom

In order to compile and run the example, you need to have the BlueMSX emulator, and in particular that its executable is accessible.

Then, type this command on the command line:

 # Linux 
 ugbc.sg1000 contrib_compressor.bas -o example.rom
 bluemsx /machine \"SEGA - SG-1000\" /rom1 example.rom
 
 # Windows 
 ugbc.sg1000.exe contrib_compressor.bas -o example.rom
 bluemsx  /machine \"SEGA - SG-1000\" /rom1 example.rom

If you have found a problem trying to run this example, if you think there is a bug or, more simply, you would like it to be improved, open an issue for this example on GitHub. Thank you!