Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.12 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.12 KB

TOAST UI Editor

license

🚩 Table of Contents

💡 Purpose

Welcome to Unity-Whiteboard! This whiteboard networking tool was originally developed for where security was a critical priority. However, this public version prioritizes ease of use and quick implementation rather than strict security measures. The ultimate goal is to foster collaborative note-taking in addition to supporting real-time drawing collaboration.

Work in Progress: This project is currently in a heavy active development phase, and features may change frequently. As a result, support may be limited, and users should expect updates that could impact functionality.

Watch Demo Video

🎨 Features

Currently the whiteboard contains these features (all with network support):

  • Markers, Erasers
    • Change Colors
    • Change Size
  • Multi-page support
  • Saving and Loading Pages
  • Pasting Images

📦 Samples

Here I will update on how to bring in the samples the package provides and a quick getting started!

🤖 Installation

Its recommended you use Unity version 2021.3.19f1 or greater.
I am actively developing using Unity 6000

Coming soon!

🌏 Support

I welcome contributions! If you find bugs, have feature requests, or want to submit improvements:

  • Fork the repository.

  • Create a feature branch.

  • Submit a pull request.

📝 TODO

In no certain order:

  • Re-implement SteamVR support
  • Write installation, samples, usage documentation for this readme
  • Go through and consolidate functions to ~100 lines or less
  • Rework marker worldspace UI to be more obvious
  • Create unit-test for all major functionality
  • Re-implement samples

📜 License

This software is licensed under MIT
Feel free to use, modify, and share as long as you include attribution.