Skip to content

Arguments

Will Colding edited this page Aug 16, 2023 · 4 revisions

Arguments

pyTOSC must be executed with one or more of the following arguments:

-u, --unpack

Unpacks the target .tosc file specified by the UnpackTarget in config.ini. The resulting files include a project XML and any Lua scripts attached to objects. If the root node of the file contains a string property named projectName, that will be used to name the XML, e.g.:

<property type="s">
  <key>projectName</key>
  <value>My Fun Project</value>
</property>

Otherwise, the file will be named default.xml.

-b, --build

Packs the target .xml file specified by the BuildXML in config.ini. The result is a .tosc file located in the Build folder.

-c, --clean

Removes all files from the Build folder.

-l, --clean-lua

Removes all files from the Lua folder. This is useful if you rename objects/scripts in TouchOSC and you want to clean up your directory before unpacking it again to avoid having duplicate, unused scripts.

Clone this wiki locally