Godot MariaDB Connector Plugin

A GDExtension-based MariaDB connector for Godot 4(4.3+), allowing direct database access from Godot without relying on third-party middleware.

Features

• Connect to MariaDB databases directly from Godot.
• Perform queries, insert/update/delete operations, and handle results.
• MySQL Native(SHA1) and ED25519(SHA512) authentication, plain or pre-hashed passwords.
• Argon2 slow hash Argon2Hasher class wrapper, with high entropy salt generation function.
• Cross-platform support (Linux, Windows, ARM64).
• Uses GDExtension, requiring no custom engine builds.

Installation

Download the Addon from the Godot editor AssetLib tab.

or

1. Download the Addon from Github

Download addon.zip from the latest release.

2. Add to Your Godot Project

Move the uncompressed addons/mariadb_connector/ folder into your project's directory.

3. GDExtension Auto-Detection

It appears GDExtension binaries do not require enabling in the Godot plugin settings. Once the files are in place, Godot will automatically detect and load the extension.

(Note: The AssetLib does not update the addon automatically. Updating requires closing the project, deleting the <project>/addons/mariadb_connector/ folder, only the mariadb_connector/ folder itself is required, and reinstallation.
AssetLib addons require moderator approval, the AssetLib version may be behind releases.)

Usage

For detailed usage examples, please refer to the Demo Project included in the repository.

You can also watch my Tutorials and checkout the series Projects.

You can find the demo inside the demo/ folder, which demonstrates how to:

• Connect to a MariaDB database.
• Execute queries (SELECT, INSERT, UPDATE, DELETE).
• Handle results properly.
• Configure and create hashed using Argon2Wrapper and generated salt, using the added function.

License

Unlike many other database connectors, this plugin is licensed under MIT, not GPL. Although MariaDB itself is GPL, this connector only communicates with MariaDB servers via standard network protocols—meaning it does not fall under GPL’s derivative work restrictions. This ensures no licensing conflicts when using this plugin in closed-source or commercial Godot projects.

Support

Join my Discord Server for help and feedback.

For issues, open a ticket on GitHub Issues.

Contributing

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Submit a Pull Request.

You can find the build instructions at Godot Docs.

Donations

If you find this project useful and would like to support development, consider donating:

• Patreon
• Buy Me a Coffee
• Ko-fi

Version Updates Summary

v1.5.0 - Added static member connect_instance, doc additions and updates, added gdscript examples in demo. MariaDBConnector::connect_instance returns a connected MariaDBConnector instance bypassing the need for the new() constructor and a connect_db... method.

v1.4.0 - Added new breakout methods for query and supporting last_error member variable to test for errors, context method name was changed, added gdscript examples in demo.

v1.3.0 - Added a connection method to faacilitate base64 encoded baswords with a supporting context class.

v1.2.2 - Added buffer checks and timeout property to compensate for slower MariaDB servers on Rasberry Pi SD card installed OS.

v1.2.1 - Added authtype description to editor docs.

v1.2.0 - Added PHC Winner Argon2 slow hash and mbedtls based high entropy salt generation that uses the salt length property.

Bug Fixes

v1.2.0 - Zapped reintroduced prehash = false bug, for good this time.