https://github.com/slashscreen/gdsync
Rudimentary addons updater for godot.
https://github.com/slashscreen/gdsync
Last synced: about 2 months ago
JSON representation
Rudimentary addons updater for godot.
- Host: GitHub
- URL: https://github.com/slashscreen/gdsync
- Owner: SlashScreen
- Created: 2023-04-20T03:33:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-23T19:59:52.000Z (about 2 years ago)
- Last Synced: 2025-02-09T19:36:19.235Z (3 months ago)
- Language: Ruby
- Size: 10.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NOTE: This extension is deprecated. Use [gdsync](https://github.com/imjp94/gd-plug) instead.
GDsync is an extremely rudimentary tool for Godot that will automatically sync your addons with a remote repository, so long as they are described in a `addons.yaml` file.
This tool may be better off redone as a GDExtension tool, rather than a ruby file.
## How to use
The current way to use this is:
1. Install Ruby.
2. Drag in `sync.rb` into your `res://` folder.
3. Create an `addons.yaml` file in the same directory as `sync.rb` - format described below.
4. In the console in your `res://` folder, run `ruby sync.ruby` and give it a second.
If any of the addon repos have an `addons.yaml` file in their root as well, it will also execute that.
## addons.yaml
The format for `addons.yaml` is as follows:
```yaml
Addon Name: # Repo name as it would appear if you were to clone it.
repo: [email protected] # Git URI.
src_folder: addons/addon_name # The folder in the repo where the addon is- usually in the addons folder.
dest_folder: addons # Your addons folder- usually addons.
```
see `addons.yaml` for an example.