/Easy-Interface

Primary LanguageGDScriptMIT LicenseMIT

icon

Easy-Interface

Interface validation plugin for GDScript with graphical editor on Godot 4.

Motivation

Have a simple and quick way to implement interfaces in GDScript.

ko-fi

Installation

Asset Library

  1. In Godot, open the AssetLib tab.
  2. Search for and select "Easy Interface".
  3. Download then install the plugin (be sure to only select the easy_interfaces directory).
  4. Enable the plugin inside Project/Project Setttings/Plugins.

Github Main (Latest)

  1. Download the latest main branch.
  2. Extract the zip file and move the addons/easy_interface directory into project's root location.
  3. Enable the plugin inside Project/Project Setttings/Plugins.

For more help, see Godot's official documentation

How to use

Step by step:

  • step 1: After installing and enabling the plugin, go to the "Easy Interface" tab.

  • step 2: Create and edit a new interface using the "new interface" button, by default there are two example interfaces.

    Don't forget to save, the plugin still doesn't save automatically

  • step 3: Go to the script that you want to implement the interface and add a constant named INTERFACES (check the demo script).

  • step 4: Go back to the "Easy Interface" tab and click on the "Validate" button. This step is temporary, validation and automatic saving are still under development.

Try commenting the properties, functions and signals in the demo script and performing validations to see the result

Toolbar

Actions:

  • Create new interface Creates a new card to represent an interface.

    new interface

  • Validate Checks the project scripts and validates according to the configured interfaces.

    validate

  • Save Saves the created interfaces.

  • Change canvas size It is possible to increase the size of the canvas where the interfaces are created.

What to expect from the future?

I intend to update the plugin as I use it, any suggestions and changes that make sense would be welcome in the project.

Currently I described some ideas I have for the next updates, you can check them in the issues tab or project tab.