Using gdextwiz

This content may differ from the most recent version. Please refer to the gdextwiz help message for more accurate documentation.

Term descriptions

workspace

A package that represents a stand-alone GDExtension. The workspace has bootstrap.nim and configuration files in the root. Other source files can be placed anywhere as long as the path is followed, but the src/ directory is prepared as default.

bootstrap.nim

This file is the entry point for GDExtension. Specifies the classes to be registered with the engine, and building it generates the dynamic library that is the body of GDExtension.

Command descriptions

gdextwiz install

Shorthands for nimble install https://github.com/godot-nim/gdext-nim

gdextwiz uninstall

Shorthands for nimble uninstall -yi gdext gdextgen gdextcore gdextwiz

gdextwiz upgrade

Shorthands for gdextwiz uninstall; gdextwiz install

gdextwiz new-workspace

Generate project template, called workspace.
If you understand how the GDExtension works and know what options you need to tell the nim compiler to do so, there is no need to use it.

gdextwiz build

A command to compile a bootstrap.nim found by traversing upward from the current directory.
If project.godot is found instead of bootstrap.nim, build-all is called.

gdextwiz build-all

A command to search a project.godot from current dir to '/' and compile all bootstrap.nim under it.