Latest

• Note: Visit the Chroma Animation Guide to find the latest supported plugin for Chroma RGB.

Godot Chroma SDK Plugin

Note: The Chroma SDK for Godot plugin is for the Windows platform only!

Table of Contents

• See Also
• About
• Quick Start
• Project Setup

See Also

Docs:

• Chroma Animation Guide - Visual examples of the Chroma Animation API methods

Plugins:

• CChromaEditor - C++ native MFC library for playing and editing Chroma animations

About

• GodotHello

The GodotHello project is a Godot sample app that shows the animations from the Chroma Animation Guide.

Screenshot:

Video:

[OLD VIDEO] Godot Native Plugin - Chroma SDK

Quick Start

• Install Synapse

• Make sure the Chroma Connect module is installed.

• If you don't have Chroma hardware, you can see Chroma effects with the Chroma Emulator

• Download a prebuilt binary from releases and place in the project folder

• Animations - Sample folder for Chroma animation files

• CChromaEditorLibrary64.dll - Adds Chroma animation support and uses the ChromaSDK

• Godot_ChromaSDK.dll - Native Godot library that makes the ChromaAnimation library available

• chromasdk.gdextension - Godot GDExtension

• NodeSample.gd - Sample gdscript that uses the ChromaAnimation API

Project Setup

These are the steps to build the Godot_ChromaSDK.dll library.

• First generate the Godot include files

• Reference: GDExtension C++ example

• Pick a starting point:

cd C:\Public

• Clone the Godot project (3.0 is actually the old version so get the main version)

mkdir gdextension_cpp_example
cd gdextension_cpp_example
git init
git submodule add -b 4.1 https://github.com/godotengine/godot-cpp
cd godot-cpp
git submodule update --init
cd ..

• Update the submodules from the gdextension_cpp_example folder

cd gdextension_cpp_example
git submodule update --init

• Download the 64-bit standard version of Godot

• Build the C++ bindings from the gdextension_cpp_example folder

"%USERPROFILE%\Downloads\Godot\Godot_v3.2.1-stable_win64.exe" --dump-extension-api

• Install Python 2.7 or better

• Install PIP

• Download Scons 3.1.2

• ... or install scons with pip

c:\Python27\python.exe -m pip install scons

• Make sure your target Python version is first in the path if you have multiple versions installed.

SET PATH=C:\Python27;%PATH%

Debug Build

• Generate the C++ bindings from the gdextension_cpp_example folder

cd godot-cpp
"%USERPROFILE%\Downloads\Godot\scons-3.1.2\script\scons.bat" platform=windows target=template_debug custom_api_file=<PATH_TO_FILE> -j4

• Add C++ include folders to the project

C:\Public\gdextension_cpp_example\godot-cpp\include;C:\Public\gdextension_cpp_example\godot-cpp\gen\include;C:\Public\gdextension_cpp_example\godot-cpp\gdextension

• Add the godot library to the project

libgodot-cpp.windows.template_debug.x86_64.lib

Release Build

• Generate the C++ bindings from the gdextension_cpp_example folder

cd godot-cpp
"%USERPROFILE%\Downloads\Godot\scons-3.1.2\script\scons.bat" platform=windows target=template_release custom_api_file=<PATH_TO_FILE> -j4

• Add C++ include folders to the project

C:\Public\gdextension_cpp_example\godot-cpp\include;C:\Public\gdextension_cpp_example\godot-cpp\gen\include;C:\Public\gdextension_cpp_example\godot-cpp\gdextension

• Add the godot library to the project

libgodot-cpp.windows.template_release.x86_64.lib

All

• Add to Linker General Additional Library Directories

C:\Public\gdnative_cpp_example\godot-cpp\bin