DirWiz Logo
Knowledgebase

Article Tags

How can I use special reserved characters literally in a custom map file?

2020-06-11 11:32:04
Custom Mapping UnitySync 

Some characters** in map files are reserved for special use by UnitySync (i.e. ^ { ~ etc). If you need these characters to be included literally in a custom mapping, you must escape the character with a preceding backslash \ character.

Edit your custom map file to add the proper syntax.

Note: *You only need to escape the character if it appears in a set, such as this common example of enclosing a value in square brackets:
Acme [local]

To escape the characters, use a backslash before the pair:
company=^company^ \[local]

By escaping the leading special reserved character, UnitySync will disregard the set and consider those characters plain text.

The character sets that require escaping are:

[ ]
{ }
~ ~
^ ^
# #
% %

Note: Round parenthese ( ) do not need to be escaped.

** The above information pertains to typical mappings. If you are using a Javascript functions in your mappings, the function calls in the mappings may require escaping per the Javascript syntax rules.

Share this article: Twitter reddit