Skip to content

Installation

Andrew Rumak edited this page Sep 26, 2024 · 10 revisions

Install and Update via UPM

Easiest way is to install MyBox as a package.

  1. Open UPM: "Window/Package Manager"
  2. Click "+" button at the top left
  3. Select "Add package from git URL" and paste following URL:
https://github.com/Deadcows/MyBox.git

To update MyBox use "Tools/MyBox/MyBox Window", "Update UPM version" button, or simply follow the steps above!

Install via OpenUPM

The package is available on the openupm registry. You may install it via openupm-cli.

openupm add com.domybest.mybox

Enable Intellisense

To see method descriptions you need to enable .csproj generation in Unity preferences:
In Unity Editor, open Edit > Preferences > External Tools and enable "Generate .csproj files for" Registry packages and Git packages, then click "Regenerate project files".

The next time you open your IDE, Intellisense will show you comments for MyBox's methods.



...or simply put MyBox folder downloaded from git somewhere under your Assets folder 🤨

MyBox settings

In MyBox Window you can find some settings, like Cleanup Empty Directories or Autosave on Playmode.
Most options are toggled off by default, to eliminate confusion and possible performance issues.
The window is located in Tools/MyBox/MyBoxWindow.

image

Compatibility with Odin Inspector and other libraries

MyBox will detect installed Odin Inspector and will disable "Inspector override" automatically. It is also will toggle off ReadOnlyAttribute and some other incompatible things.
For compatibility with other libraries that rely on UnityEngine.Object custom drawer, disable the "Inspector override" option.
It is required for [ButtonMethod] and [Foldout] attributes to work though.