Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to launch local Unity API Reference from MonoDevelop

In MonoDevelop, Ctrl+' (not F1) brings the Unity API Reference (help) from http://unity3d.com/support/documentation/... instead of reading it from local copy of the Unity API. How can I make it consistently open the local documentation?

like image 658
DarkerLuna Avatar asked Oct 21 '22 02:10

DarkerLuna


1 Answers

If you use Firefox, you can use Redirector to redirect to your local documentation. Install the addon, and open the options. (Ctrl+Shift+A > Extensions > Redirector > Options)

Then use these values (or similar, depending on the location of your local documentation):

  • Description: Unity Documentation (or whatever you'd like)
  • Example URL: http://unity3d.com/support/documentation/ScriptReference/30_search.html?q=Transform (Or any other search query. Used to preview what the link will redirect to. This is optional.)
  • Include Pattern: http://unity3d.com/support/documentation/ScriptReference/* Note that I use unity3d.com/support/documentation/ScriptReference/..., because that is the URL opened by MonoDevelop, which is then redirected to docs.unity3d.com/ScriptReference/...
  • Redirect To: file:///C:/Program Files (x86)/Unity/Editor/Data/Documentation/html/en/ScriptReference/$1 If Unity is not installed on the C drive or if you use a different OS, you're gonna have to find out what the local URL looks like, and replace everything to the right of /ScriptReference/ with $1. (/ScriptReference/index.html to /ScriptReference/$1)
  • Pattern Type: Wildcard
  • You can leave all other fields as they are.

Now anytime you press the shortcut, you will automatically be redirected to your local API reference instead of the online one. I've also tested it without internet connection. Unfortunately, the addon is only available for Mozilla Firefox, and I haven't succeeded in doing that with other tools for different browsers yet.

Edit: Redirector is now also available for Chrome and Opera, according to the author's website.

like image 105
Luka Kotar Avatar answered Oct 24 '22 00:10

Luka Kotar