On the Asset Store

Creating and editing notes

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.

Click the Plus button to create a new note

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 upload the changes to the Codecks server.

A Scene Note being edited, displaying the Save button at the bottom

Any unsaved change will be lost next time Codecks Scene Notes loads data, so make sure you save as soon as you're done editing.

Note properties

Note state

All notes have a state, which by default is "Not started". The state is reflected in the coloured bar at the top of the note's Inspector. You can change a note's state by just clicking the buttons under the bar.

An unstarted note
A completed note

The possible states are:

  • Not started: grey bar

  • Started: blue bar

  • Done: green bar

The meaning that you give to each status is up to you and your team.

If a note is a Doc note in Codecks, the bar will be yellow and some properties will not be available.

Title

The title of the note.

Contents

The main text of a note.

Deck

The deck that contains the note in Codecks. Can be used for filtering.

Scene

You can freely reassign a different scene to the Scene field.

Keep in mind that reassigning a scene might make the note disappear from the Scene View if the specific scene is not currently loaded.

Linked GameObject

If a note is not linked to any object, it's just placed with a World position in the scene, and you can edit it here.

The Scene information section of a note

If a GameObject is dragged into the Linked to field, the note becomes linked to that GameObject. When that object moves or rotates, the note moves with it. As such, while the note still has a world position, this will not be editable: what matters is the Local offset, which can be tweaked at the bottom of this section:

This note is linked to a GameObject

Deleting the GameObject linked doesn't delete the note, it just unlinks it.

Priority

The priority of the card in Codecks.

Effort

The priority of the card in Codecks.

Owner

The owner of the card in Codecks. This can be used for filtering too.

You can also enforce more safety by disallowing users from editing notes that are not assigned to them. See the setting Lock Notes You Don't Own in Project Settings.

Deleting a note

Like in Codecks, we don’t allow full deletion of a Scene Note. To remove a Note, you need to archive it.

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).

Click on the Archive button to archive the note

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

If you just delete the GameObject that displays a note (by hitting Ctrl + Delete, for instance), the corresponding note is not deleted on the Codecks server. You need to archive it.

Last updated