gdextwiz

📘 gdextwiz Manual

Note

This document may not reflect the latest version of gdextwiz.
For the most accurate and up-to-date information, please run:

gdextwiz --help

---

🔖 Term: bootstrap.nim

The bootstrap.nim file serves as the entry point for your GDExtension module.
It defines which classes should be registered with the engine.
Compiling this file produces the dynamic library that implements your GDExtension logic.

---

🔧 Command Reference

gdextwiz new-extension

Generates a template for a new GDExtension project.

This command is mainly intended for beginners or quick prototyping.
If you're already familiar with GDExtension and the necessary compiler options, you may not need to use this command.

---

gdextwiz build

Searches upward from the current directory to find the nearest bootstrap.nim and compiles it.

If a project.godot file is found before bootstrap.nim, this command automatically delegates to build-all.

---

gdextwiz build-all

Searches upward from the current directory for a project.godot file, then finds and builds all bootstrap.nim files under that project root.

This is useful for projects with multiple extensions.

---

gdextwiz editor

Searches upward for a project.godot file and launches the Godot editor using:

godot --editor

---

gdextwiz run

Equivalent to:

gdextwiz build && godot

However, if the .godot/ directory is missing, it falls back to run-editor.

---

gdextwiz run-editor

Equivalent to:

gdextwiz build && gdextwiz editor