Skip to content

Getting started

Jump to bottom
DarthPapalo666 edited this page Oct 31, 2024 · 3 revisions

Note

This page will teach you how to use the plugin and how to implement it in your development with Godot Engine.

Creating a new database 💾

When you first enable the plugin, you will see the start screen. Start by creating a new database:

Here you can see the interface of a loaded database:

  1. Top bar: Holds the button of database options (left), and the path of the current loaded database (right), if one is loaded. If there are unsaved changes the path will be in italics and prefixed with a "*".

  2. Collections list: Displays the list of the collections present in the database. You can create a new one by introducing a valid name in the text box above and by clicking the add button.

  3. Entries view: Displays entries inside the selected collection. It's the most important part of the editor and will be explained in more depth later.

  4. Filters: This panel contains different methods to filter which entries are displayed. It will be explained later with examples of how easy is to manage lots of resources with filters.

Now you can create a new collection:

Managing a collection 📄

The collections view is the most important part of the editor. It displays all the entries (resources) of the selected collection within the loaded database.

This is how the interface looks like:

  1. Collection name: The name of the displayed collection.

  2. Integer IDs: The Integer IDs of each entry are displayed here.

  3. String IDs: The String IDs of each entry are displayed here.

  4. Resource locators: The string used to locate each resource, it can either be its file path or a resource UID if its available.

  5. Entry options: Different options to manage each entry.

  6. Search and view page: Use the text box to search for specific String IDs. You can use the arrows below to travel through all the entries.

  7. Collection options button: You can access the collection settings and categories from here.

  8. Selection options button: Different options to select and do stuff with the selected entries.

  9. Filters button: Check it to activate the entry filters, they will be explained later in this guide.

Adding new resources

You can simply drag and drop resources or entire folders into the collection view.

Tip

You can go into Settings > Resource databases > Recursive folder search to enable adding all resources from a directory and its subfolders.

You have created a new database and added your resources inside. You can save your database using the button in the top bar.

Clone this wiki locally