Frequently Asked Questions

Table of contents

I’m getting an error message when trying to use G.U.I.D.E in my project

In general if this happens it is caused by one of the following reasons:

  • The plugin is not enabled in the project settings or the editor has not been restarted after enabling the plugin. Please make sure to follow the installation instructions carefully.
  • You are running G.U.I.D.E code in an autoload. If your autoload executes code that uses G.U.I.D.E before the GUIDE autoload is initialized, you will get an error. Make sure to check the autoload order in the project settings and make sure that the GUIDE autoload is loaded before any autoload that uses G.U.I.D.E.
  • You are using some plugins that might interfere with G.U.I.D.E. If you get strange errors, try disabling other plugins to see if they are causing the issue. If you find a plugin that causes issues, please report it so I can investigate.

If none of these steps help, please report the issue in the issue tracker and I will try to help you. Be sure to include as much information as possible about your setup and the error message you are getting.

The plugin doesn’t work with the latest Godot preview version

This can happen because in general the aim of the plugin is to work with the latest stable version of Godot. Preview versions of Godot usually are not that stable and trying to make the plugin work with them can be a moving target. If you find an issue with a preview version of Godot, please report it, so I can investigate, but a fix might not materialize until the stable version is released.

Where can I ask questions about how to use G.U.I.D.E?

You can ask questions in the GitHub issue tracker. Questions about how to use the plugin are marked with the Knowledge label, which allows you to easily find every question that has been asked before.

Why don’t you have a Discord server for support?

I’m a solo developer and I don’t have the bandwidth to monitor a Discord server and to answer questions in real-time. Also, I find having a Discord running all day to be very distracting which negatively affects my productivity. The GitHub issue tracker is currently the best way for me to keep track of questions and issues and to answer them in a timely manner.