Katalogue

Imagine you are starting on a new Unity project, you don't know anything about that project and you just need to create a simple settings menu. First you need to know if there is a yellow button prefab to open the settings menu or if you need to create a new one.

You will, of course, check the prefabs folder to see if there are any "MenuSettingsButton" or something like this. Then, on failure, you'll try to check if one of the 30 different buttons is yellow.

And then, if all else fails (including asking for help :worried:), you can see if there is something in this project to help you to create a your new yellow button.

Wouldn't it be awesome if there was a tool to help you create some catalogs with all types of prefabs in your project and help you know which prefabs already exist, with image, description and an easy way to instantiate that prefab?

Then meet the Katalogue :heart_eyes:

<br> <br> <h4 align="center" style="text-align:center;"> <a href="https://github.com/thisaislan/katalogue"> <img src="Assets/Editor/Resources/katalogue_mini_logo.png"> </a> <br> <br> <p align="center"> <a href="https://unity3d.com/get-unity/download"> <img src="https://img.shields.io/badge/unity-tools-blue" alt="Unity Download Link"></a> <a href="https://github.com/thisaislan/persistence-easy-to-delete/blob/main/LICENSE.md"> <img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" alt="License MIT"></a> </p>

Table of Contents

• How it works
• Installation
• Support
• Thanks
• License

How it works

After installing, go to the new folder called Katalogue and you can create your first Katalogue file there, right click Create/Katalogue/New Katalogue

<br>

Put a nice name and add every prefab you want

<br>

And done! :grin: You just created your first Katalogue!

Now let's instantiate some new game objects in the scene using your newly created Katalogue. To do that open the main Katalogue window in Tools/Katalogue/Open Katalogue window

<br>

In that window you can see all Katalogues files inside of the Katalogue folder :smiley:.

In addition, you can create menu items to help you instantiate new game objects by right-clicking the hierarchy window. To do this just go to Tools/Katalogue/Generate menus items, after that a new menu item will be created for each Katalogue file inside the Katalogue folder

<br>

By clicking on this menu, a smaller version of the Katalogue window will open and allow you to create a game object from this Katalogue file

<br>

Okay, let's say now you just want to create a catalog from an entire folder, easy! :smirk:. Just to create a Katalogue Folder by right clicking Create/Katalogue/New Katalogue Folder,select the desired folder and that's it!

<br>

Tip: You can see tips about the tool in the Katalogue files by clicking in the first label :wink:

<br>

Installation

Katalogue can be installed directly through the git url

https://github.com/thisaislan/katalogue.git

If you need more information about installing package from a Git URL, you can click here. :slightly_smiling_face:

Support

Please submit any queries, bugs or issues, to the Issues page on this repository. All feedback is appreciated as it not just helps myself find problems I didn't otherwise see, but also helps improve the project.

Thanks

My friends and family, and you for having come here!

License

Copyright (c) 2021-present Aislan Tavares (@thisaislan) and Contributors. Ped is free and open-source software licensed under the MIT License.

<!-- ko-fi donation button --> <br> <br> <br> <br> <h4 align="center" style="text-align:center;"> <a href="https://ko-fi.com/thisaislan"> <img src="https://github.com/thisaislan/just-images/raw/main/images/ko-fi/ko-fi_donation_banner.gif" style="width: 460px"> </a> </h4> <br> <br> <br> <br>