Godot Style

A small Godot addon that provides unofficial style guide in the editor

Table of Contents

1. About The Project
2. Installation
3. Materials
4. Contribute
5. License

About The Project

Built With

Version: Godot 4.1

• A personal project to learn the powerful Godot Engine
• Aiming at:
  • Beginners who want to follow a prevalent style guide to develop good practices
  • Beginners who want to learn more about Godot's Resource

More details

1. It makes use of custom Resources, which helps to quickly create new SectionResources and ItemResources.

2. It's very scuffed lol.

   • Items can only contain pictures (Texture2D) as a quick and easy alternative - because I haven't a clue how to implement markdown in Godot. As a result,

     • Updating contents frequently can be cumbersome.
     • Limited capabilities
     • Resizing the editor will not scale the pictures to maintain visibility -> Have to use scroll bars

   • Scuffed Markdown implementation (Converting to BBCode for RichTextLabel and custom Controls - using RegEx)

     • Most basic and widely used syntax
     • Lists (ordered and unordered) - prove difficult because lists in Markdown and BBCode are quite different
     • HTML tags - none yet

   • Lacking UI elements helping to add new contents - partly because I want users to interact with the provided custom resources

3. The style guide provided (STYLE_GUIDE.md) is a simplified composition of parts of different materials.

4. There are two script templates located in script_templates. To integrate them into your project or editor, please refer to Creating script templates.

Customization

• You can add your own SectionResources and ItemResources - please refer to ADDING_YOUR_OWN.md

(back to top)

Installation

Using Godot Asset Library

• In-editor AssetLib

  1. Search for Godot Style in Godot's in-editor AssetLib and press download

  2. Enable the addon in Project -> Project Settings -> Plugins

     

• Online

  1. Dowload the ZIP archive from link.

  2. Import the folder godot_style/ into your Godot project's addons/ folder (Godot v4.1).

  3. Enable the addon in Project -> Project Settings -> Plugins

Manually

1. Clone the repo OR download and extract the ZIP archive.

   git clone https://github.com/VinhPhmCng/GodotStylePlugin.git

2. Import the folder godot_style/ into your Godot project's addons/ folder (Godot v4.1).

3. Enable the addon in Project -> Project Settings -> Plugins

(back to top)

Materials

1. GDScript style guide
2. GDScript reference
3. GDQuest' guidelines
4. Calinou's style guide
5. emarino135's Reddit thread
6. sepTN's post

(back to top)

Contribute

• Any contribution is much appreciated, especially regarding Markdown integration into Godot.

• I highly recommend beginners who is learning programming in general, or Godot specifically, to make contributions if you'd like to.

  • For example, you can add more style guide items that you think would help other beginners.
  • Open PR to improve the addon.

(back to top)

License

MIT License © VPC

(back to top)