-
-
Notifications
You must be signed in to change notification settings - Fork 19
Installation & Usage
You can install this plugin, as any other published Godot Engine's plugin, in different ways:
The manual installation can be done as any other repository's manual installation, both through terminal, GitHub Desktop or physical file managing.
Here you can find the official documentation for the manual installation of a repository.
Here's what you specifically need to do to specifically install this plugin for Godot Engine:
-
Using terminal:
-
current working directory:
C:/<user>/<your godot engine project's folder>
(for example, my plugin is a Godot Engine's project which folder is inC:\Users\Nicolò\Documents\GodotProjects\GithubIntegration
) -
repository link:
https://github.com/fenix-hub/godot-engine.github-integration.git
-
current working directory:
-
**Downloading ZIP file: **
- extract the content of the folder
godot-engine.github-integration-<version>
to your project folder. The content should beaddons (folder) , VERSION.md , README.md , .gitignore
. You can just move theaddons
folder in your project folder. If you already have anaddons
folder inside your project folder, just add theaddons/github-integration
zipped folder to youraddons
folder. From the editor you project folder should look likeres://addons/github-integration/...
- extract the content of the folder
Godot Engine supports a in-editor and wab-based Asset Library.
I'll talk about the in-editor installation since the browser installation is very similar to the GitHub one.
Go to the Asset library
tab inside Godot Engine editor, and look for GitHub Integration
.
Click on the plugin, then download
. Godot Engine will download the last published version of the plugin.
QUICK NOTE: currently the Asset Library is manually managed, so sometimes plugins won't show the last updated file, but only the manually accepted ones. To check if you are installing the last version of a plugin, always check the version shown in Godot Engine editor / Asset Library, and the last version of the plugin inside the GitHub original repository.
Once the plugin is downloaded, you caninstall
it inside your project. It is advised to NOT deselect any file exceptREADME.md - TODO.md - VERSION.md
files.
If anaddons/github-integration
folder is successfully added to your project, you are good to go.
Each plugin you install must be activated to work.
In Godot Engine, go to Project > Project Settings > Plugins > GitHub Integration
and under status
select active
.
Now you new button will appear in the Toolbar, the "GitHub" button.
Everything is now ready, let's start using this plugin!
Since v0.7.5 I've decided to not update this plugin anymore.
It doesn't mean this plugin won't be supported anymore, or I will abandon it: I'm planning to fully migrate this project from a simple GDScript addon to a C++ module for Godot.
Eventual bugfixes and additional little features will still be implemented if they are needed to support all platforms and to stay updated to Godot Engine's new version, but due to GDScript and Godot limits, I'll migrate the whole code to a C++, fully implemented and optimized GitHub module.
Please, watch this project or join Discord groups I've mentioned in this page to get all updates.