HelpSource/Guides/UsingExtensions.schelp

   1 title:: Using Extensions
   2 summary:: Using Extensions
   3 categories:: Internals
   4 related:: Guides/WritingUGens, Guides/Quarks, Guides/WritingClasses
   5
   6 SC supports extensions to its class library, documentation, and server UGen plugins. Extensions should be packaged as a
   7 single folder containing all three (for convenient addition or removal), or any combination, which can then be placed in
   8 platform-specific extension directories in order to be included.
   9
  10
  11
  12 section:: Platform Specific Directories
  13
  14 You can install extensions simply by copying the extensions to the following location. There are different directories
  15 for per-user and system-wide extensions that apply to all users.. The locations can be obtained by running
  16 code::Platform.userExtensionDir:: and code::Platform.systemExtensionDir::.
  17
  18 Typical user-specific extensions directories:
  19 table::
  20 ## OSX     || ~/Library/Application Support/SuperCollider/Extensions/
  21 ## Linux   || ~/.local/share/SuperCollider/Extensions/
  22 ::
  23
  24 Typical system-wide extension directories:
  25 table::
  26 ## OSX     || /Library/Application Support/SuperCollider/Extensions/
  27 ## Linux   || /usr/share/SuperCollider/Extensions/
  28 ::
  29
  30 section:: How Extensions Folders Should be Organised
  31
  32 warning::The following section describes the old OSX-based extension directory layout. This is subject to change.::
  33
  34 Class files and UGen plugins are recognised by their file extensions. Anything placed within a folder named help/ or
  35 ignore/ (case insensitive) will be ignored when compiling the class library or loading plugins, but anything in the
  36 former will be added to the search path for help files.
  37
  38 Here is an example folder layout:
  39
  40 tree::
  41 ## teletype::MyExtension::
  42     tree::
  43     ## teletype::classes::
  44     tree::
  45         ## teletype::myClass.sc myUGens.sc::
  46         ::
  47     ## teletype::plugins::
  48     tree::
  49         ## teletype::myUGenPlugins.scx::
  50         ::
  51     ## teletype::help::
  52     tree::
  53         ## teletype::myClass.html myUGen1.html myUGen2.html::
  54         ::
  55 ::