Using the tool

How to open the tool and manage Scene Notes

Configuration

To get started with Codecks Scene Notes, you can use the Setup Wizard included. Go to Tools > Codecks Scene Notes > Setup Wizard.

Fill in all the fields, login, and confirm. All of the information is saved into Project Settings. You can always use the Wizard again to override the values, or edit them manually from within Project Settings.

Bringing up the interface

Codecks Scene Notes is operated through a Scene Overlay. To open it, either hover on the Scene View and press the ` key (the one next to Shift, on a British keyboard), or click on the three vertical dots menu at the top-right corner of the Scene View, and select Overlays Menu:

Once the Overlays Menu opens, click on Codecks Scene Notes to visualise the overlay:

Once the overlay is enabled, you should see it appear somewhere in your Scene View:

The overlay appears in its closed state. Click on it to enable it, and load Scene Notes.

Pulling card data, hiding notes

The first time the tool is enabled, it pulls card data from the server.

Once it’s done, you can always force a refresh of the data by clicking the Reload button.

Reloading data will discard any unsaved changes you might have, so make sure to save any edited Note before you Reload!

Creating a new note from Unity

To create a new Note, focus on the spot in the scene where you want to create it, and click the Plus button. The newly created card will be immediately sent to the Codecks server, and you can keep editing its properties in the Inspector.

The new Scene Note will go in the default Deck specified during setup, and will be associated with the scene that is the currently Active scene. You can always change these later.

Editing a note

You can edit the data of a Scene Note by just clicking on its icon, and editing the data in the Inspector.

However, when you are done, you need to press the Save button at the bottom to save the changes on the Codecks server.

Any unsaved change will be lost next time Codecks Scene Notes loads data.

Deleting a note

Like in Codecks, we don’t allow full deletion of a Scene Note. To remove a Note, you can archive it. Just click on the Archive button in the note’s Inspector, and it will immediately be archived on the Codecks website as well (no need to save).

You can bring it back, by unarchiving it on the Codecks site (this requires reloading data in Scene Notes).

Turning an existing card into a Scene Note

To turn an existing card in a Codecks project into a Scene Note, you can click the Copy Metadata button (the one with the curly braces { }) in the overlay. This will copy some text that you can paste at the end of the card’s contents, in Codecks.

You will not see the newly created Note immediately. You need to reload data to see the Scene Note appear in Unity.

Filtering notes by category (deck)

You can hide/show Scene Notes by the deck they are in in Codecks. To do so, Click on the Filter button, and select the categories you want to see and hide.

Showing/hiding categories doesn’t destroy the Notes or reload data, so you can have unsaved data, it will not be lost.

Loading notes of a specific Unity scene

Once a scene is associated with a card, that card will be automatically loaded in Unity when the scene is open. Opening and closing scenes will automatically show/hide Scene Notes.

Loading/unloading scenes doesn’t destroy the Notes or reload data, so you can have unsaved data, it will not be lost.

Last updated