Difference between revisions of "Main Page"
From MSX Game Library
 (→Get Starting)  | 
				 (→Get Starting)  | 
				||
| (66 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | __NOTOC__  | + | __NOTOC__<img style="width:512px;" src="https://raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/logo/msxgl-tate-logo.png" />  | 
| + | |||
| + | <span style="border:solid thin black; padding-right:0.2em; font-family:'Arial Black';"><span style="color:white; background:black; padding:0 0.3em 0 0.2em; margin-right:0.2em;">MSX</span>GL</span> is a free and open source Game Library wrote in C and targeting MSX computers.  | ||
| + | |||
| + | '''GitHub: https://github.com/aoineko-fr/MSXgl''' [[image:Github_Logo.png|16px]]  | ||
== Get Starting ==  | == Get Starting ==  | ||
| − | * [[What is   | + | * [[What is MSXgl?]]  | 
| − | * [[Install|Install and Setup]]  | + | * '''[[Install|Install and Setup]]'''  | 
| − | |||
* [[Create my first program]]  | * [[Create my first program]]  | ||
| + | ** [[What to choose?|What to choose before starting?]]  | ||
| + | ** [[Create a plain ROM]]  | ||
| + | ** [[Create a mapped ROM]]  | ||
| + | * [[Samples|Sample programs]] (showcase MSXgl features)  | ||
| + | * [[Code documentation]] (library source documentation)  | ||
| + | * [[Types|Variables type]]  | ||
| + | * [[Release]] | [[Roadmap]] (what coming next?)  | ||
| + | * [[Projects]]  | ||
| + | * [[Help]]  | ||
== Modules ==  | == Modules ==  | ||
| + | {{:Modules}}  | ||
| − | + | == Build tool ==  | |
| − | * [[  | + | * [[Target|Target media]] (ROM, MegaROM, DOS Disk, etc.)  | 
| − | * [[  | + | * [[Build tool]] (project configuration options)  | 
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* [[Defines]]  | * [[Defines]]  | ||
| + | * [[Emulators]]  | ||
== Data ==  | == Data ==  | ||
* [[:category:Font|Font]]  | * [[:category:Font|Font]]  | ||
* [[:category:Cursor|Cursor]]  | * [[:category:Cursor|Cursor]]  | ||
| + | |||
| + | == Tools ==  | ||
| + | * [[MSXtk]] (tool kit)  | ||
| + | ** [[MSXbin]] (binary data convertor)  | ||
| + | ** [[MSXcrypt]] (encryption tool)  | ||
| + | ** [[MSXhex]] (binary generator from IHX file)  | ||
| + | ** [[MSXimg]] (image convertor)  | ||
| + | ** [[MSXmath]] (precompute table generator)  | ||
| + | ** [[MSXzip]] (compressor)  | ||
| + | * [[SDCC]]  | ||
| + | * [[VS Code]]  | ||
| + | * [[MGS|MSX Game Scores]]  | ||
| + | |||
| + | == Links ==  | ||
| + | * [[Image:Github_Logo.png|16px]] [https://github.com/aoineko-fr/MSXgl GitHub repository]  | ||
| + | * [[Image:Discord_Logo.png|16px]] [https://discord.gg/REmAhcw6rp Discord server]  | ||
| + | * [[Image:Bookcase.png|16px]] [https://aoineko.org/msxgl-doc Online documentation]  | ||
| + | * [[Ressources]] (about MSXgl and MSX)  | ||
Latest revision as of 19:46, 19 October 2025
MSXGL is a free and open source Game Library wrote in C and targeting MSX computers.
GitHub: https://github.com/aoineko-fr/MSXgl 
Get Starting
- What is MSXgl?
 - Install and Setup
 - Create my first program
 - Sample programs (showcase MSXgl features)
 - Code documentation (library source documentation)
 - Variables type
 - Release | Roadmap (what coming next?)
 - Projects
 - Help
 
Modules
Core:
- bios (MSX BIOS)
 - clock (RTC)
 - dos (MSX-DOS 1 & 2)
 - input (Joystick, keyboard and mouse)
 - math (Random and fast computation)
 - memory (Heap or dynamic allocator)
 - print (Display text)
 - string
 - system (Low-level features)
 
Graphic:
Gameplay:
- game/state (Game states)
 - game/menu (Menu)
 - game/pawn (Character move, anim, physics and collision)
 - game/sequence
 - input_manager
 
Tools:
- crypt (Encryptage)
 - debug (debug features)
 - dos_mapper
 - fsm (Finite-state machine)
 - localize (Translation manager)
 - tool/disk_save (Save on disk from ROM)
 - tool/mem_op (Quick operation on buffer)
 - tool/qrcode_tiny (Tiny QR Code generator)
 - tool/qrcode (QR Code generator)
 - tool/reg (Registers setting)
 - tool/sjis (Shift-JIS conversion)
 
Devices:
- device/joymega (JoyMega)
 - device/msx-hid (MSX-HID detection)
 - device/ninjatap
 - device/pac (SRAM catridge)
 - device/paddle (Arkanoid Vaus Paddle)
 - device/wavegame (Pico+ WaveGame)
 
Audio chips:
Audio players:
- arkos/akg_player (Arkos Tracker 2 and 3)
 - arkos/akm_player
 - arkos/aky_player
 - ayfx/ayfx_player
 - ndp/ndp_player (NDP driver)
 - pcm/pcmenc
 - pcm/pcmplay
 - pt3/pt3_player (Pro Tracker 3)
 - trilo/trilo_scc_player (Trilo Tracker)
 - trilo/trilo_fm_player 🚧WIP
 - vgm/lvgm_player (Light-VGM)
 - vgm/vgm_player
 - wyz/wyz_player (WYZ Tracker)
 - wyz/wyz_player2
 
Compression:
- compress (RLEp)
 - compress/bitbuster
 - compress/bitbuster2
 - compress/lz48 (3 unpackers)
 - compress/pletter
 - compress/zx0 (4 unpackers)
 - msxi/msxi_unpack 🚧WIP
 
Network:
Helpers:
Build tool
- Target media (ROM, MegaROM, DOS Disk, etc.)
 - Build tool (project configuration options)
 - Defines
 - Emulators
 
Data
Tools
- MSXtk (tool kit)
 - SDCC
 - VS Code
 - MSX Game Scores
 
Links
-  
 GitHub repository -  
 Discord server -  
 Online documentation - Ressources (about MSXgl and MSX)