Calinou / godot-addon-template

Repository template with a standard structure for Godot add-ons and editor plugins. Usage: Create a new repository based on this template and replace uppercase strings (LIKE_THIS) accordingly.

ADDON_NAME

ADDON_DESCRIPTION

This repository only contains the add-on. See USER/REPOSITORY-demo for the demonstration project.

Features

• ADDON_FEATURE_1
• ADDON_FEATURE_2
• ...

Installation

Using the Asset Library

• Open the Godot editor.
• Navigate to the AssetLib tab at the top of the editor and search for "ADDON_NAME".
• Install the ADDON_NAME plugin. Keep all files checked during installation.
• In the editor, open Project > Project Settings, go to Plugins and enable the ADDON_NAME plugin.

Manual installation

Manual installation lets you use pre-release versions of this add-on by following its master branch.

• Clone this Git repository:

git clone https://github.com/USER/REPOSITORY.git

Alternatively, you can download a ZIP archive if you do not have Git installed.

• Move the addons/ folder to your project folder.
• In the editor, open Project > Project Settings, go to Plugins and enable the ADDON_NAME plugin.

Usage

USAGE

License

Copyright © 2020 FULL NAME and contributors

Unless otherwise specified, files in this repository are licensed under the MIT license. See LICENSE.md for more information.