Installation

Step 0: Download Godot!

That's kind of obvious, but you do need Godot game engine installed in your computer! You can download the latest version here

CAUTION: Godot 4.1+ Version needed for the SDK to work

Step 1: Download The SDK

Download the latest version of Godot Solana SDK from here: https://github.com/ZenRepublic/GodotSolanaSDKDemoPackage/releases

Step 2: Import the SDK

Importing the SDK is as simple as extracting the "addons" folder from the downloaded zip file right into your project's root folder.

CAUTION: If your project already has "addons" folder, then inside the downloaded zip folder navigate to addons -> SolanaSDK and extract this folder to it instead

Step 3: Enable the Plugin

After importing the SDK to your project, you may encounted a bunch of errors. That's just because the addon expect certain scripts to be present, which you can do by enabling the plugin!

Inside Godot, go to Project -> Project Settings -> Plugins and you should see SolanaSDK plugin there. Enable the checkmark to enable the plugin and that should make the errors go away.

To make sure the plugin worked, head over to "Autoload" section in the same Project Settings window and check if there are the following Autoload Scenes added:

These are very important singleton scenes which will be autoloaded every time you go into play mode. Having SolanaService always available from autoload section allows for easy calls from any part of your code for anything web3 related.

In the next section, you will see what SolanaService does and how you can configure it to your liking.