55 lines
3.4 KiB
Markdown
55 lines
3.4 KiB
Markdown
<p align="right">
|
|
<a href="https://discord.gg/KnJGY9S">
|
|
<img src="https://github.com/fenix-hub/ColoredBadges/blob/master/svg/social/discord.svg" alt="react" style="vertical-align:top; margin:6px 4px">
|
|
</a>
|
|
</p>
|
|
|
|
This plugin is now supported in [Godot Extended Library Discord](https://discord.gg/JNrcucg), check out the [Godot Extended Library Project](https://github.com/godot-extended-libraries)!
|
|
|
|
<img src="addons/github-integration/github-logo.png" align="left" width="64" height="64">
|
|
|
|
# GitHub Integration
|
|
A complete GitHub integration for your Godot Editor! Manage your project without even opening your browser.
|
|
|
|
Author: *"Nicolo (fenix) Santilio"*
|
|
Version: *1.4.3*
|
|
Godot Version: *3.2.4-rc3*
|
|
Wiki: *[supported](https://github.com/fenix-hub/godot-engine.github-integration/wiki)*
|
|
|
|
<img align="center" src="addons/github-integration/screenshots/banner.png">
|
|
|
|
## What is this?
|
|
*GitHub Integration* is a addon for Godot Engine that I've created mainly for a personal purpose.
|
|
Pushing and Pulling repositories while I'm working on Godot (especially if I'm under a GameJam) could take some time and force me to save the project, open the brwoser/git bash/git gui, and do all the stuff.
|
|
With this little addon which works directly in the editor, managing all your repositories will be very easy.
|
|
|
|
## What can it do?
|
|
*Github Integration* offers the main functionalities provided by GitHub (and git itself), in a more accessible way.
|
|
Currenlty, you can:
|
|
- Manage all of your public and private **repositories**, *including* the ones you share with organizations and the ones in which you are a collaborator (with proper permissions): create, delete, push and clone repositories within your Godot project
|
|
- Manage all of your public and private **gists**: delete, edit and create gists with a functional text editor
|
|
- Manage collaboration invitations, inviting user to your repositories or accept/decline invitations you have received
|
|
|
|
## How does it work?
|
|
I'm currently working on a [Wiki](https://github.com/fenix-hub/godot-engine.github-integration/wiki) for this plugin. It is a process that will take some time to complete since I want to provide a well-organized wiki with some basic explanations about GitHub itself. Anyway, I'm working on a user-friendly plugin, so everything should be the very ease to use for GitHub experienced users, and a little intuitive for people who never used GitHub or are not so experienced.
|
|
If you want to see some screenshots you can find them here `addons/github-integration/screenshots`
|
|
|
|
## Supporters page
|
|
<table>
|
|
<tr>
|
|
<th><img src='https://avatars0.githubusercontent.com/u/9788627?s=64&v=4' alt='@masterworm2' width="64"/><br/><a href="https://github.com/masterworm2">masterworm2</a></th>
|
|
<th><img src='https://avatars0.githubusercontent.com/u/48778172?s=64&v=4' alt='@auctru' width="64"/><br/><a href="https://github.com/autcru">autcru</a></th>
|
|
</tr>
|
|
</table>
|
|
|
|
## :warning: Disclaimer
|
|
As a "work in progress" project, there is *no warranty* for any eventual issue and bug that may broke your project.
|
|
I don't assume any responsibility for possible corruptions of your project. It is always advisable to keep a copy of your project and check any changes you make in your Github repository.
|
|
|
|
-----------------
|
|
> This text file was created via [TextEditor Integration](https://github.com/fenix-hub/godot-engine.text-editor) inside Godot Engine's Editor.
|
|
|
|
|
|
|
|
|