# cp.config Manage CommandPost's constants and settings. --- ## Submodules * [cp.config.dockIconClickCallback](cp.config.dockIconClickCallback.md) * [cp.config.fileDroppedToDockIconCallback](cp.config.fileDroppedToDockIconCallback.md) * [cp.config.shutdownCallback](cp.config.shutdownCallback.md) * [cp.config.textDroppedToDockIconCallback](cp.config.textDroppedToDockIconCallback.md) --- ## API Overview **Constants** - _Useful values which cannot be changed_ * [appBuild](#appbuild) * [appName](#appname) * [appVersion](#appversion) * [assetsPath](#assetspath) * [basePath](#basepath) * [bundledPluginsPath](#bundledpluginspath) * [bundleID](#bundleid) * [cachePath](#cachepath) * [configPrefix](#configprefix) * [iconPath](#iconpath) * [languagePath](#languagepath) * [pluginPaths](#pluginpaths) * [privacyPolicyURL](#privacypolicyurl) * [processID](#processid) * [scriptPath](#scriptpath) * [sourceExtensions](#sourceextensions) * [sourceWatcher](#sourcewatcher) * [translationURL](#translationurl) * [userConfigRootPath](#userconfigrootpath) * [userPluginsPath](#userpluginspath) **Variables** - _Configurable values_ * [automaticScriptReloading](#automaticscriptreloading) * [watcher](#watcher) **Functions** - _API calls offered directly by the extension_ * [application](#application) * [get](#get) * [prop](#prop) * [reset](#reset) * [set](#set) * [unwatch](#unwatch) * [watch](#watch) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [developerMode](#developermode) * [frontmost](#frontmost) --- ## API Documentation #### Constants ### [appBuild](#appbuild) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.appBuild -> string` | | **Type** | Constant | | **Description** | Application Build | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 31](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L31) | --- ### [appName](#appname) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.appName -> string` | | **Type** | Constant | | **Description** | The name of the Application | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 21](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L21) | --- ### [appVersion](#appversion) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.appVersion -> string` | | **Type** | Constant | | **Description** | Application Version | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 26](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L26) | --- ### [assetsPath](#assetspath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.assetsPath -> string` | | **Type** | Constant | | **Description** | Path to where Application Assets are stored | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 84](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L84) | --- ### [basePath](#basepath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.basePath -> string` | | **Type** | Constant | | **Description** | Path to where the Extensions & Plugins folders are stored. | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 89](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L89) | --- ### [bundledPluginsPath](#bundledpluginspath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.bundledPluginsPath -> string` | | **Type** | Constant | | **Description** | The path to bundled plugins | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 94](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L94) | --- ### [bundleID](#bundleid) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.bundleID -> string` | | **Type** | Constant | | **Description** | Application's Bundle ID | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 36](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L36) | --- ### [cachePath](#cachepath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.cachePath -> string` | | **Type** | Constant | | **Description** | The path to the CommandPost Cache folder. | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 104](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L104) | --- ### [configPrefix](#configprefix) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.configPrefix -> string` | | **Type** | Constant | | **Description** | Prefix used for Configuration Settings | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 46](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L46) | --- ### [iconPath](#iconpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.iconPath -> string` | | **Type** | Constant | | **Description** | Path to the Application Icon | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 122](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L122) | --- ### [languagePath](#languagepath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.languagePath -> string` | | **Type** | Constant | | **Description** | Path to the Languages Folder | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 127](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L127) | --- ### [pluginPaths](#pluginpaths) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.pluginPaths -> table` | | **Type** | Constant | | **Description** | Table of Plugins Paths. Earlier entries take precedence. | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 114](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L114) | --- ### [privacyPolicyURL](#privacypolicyurl) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.privacyPolicyURL -> string` | | **Type** | Constant | | **Description** | URL for Privacy Policy | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 51](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L51) | --- ### [processID](#processid) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.processID -> number` | | **Type** | Constant | | **Description** | Application's Process ID | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 41](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L41) | --- ### [scriptPath](#scriptpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.scriptPath -> string` | | **Type** | Constant | | **Description** | Path to where Application Scripts are stored | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 61](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L61) | --- ### [sourceExtensions](#sourceextensions) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.sourceExtensions -> table` | | **Type** | Constant | | **Description** | Extensions for files which will trigger a reload when modified. | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 132](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L132) | --- ### [sourceWatcher](#sourcewatcher) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.sourceWatcher -> SourceWatcher` | | **Type** | Constant | | **Description** | A `cp.sourcewatcher` that will watch for source files and reload CommandPost if any change. | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 137](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L137) | --- ### [translationURL](#translationurl) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.translationURL -> string` | | **Type** | Constant | | **Description** | URL for Translations | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 56](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L56) | --- ### [userConfigRootPath](#userconfigrootpath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.userConfigRootPath -> string` | | **Type** | Constant | | **Description** | The path to user configuration folders | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 99](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L99) | --- ### [userPluginsPath](#userpluginspath) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.userPluginsPath -> string` | | **Type** | Constant | | **Description** | The path to user plugins | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 109](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L109) | --- #### Variables ### [automaticScriptReloading](#automaticscriptreloading) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.automaticScriptReloading ` | | **Type** | Variable | | **Description** | Automatic Script Reloading. | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 310](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L310) | --- ### [watcher](#watcher) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.watcher() -> watcher` | | **Type** | Variable | | **Description** | Config Watcher | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 270](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L270) | --- #### Functions ### [application](#application) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.application() -> hs.application object` | | **Type** | Function | | **Description** | Returns the Application as a hs.application object | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/config/init.lua line 146](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L146) | --- ### [get](#get) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.get(key[, defaultValue]) -> string or boolean or number or nil or table or binary data` | | **Type** | Function | | **Description** | Loads a setting | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/config/init.lua line 172](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L172) | --- ### [prop](#prop) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.prop(key[, defaultValue]) -> cp.prop` | | **Type** | Function | | **Description** | Returns a `cp.prop` instance connected to the value of the specified key. When the value is modified, it will be notified. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/config/init.lua line 223](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L223) | --- ### [reset](#reset) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.reset()` | | **Type** | Function | | **Description** | Resets all the settings for the Application | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/config/init.lua line 252](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L252) | --- ### [set](#set) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.set(key, value)` | | **Type** | Function | | **Description** | Saves a setting with common datatypes | | **Parameters** | | | **Returns** | | | **Notes** | | | **Examples** | None | | **Source** | [src/extensions/cp/config/init.lua line 190](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L190) | --- ### [unwatch](#unwatch) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.unwatch(id)` | | **Type** | Function | | **Description** | Unregisters the watcher with the specified ID. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/config/init.lua line 292](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L292) | --- ### [watch](#watch) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.watch(events) -> id` | | **Type** | Function | | **Description** | Watches for config events. | | **Parameters** | | | **Returns** | | | **Notes** | | | **Examples** | None | | **Source** | [src/extensions/cp/config/init.lua line 275](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L275) | --- #### Fields ### [developerMode](#developermode) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.developerMode ` | | **Type** | Field | | **Description** | When `true`, the app is in developer mode. | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 305](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L305) | --- ### [frontmost](#frontmost) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.config.frontmost ` | | **Type** | Field | | **Description** | Returns whether or not the Application is frontmost. | | **Notes** | None | | **Source** | [src/extensions/cp/config/init.lua line 162](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/config/init.lua#L162) | --- ---