[RELEASED] UniNotes: Making project organization and management easy

UniNotes


​

Website: RotaryHeart.com
Product Wiki: Online

Version 2.3.2
Available Now: Asset Store
Release Notes

Special Thanks
Matthias Guntrum - Gentlymad Studios
For being such an impressive help with the latest couple of updates and sharing an amazing ideas to make the product better.

What is it?
UniNotes is a system that makes project organization or management easy since it allows you to add visual notes to your project. The notes are fully customizable and can be attached to a GameObject, Scripts, Hierarchy, and Project.

The main idea of this system is to allows even non coders to add any kind of note anywhere on the project. This notes can easily be viewed by anyone that is working on the project, allowing for: bug tracking, warning, errors, or simple information of how a system works. The notes can be fully customized under a scriptable object, allowing to have as many notes as you want.

Features on the system:

-GameObject notes
Notes that can be added as a component are injected before the object transform, allowing them to be viewed faster.

​

-Scene notes preview
Component notes can be viewed on scene window if the selected object has any. This shows a list of all the notes available on the component (including the child components). Clicking on any element of the list will select the GameObject that has that note attached.

​

-Script notes
Notes that can be added to any script, without the need of a custom editor, by any coder. This notes allow for better explanation on your script editor.
-Script divider
These dividers can be added to any script to allow for an easier to understand separation between different script sections. The dividers can be added without the need of a custom editor (with attributes) or inside your custom editor and property drawers.

​

-Advanced notes
Notes that can be added either to the hierarchy or the project window. These notes are saved in your ProjectSettings folder on a .ini file.

​

Package dependencies: This project requires the use of 2 systems, IniParser and ProjectPrefs. While both are included on the project, they can be removed if they are included on your project already. Note that IniParser is included as a dll, but the source code can be found at my public GitLab section.

 

Just updated ProjectPrefs to be able to change the save location, this allows to use UniNotes on Collab since now the .ini file can be saved inside the project Assets.

Here are some gifs to show how easy is to add Advanced Notes

First the notes settings needs to be saved into the UniNotesSettings scriptable object.


Then the notes can be added to Project or Hierarchy window and they can be modified even if they are already added.


Here's a new feature I'm working on to make big notes easier to read. This includes rich text and selectable text that can be copied.

 

Great news version 1.0 has been accepted and it can be purchased at the Asset Store for $15.00 USD!! Asset Store Link

 

Version 1.1 has been submitted to the asset store for review. This version includes:

• Included new ProjectPrefs version
• New mouse hover collapsed note preview that allows for rich text to be used.

 

Version 1.1 is now live on the asset store!

 

New update is coming soon with multiple changes. Including better and easier way to modify and change notes. Now script notes will be able to be edited on the inspector. This allows to be able to add a note to any script that can hold any kind of note using the same note settings. I hope to have it clean up for next week and uploaded.

 

Version 1.2 has been submitted to the asset store for review. This version includes:

• Modified component and script note settings. Now they use the Notes Settings drawing method.
• Modified Note read hover window.
• Better script note drawing, now with context menu.
• Divider drawing implementation is fixed.
• Couple of more bug fixes

 

Version 1.2 is now live on the asset store!

 

Version 1.2.1 has been submitted to the asset store for review. This version includes:

• Included missing dependency package.
• New folder structure

 

Version 1.2.1 is now live on the asset store!

 

New update coming soon.

• Notes will now be modified from the read note window.
• Read note window will now have a minimum size.
• Expanded notes will now be read only.
• New about window added.
• Modified reorderable list color, this will make it easier to read on light theme editor.
• Couple of bug fix.

 

Version 1.2.2 has been submitted to the asset store for review. This version includes:

• Notes can only be edited from hover window.
• Hover window has a minimum size.
• Fixed bug where the hover window could move outside of the screen.
• Fixed settings draw color.
• Included new support window.

 

Version 1.2.2 is now live on the asset store!

 

Product wiki has been published. It can be found at my page Wiki section

 

Version 2.0 has been submitted to the asset store for review. This version includes:

• Fixed bug where new note component would throw a null exception the first time the context menu was opened.
• Modified the UI to be able to work correctly either at Pro or Personal editor skin.
• Included fix to disable warning logs about not used variables on the example script.
• Changed the default value of the scene notes to be set to true.
• (Beta) Huge change on UniNotesWindow. Now the system properly parses the scene file and can even show components notes on the window. Note that this is still on beta and could throw errors, so if any error is thrown contact me.

 

Version 2.0 is now live on the asset store!

 

Version 2.0.1 has been submitted to the asset store for review. This version includes:

• Fix an error that could appear when the system received an empty GUID from the Project window notes.

 

Version 2.0.1 is now live on the asset store!

 

