The config.json file

This page has moved to https://help.animbot.ca/support/solutions/articles/61000292051-the-config-json-file

 

The config.json file is what triggers the Enterprise Edition. You will receive a unique config.json file during the installation process and should keep it confidential as much as possible. By default the file should exist in the same animBot parent directory. The folder structure in your network could look something like this:

/net/maya/animBot/1.0.0/animBot
/net/maya/animBot/1.0.0/config.json

Alternatively, you can set the environment variable ANIMBOT_CONFIGJSONPATH and add the config.json file to a custom location. This is useful when you have multiple animBot versions that point to a single config.json file (v1.1.4 onwards). For example, adding this line to Maya.env:

ANIMBOT_CONFIGJSONPATH = /network/directory/of/your/config_json_file

 

 

Variables

This is the current list of variables that you can set. As the tool develops, new variables may be added.

__companyName
Protected. That’s the name of your company. This name is unique and shouldn’t be edited.

__companySignature
Protected. That’s the authentication of your config file. It shouldn’t be edited.

__configVersion
Protected. The version of this config file. If any core changes to this file is necessary in the future, this is a way to check the version you are using. It shouldn’t be edited.

rlmServerHost
That’s the address of the RLM license server and that’s how animBot will know where to look for licenses. You can specify a port number and host name (or ip address), like so: “5053@localhost”.

adminEmail
The email of your choice that your artists will contact if having problems with the license. This email will be displayed to them in Maya in case of a license issue.

internetAccess
By default, internet access is disabled, but you can set it to true if you would like users to automatically submit bug reports.

tempDataDirectory
This is the directory where animBot will save temporary data, such as Anim Recovery data. By default this variable is set to null, which will result in the default directory: “user”/maya/scripts/animBot_tmp_data.
New in v1.1.6: You can build the temp directory using environment variables between < >. Examples:

tempDataDirectory: “/network/userdata/<USERNAME>/temp”
tempDataDirectory: “<ANIMBOT_TMPDATADIRECTORY>”

disabledTools (introduced in v1.1.7)
If desired, certain tools can be disabled. Examples of use:

disabledTools: “animRecovery”
disabledTools: [“animRecovery”, “mirrorAllKeys”]

More details can be found in this page: https://animbot.ca/home/disabling-tools/

mayapyPath (introduced in v1.3.5)
This is the absolute path for the mayapy executable, which is executed when spawning Maya Standalone sessions (more details here). This is only useful in cases where animBot doesn’t find it automatically or if you wish to specify it explicitly. There are 3 ways you can set this variable:

1. A simple string, i.e. mayapyPath: “/Applications/Autodesk/maya2018/Maya.app/Contents/bin/mayapy”
2. A dictionary, where keys represent the Maya version. You can specify the exact version as a float or the main version as a int, i.e.:
   • mayapyPath: {
     2018:”/Applications/Autodesk/maya2018/Maya.app/Contents/bin/mayapy”,
     2019.1:”/Applications/Autodesk/maya2019.1/Maya.app/Contents/bin/mayapy”,
     2019.3:”/Applications/Autodesk/maya2019.3/Maya.app/Contents/bin/mayapy”
     }
3. A dictionary, where keys represent an env variable name and the value is a dictionary with the env variable expected values and its paths, i.e.:
   • mayapyPath: {
     “MY_PROJECT”:{
     “mightyeagle”:”/Applications/Autodesk/maya2018/Maya.app/Contents/bin/mayapy”,
     “fuzzywig”:”/Applications/Autodesk/maya2019/Maya.app/Contents/bin/mayapy”
     }
     }

 

---

Deprecated variables

centralInstallation
deprecated on 1.1.1, Central Installation is default on Enterprise Edition.

 

---

Back to main help page[/vc_column_text][/vc_column][/vc_row]