A command line interface for Godot's GDExtension
Project description
gdextension-cli
A command line interface for Godot's GDExtension.
My intention with this tool was to create an automated way to create a C++ based GDExtension
project. The process behind gdextension-cli new <NAME>
is
based Godot's GDExtension documentation.
Therefore, this tool implements a templating mechanism to create projects from a git repository or
a local directory. By default, the new
command uses https://github.com/3LK3/gdextension-template
as the template. You can also use your own repository.
Requirements
- Python >= 3.8
- Git
- SCons
- you will most likely need SCons to build your extension anyway. But since you have python
installed, you can install SCons via
pip install scons
- you will most likely need SCons to build your extension anyway. But since you have python
installed, you can install SCons via
Installation
pip install gdextension-cli
Usage
Create a new project
gdextension-cli new <NAME>
This will create a project called in a new directory relative to your current path.
By default, https://github.com/3LK3/gdextension-template is used as the project template.
In order to install the latest version of Godot (godot-cpp) with the default template you can use:
gdextension-cli new <NAME> --godot-version master --template-version main
First we are using
- godot-version master because this is the main branch of godot-cpp.
- template-version main is the main branch of the template repository.
From a custom git repository
You can also use your own template repository to create a new project.
gdextension-cli new <NAME> --from-git https://github.com/<you>/<your-custom-template>
From a local directory
If you have a template on your local file system you can also create a project from there.
gdextension-cli new <NAME> --from-local /home/you/your_template
Technical insides
Uses the following python libraries:
- Jinja2 used for templating new projects
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file gdextension_cli-0.0.4.tar.gz
.
File metadata
- Download URL: gdextension_cli-0.0.4.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cff99a82e7a5cb02774867c4e0beb587c20e67ee85e628bd014415c9425b7049 |
|
MD5 | a6eb8517123557666bd56b3515182c5e |
|
BLAKE2b-256 | 4b5bce8998066ed8dd5a4ae99ef801b6a6edba031dbbca3c3c4dc0627ae08a35 |
File details
Details for the file gdextension_cli-0.0.4-py3-none-any.whl
.
File metadata
- Download URL: gdextension_cli-0.0.4-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a5b15895b1a26dfdf422e298f32653e506e293a201e0c20a90a561616d980b1 |
|
MD5 | 75c5197359c58946736073b9862581a3 |
|
BLAKE2b-256 | 2125d64c0e81b60c3ca41812733d0628e7d245477967754b856f1dc05d48957e |