Version 2.1 has been submitted to the asset store for review. This version includes:

• New layout for the HoverWindow that allows full note customization.
  • This new window replaces the context menu when an advanced note icon is clicked. So now all modifications to the notes are done on this window.
  • Links or files can now be added to a note. This can be used to provide any extra information for an external file (or web page).
• New note storage system that allows for easier implementation with source control.
  • Notes will now be saved in a similar way of how Unity stores .meta files. This allows for big teams to work with notes with less merging conflicts.
  • The notes will be saved in a separate folder (you can select the path from the Preferences window) and the data will be stored using YAML serialization.

Quick preview of how the new hover window. You can see the links on the bottom of the window.

​

 

Version 2..1 is now live on the asset store!

 

For anyone using Unity 2018.2+ there seems to be a bug with the note component drawer. It is overlapping the Transform drawer. I'm currently working on fixing this so a quick update fixing this will be provided soon.

 

Version 2.1.1 has been submitted to the asset store for review. This version includes:

• Modified folder structure to follow new guidance.
• Fixed bug where scene notes button will not hide scene notes. It was instead hiding children notes.
• Fixed initial size of scene button to be smaller.
• Fixed NoteInjector draw bug for Unity 2018.2+ where it was overlapping with the Object transform drawer.

 

Version 2.1.1 is now live on the asset store!

 

Version 2.1.2 has been submitted to the asset store for review. This version includes:

• Fixed tooltip showing on project icons.
• Included check for using wrong path for notes directory.

 

Version 2.1.2 is now live on the asset store!

 

Version 2.1.3 has been submitted to the asset store for review. This version includes:

• Fixed wrong position for horizontal line on divider

 

Version 2.1.3 is now live on the asset store!

 

Version 2.1.4 has been submitted to the asset store for review. This version includes:

• Included new option to change the Project note size.
• Restructured constants to hold new data.
• Included option on PreferencesWindow to reset default settings.
• Fixed issue with UniNotesWindow not showing the hierarchy notes and not deleting them correctly.
• Included logic to allow 3rd party detection.

 

Version 2.1.4 is now live on the asset store!

 

Version 2.2 has been submitted to the asset store for review. This version includes:

• Fixed issues with note positions being reset.
• Simplified drawing logic.
• Changed hover window layout to fit better.
• Included new attribute to include a note on any field.

 

Version 2.2.2 has been submitted to the asset store for review. This version includes:

• Fixes for new Unity versions
• Fixes for pro skin

 

Great news Version 2.2.2 is now live on the asset store!

 

Version 2.3.0 has been submitted to the asset store for review. This version includes:

• Fixed new project notes not showing until re compile
• Made advanced notes to show the note as tooltip when hover over

 

Great news Version 2.3.0 is now live on the asset store!

 

Version 2.3.1 has been submitted to the asset store for review. This version includes:

• Fixed editor error spam if an assembly recompile happens while viewing a note

 

Great news Version 2.3.1 is now live on the asset store!

 

On initial download of the package I got this error, seems the project preferences doesn't exist in the asset package



Edit: for anyone else who comes across this, look at the documentation haha. You need a few additional free plugins to make it work : )

 

Hello,

No it is not included, that is why it's shown in the Asset Store as a package dependency. But the asset is free so you can just download it and the error will be gone.

 

Hmmmm... alright, new problem.



I have everything installed but the injector doesn't seem to be working. Did I do something wrong?

 

That's definitely strange. What Unity version are you using?

 

We're using unity 2021.1.5f1, no errors show up in the console.

 

Version 2.3.2 has been submitted to the asset store for review. This version includes:

• Fixed issue with newer versions of Unity where the note injection wouldn't show

@KingShadowClock Open up the NoteInjector script (UniNotes/Editor/NoteInjector.cs) change line 11 from

[CustomEditor(typeof(GameObject), isFallback = true)]

to

[CustomEditor(typeof(GameObject))]

 

Super thanks for the fast response Rotary! I can't wait to check this out, it should prove very useful for our large project! : )

Edit: Just wanted to let ya know, it works great!

 

That's the main reason I published this asset, I've been using it for all my large projects.

I'm glad to know it works now. Any further question feel free to email me. I just happened to be lurking the forums when you wrote.

 

Great news Version 2.3.2 is now live on the asset store!

 

I know it's impossible to keep up with Unity changes but I purchased this and put it into Unity version 2021.2.15f1 and it gave me these errors. Don't know if it's something that is quick to fix or not so I figured I'd ask.

 

Hello,

Did you install the required package?
https://assetstore.unity.com/packages/tools/utilities/project-prefs-112798

 

Oh my apologies. I didn't notice that I had to install that.

Thanks for the very quick reply.

 

No worries, thanks for using the asset and asking for support.