-
-
+
+
+ A modern open-source SDK for Nintendo 64 development. +
-## Welcome to libdragon +
+
+ 
+
+
+
+🎨 Graphics & 3D+ +RDPQ • Sprites • Text & Fonts • TrueType • OpenGL 1.1 • Magma 3D • +glTF Models + + |
+
+
+🔊 Audio & Music+ +RSP Mixer • Streaming • VADPCM • ULC • Opus • XM modules • YM modules • +MIDI + SF2 + + |
+
+
+🎬 Video+ +MPEG-1 • H.264 • YUV • +Subtitles • +Seeking • Render-to-texture + + |
+
+
+🎮 Input & Peripherals+ +Joypads • GameCube controllers • Mouse • Controller Pak • Rumble Pak • Transfer Pak • Bio Sensor • RTC + + |
+
+
+💾 Storage & Filesystems+ +DragonFS • C/POSIX API • +SD cards • EEPROM • +SRAM • +FlashRAM • +iQue NAND/BBFS + + |
+
+
+🚀 Runtime & Boot+ +64-bit ABI • +C11 Runtime • iQue support • +Open-source IPL3 • +Region free • +Coroutines • DSO/Overlays + + |
+
+
+⚙️ Low-level Hardware+ +RSP / RSPQ • RDP / RDPQ • Custom microcode • PI DMA queue • Interrupts • Timers • Exceptions + + |
+
+
+🛠️ Toolchain & Asset Pipeline+ +GCC 16 • Docker • PNG • TTF/OTF • glTF • Audio conversion • Video conversion • Compression + + |
+
+
+🐛 Debugging & Profiling+ +Crash screen • Symbolized backtraces • Assertions • USB logging • +CPU profiler • RDP validation • RSP crash diagnostics + + |
+
N64_ROM_SAVETYPE=eeprom4k or
+ * N64_ROM_SAVETYPE=eeprom16k to your Makefile.
+ *
+ * This uses the advanced homebrew header which is supported by most emulators
+ * and flashcarts compatible with libdragon. It still advised to use the
+ * #eeprom_present and #eeprom_total_blocks functions to probe the EEPROM
+ * and gracefully handles the case where no EEPROM is present, even if it
+ * was requested.
+ *
+ * Cheap flashcarts might not support the advanced homebrew header,
+ * and they most likely default to a 4k EEPROM as default save states for
+ * non-commercial ROMs. If your ROM requires a 16k EEPROM to operate
+ * properly, users of those flashcarts will need to manually configure the
+ * EEPROM type using flashcart-specific instructions.
*/
+#include
- * ABCDEFGHIJKLMNOPQRSTUVWXYZ!"#`*+,-./:=?\@
+ * 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ!"#'*+,-./:=?@
+ * 。゛゜ァィゥェォッャュョヲンアイウエオカキクケコサシスセソタ
+ * チツテトナニヌネノハヒフヘホマミムメモヤユヨラリルレロワガギグゲ
+ * ゴザジズゼゾダヂヅデドバビブベボパピプペポ
*
*
* The space character is also allowed. Any other character will be
* converted to a space before writing to the Controller Pak.
+ *
+ * The buffer here is longer because it allows for UTF-8 encoding of the
+ * Japanese characters.
*/
- char name[19];
+ char name[16*3 + 1 + 4*3 + 1];
} entry_structure_t;
#ifdef __cplusplus
@@ -90,6 +105,7 @@ extern "C" {
* @retval -1 if the sector was out of bounds or sector_data was null
* @retval -2 if there was an error reading part of a sector
*/
+__attribute__((deprecated("use cpak_read instead")))
int read_mempak_sector( int controller, int sector, uint8_t *sector_data );
/**
@@ -109,6 +125,7 @@ int read_mempak_sector( int controller, int sector, uint8_t *sector_data );
* @retval -1 if the sector was out of bounds or sector_data was null
* @retval -2 if there was an error writing part of a sector
*/
+__attribute__((deprecated("use cpak_write instead")))
int write_mempak_sector( int controller, int sector, uint8_t *sector_data );
/**
@@ -124,6 +141,7 @@ int write_mempak_sector( int controller, int sector, uint8_t *sector_data );
* @retval -2 if the Controller Pak is not present or couldn't be read
* @retval -3 if the Controller Pak is bad or unformatted
*/
+__attribute__((deprecated("use cpakfs_fsck() instead")))
int validate_mempak( int controller );
/**
@@ -137,6 +155,7 @@ int validate_mempak( int controller );
*
* @return The number of blocks free on the memory card or a negative number on failure
*/
+__attribute__((deprecated("use cpakfs_get_stats() instead")))
int get_mempak_free_space( int controller );
/**
@@ -156,6 +175,7 @@ int get_mempak_free_space( int controller );
* @retval -1 if the entry is out of bounds or entry_data is null
* @retval -2 if the Controller Pak is bad or not present
*/
+__attribute__((deprecated("use the new cpak filesystem (cpak.h) instead")))
int get_mempak_entry( int controller, int entry, entry_structure_t *entry_data );
/**
@@ -170,6 +190,7 @@ int get_mempak_entry( int controller, int entry, entry_structure_t *entry_data )
* @retval 0 if the Controller Pak was formatted successfully.
* @retval -2 if the Controller Pak was not present or couldn't be formatted.
*/
+__attribute__((deprecated("use cpakfs_format() instead")))
int format_mempak( int controller );
/**
@@ -194,6 +215,7 @@ int format_mempak( int controller );
* @retval -2 if the Controller Pak was not present or bad
* @retval -3 if the data couldn't be read
*/
+__attribute__((deprecated("use the new cpak filesystem (cpak.h) instead")))
int read_mempak_entry_data( int controller, entry_structure_t *entry, uint8_t *data );
/**
@@ -218,6 +240,7 @@ int read_mempak_entry_data( int controller, entry_structure_t *entry, uint8_t *d
* @retval -4 if there wasn't enough space to store the note
* @retval -5 if there is no room in the TOC to add a new entry
*/
+__attribute__((deprecated("use the new cpak filesystem (cpak.h) instead")))
int write_mempak_entry_data( int controller, entry_structure_t *entry, uint8_t *data );
/**
@@ -235,6 +258,7 @@ int write_mempak_entry_data( int controller, entry_structure_t *entry, uint8_t *
* @retval -1 if the entry was invalid
* @retval -2 if the Controller Pak was bad or not present
*/
+__attribute__((deprecated("use the new cpak filesystem (cpak.h) instead")))
int delete_mempak_entry( int controller, entry_structure_t *entry );
#ifdef __cplusplus
diff --git a/include/mgfx.h b/include/mgfx.h
new file mode 100644
index 000000000..af461670f
--- /dev/null
+++ b/include/mgfx.h
@@ -0,0 +1,202 @@
+/**
+ * @file mgfx.h
+ * @author Dennis Heinze