godot-git-describe

KO | EN

gitlite — search

#python #java #ruby #javascript #php #hacktoberfest #android #framework #docker #gulp #html #dotfiles

godot-git-describe

★ 28 Open GitHub ↗

Seamlessly display in-game versions based on your Git tags.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Godot Git Describe</h1>

 <img src="./git_describe_demo/icon.svg", width=30%>

## What is Git describe?

Git's [describe](https://git-scm.com/docs/git-describe) command is a convenient way to get a human-readable label for your repository's state.

### Examples

```
# If the latest commit is tagged, then you simply get that tag. Perfect for version numbers.
$ git describe
1.0.0

# Made a commit since the last tag? Output includes the number of commits since that tag plus the latest commit hash.
$ git describe
1.0.0-1-abcd123

# No tags? You can fall back to an abbreviated commit hash instead.
$ git describe --always
abcd123

# Have uncommitted changes? That can be accounted for.
$ git describe --dirty
1.0.0-dirty

$ git describe --dirty=-your-text-here
1.0.0-your-text-here
```

### Why use Git describe instead of a commit hash?

1. It's more readable when [tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) are involved.
2. It's more informative (e.g., you can easily show when there are uncommitted changes).
3. It still includes the abbreviated hash when relevant.

## Features

- Adds your Git repository's description to your project on run or export.
- Reverts changes when you stop your project or an export is finished.
- Batteries included: comes with nodes and settings that cover common use cases.

## Limitations

GGD relies on Godot's export process. Workflows without that export process may instead benefit from [Git export substitution](https://git-scm.com/docs/gitattributes#_export_subst). See [.gitattributes](./.gitattributes) and [plugin.cfg](./addons/git_describe/plugin.cfg) for an example of this in action.

## Installation

1. Use Godot to download GGD from the [Asset Store](https://store.godotengine.org/asset/zibetnu/godot-git-describe) (recommended) or get the [latest release](https://github.com/zibetnu/godot-git-describe/releases/latest).
2. Enable GGD in the project settings.

See the Godot docs for [detailed instructions](https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing_plugins.html) if needed.

## Usage

1. Add a [tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) to your Git repo (optional but recommended).
2. Add included nodes and adjust project settings as desired.
3. Run or export the project.

### Nodes

### Settings

GGD's project settings are found under the setting path `addons/git_describe`.

[1]: Advanced setting; only shown when the "Advanced Settings" option is enabled.

### Extensions

Extensions add new features for GGD to use when you run or export your project. GGD uses extensions internally, which are a helpful reference when making your own.

To create and enable an extension:

1. Create a script that extends `GitDescribeExtension`.
2. Override `_init` with any setup your extension needs.
3. Override `_set_describe` to make changes with the describe string.
4. Override `_erase_describe` to undo the changes made by `_set_describe`.
5. Set the "User Extensions Dir" project setting to the directory that contains your extension.
6. Reload the project.

## Contributing

Contributions are welcome. Please try to follow these guidelines:

- [GDScript style guide](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html)
- [Git style guide](https://github.com/agis/git-style-guide)

godot-git-describe

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README