GDExtension repo template taken from: https://github.com/nathanfranke/gdextension
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Nathan Franke 7989c2f7e3
add todo to SConstruct
4 years ago
.github/workflows add .gitattributes, minor github workflows change 4 years ago
godot-cpp@8dbaf5a7ff add code 4 years ago
project add .gitkeep 4 years ago
src add _ready and _process to example 4 years ago
.gitattributes add .gitattributes, minor github workflows change 4 years ago
.gitignore move project files to subdirectory, remove extra imports 4 years ago
.gitmodules add code 4 years ago
LICENSE add LICENSE 4 years ago
README.md update README.md 4 years ago
SConstruct add todo to SConstruct 4 years ago

README.md

gdextension

Self-contained gdextension template for Godot Engine 4+

Getting started:

  1. Clone this repository (or a new repository with this template) with submodules.
    • git clone --recurse-submodules https://github.com/nathanfranke/gdextension.git
      cd gdextension
  2. Build all libraries for the current platform.
    • scons
  3. Import, edit, and play project/ using Godot Engine 4+.
  4. Check the output:
    Hello GDScript!
    Hello GDExtension Node!
    Hello GDExtension Singleton!
    

Repository structure:

  • project/ - Godot project template.
    • addons/example/ - Files to be distributed to other projects.¹
    • demo/ - Scenes and scripts for internal testing. Not strictly necessary.
  • src/ - Source code of this extension.
  • godot-cpp/ - Submodule needed for GDExtension compilation.

¹ Before distributing as an addon, all platform binaries must be in the bin/ directory. This is done automatically by GitHub Actions.

Make it your own:

  1. Rename project/addons/example/ and project/addons/example/example.gdextension.
  2. Replace LICENSE and README.md.
  3. Not required, but consider leaving a note about this template if you found it helpful.

Distributing your extension on the Godot Asset Library:

  1. Go to Repository→Actions→Latest Action and download the artifact.
  2. Test the artifact (it should be a working Godot project).
  3. Create a new release on GitHub, uploading the artifact as an asset.
  4. On the asset, Right Click→Copy Link to get a direct file URL.
  5. When submitting/updating on the Godot Asset Library, Change Repository host to Custom and Download URL to the one you copied.