Skip to content

Godot Engine addon that creates a list of all third-party components used by Godot and your game

License

Notifications You must be signed in to change notification settings

ProgrammerOnCoffee/Quick-Licenses

Repository files navigation

Quick Licenses Icon

Quick Licenses

Quick Licenses is a plugin for Godot Engine v4.0+ that creates a list of all third-party components used by Godot and allows you to add any assets used by your game.

Features

  • Automatically creates a list of Godot's third-party components
  • Easily include your game's components by adding them to a JSON file
  • Displays copyright info and licenses when clicking on components
  • Optionally add links to assets' sources and automatically open them in a web browser when clicked
  • Allows users to click each individual component for more information instead of displaying a wall of text

Screenshots

Quick Licenses Components List Quick Licenses Component View Quick Licenses License View

Installation

  1. Clone or download the repository.
  2. Open the project in Godot and run the res://demo.tscn scene to test it.
  3. Copy the addons/quick_licenses folder into your project.

Usage

  1. Instantiate the res://addons/quick_licenses/quick_licenses.tscn scene.
  2. Show the QuickLicenses node whenver you need to and hide it when the QuickLicenses.close_requested signal is emitted.
  3. Add any components your game uses to the JSON file located at res://addons/quick_licenses/components.json, following the format of the existing components. (This format is the same used by the Engine.get_copyright_info() method.)

Optional steps:

  • Edit the QuickLicenses node's theme to customize font sizes and margins (see the demo scene for an example).
  • Extend the QuickLicenses class or edit the source code to customize behavior such as transitions.
  • If you need to add a license that isn't already in the dictionary returned by Engine.get_copyright_info(), add it to the JSON file located at res://addons/quick_licenses/licenes.json.

Disclaimer

Quick Licenses is not a one-size-fits-all solution and may not satsify the requirements of every license. Ensure that you understand the terms any licensed works are distributed under before using them in your project. If in doubt, talk to a lawyer.

License

This plugin is licensed under the MIT/Expat license.

About

Godot Engine addon that creates a list of all third-party components used by Godot and your game

Topics

Resources

License

Stars

Watchers

Forks