Giter VIP home page Giter VIP logo

unityprojectnotes's Introduction

UnityProjectNotes

δΈ­ζ–‡

A small utility within the Unity Editor to display notes, which can be used to share information across the team.

Have you ever been frustrated by your teammates frequently asking you the same questions? Try this.

Toolbar Entry

Main Window

Note Editing Window

Features

  • Displays notes in a standalone EditorWindow
  • Note entries support rich text, version history, and categories
  • Supports adding, editing, and deleting note entries
  • Supports searching note entries by title, content, and author
  • Can share notes with the team by uploading the local settings file to a version control system
  • Prominently displays a notification in the Editor toolbar when new entries are added to the note settings Toolbar Entry

Supported Unity Versions

Unity 2021.3 or higher.

Certain features are not available in versions of Unity prior to 2022, for example:

  • Unable to select the contents of a note
  • Certain rich text tags (such as hyperlinks <a>) are not supported

Installation

openupm

Install this package via OpenUPM, or clone this repository directly into the Packages folder of your project.

How to Use

Click the entry button in the Editor toolbar, or the menu item "Tools/Bamboo/Project Notes" to open the Project Notes window.

Click the "+" button in the top right corner of the Project Notes window to add a new note entry.

Use the search bar at the top of the Project Notes window to search for note entries.

Use the buttons and dropdown buttons in the bottom right corner of the Project Notes window to mark, edit, or delete note entries.

Known Issues

Changing the Unity Editor layout causes the entry button in the Editor toolbar to disappear.

Solutions (any one of the following):

  • In the context menu of the Project Notes window, select the "Create Toolbar Entry Button" option to recreate the entry button.
  • Modify any code to trigger a domain reload in Unity.
  • Restart the Unity Editor.

unityprojectnotes's People

Contributors

solarianz avatar

Stargazers

Analog Limb avatar GameLife avatar  avatar miao avatar Doruk avatar  avatar  avatar  avatar yingnierxiao avatar

Watchers

 avatar

unityprojectnotes's Issues

The toolbar entry button will disappear after changing the layout of Unity Editor

The toolbar entry button will disappear after changing the layout of Unity Editor.

When debugging at a breakpoint, the ProjectNotesEntryButton shows that its parent is ToolbarZonePlayMode, and ToolbarZonePlayMode also shows that its children contain ProjectNotesEntryButton, but the ProjectNotesEntryButton is not visible in the UI Toolkit Debugger, and it cannot be queried using the UQueryExtensions.Q method to find the ProjectNotesEntryButton.

image

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.