Parameters

Every parameter of the TDXCollab COMP, page by page, in the order the parameter dialog shows them. Each entry gives the label you see and, in code, the name a script uses (op('TDXCollab').par.Active). Every parameter also has help text: hover it in the parameter dialog.

The pages go by job: Session (joining or hosting, and who you are), Host (what only the host decides), Zone, Navigate (your network editor), Show (what you see of your partners), More (timeline, logging, diagnostics) and About. Set Up fills in most of the Session page for you; everything but the Host page is each person's own.

Session page

• Active (Active): connect (client), listen (server) or join the relay room. Off is off.
• Set Up (Setup): the Set Up window, which fills in the parameters below and switches Active. During a session it opens the TDXCollab window.
• Status (Status, read-only): what TDXCollab is doing now: off, connecting, refused with the reason, or connected with your partners' names and, in a relay room, who hosts.

You

• Display Name (Displayname): your name as your partners see it. Empty shows "Partner".
• Display Color (Displaycolor, red): the colour of your cursor and your highlights on their side.

Connection

• Connection Mode (Mode): This Operator is Server or This Operator is Client over TCP/IP (a LAN or a VPN); This Operator Joins a Room on the TDXCollab Relay, nothing to type but the room; or ...on a Self-Hosted Relay, a relay of your own (Relay Address, Relay Port).
• Local Address (Localaddress): server: the address it listens on.
• Server (Address): client: the address it connects to. The server listens on its Local Address only, so both must be the same address.
• Port (Port): TCP/IP: the port, the same on both sides (7001 by default).
• Relay Address, Relay Port (Relayaddress, Relayport): self-hosted relay only: its address (ws://host or wss://host) and port.
• Room, Room Secret (Room, Roomsecret): either relay mode: the room everyone joins and its secret. The relay refuses anyone without both. A secret shorter than 12 characters is not used. The secret is saved with the project: change or clear it before you share a .toe.
• New Room (Newroom): a new relay room: a name you can say (copper-otter-417) and a random 24-character secret, with its invite copied to the clipboard.
• Copy Invite (Copyinvite): this room's invite to the clipboard: tdxcollab://<room>/<secret>, plus the relay's address for a self-hosted relay.
• Join Invite (Invite): paste an invite here (a message around it is fine): mode, room, secret and relay are filled in, and the field empties.
• Member Token (Membertoken): joining an Unattended Host: the token its owner gave you.

Host page

These are the host's; anyone else in the session sees them greyed out. See Sessions and roles.

• New Partners May (Partnerrole, Full Edit): the role a partner has unless the host gives them another: Full Edit, Adjust Parameters or Observe.
• Ask Before Letting In (Askbeforejoin, on): ask before anyone new is in.
• Classroom (Classroom, off): one host, many observers; see Classroom.
• Partners May Summon (Partnersmaysummon, off): partners may summon too. The host always may.
• Partners May Save (Partnersmaysave, off): a Full Edit partner may save the host's project from afar.
• Partners May Edit Keep Local (Partnersmayeditkeeplocal, on): Full Edit partners may change the Keep Local table. Off, only the host does.

Per-Frame Checks

TouchDesigner reports no change of these, so TDXCollab compares them every frame; switch off what you do not need. The host's choice counts for everyone in its session.

• Sync Node Colour (Synccolor, on): operator colours.
• Sync Node Comment (Synccomment, on): operator comments.
• Sync Bind Expression Edits (Syncbindexpr, on): edits of bind expressions.
• Compare File Paths (Comparefilepaths, Relative Paths Only): which file and folder parameters the integrity check compares: relative paths only, all, or none.

Unattended

• Unattended Host (Unattendedhost, off): for a machine nobody sits at; see Remote installation.
• Unattended Drift (Unattendeddrift, Partners Decide): on an Unattended Host, who settles copies that differ: Partners Decide or Keep Mine.
• New Member Label, New Member Token (Membertokenlabel, Newmembertoken): hosting unattended: make a member token for the person named, with New Partners May's role, and copy it to the clipboard.

Zone page

See The Collab Zone.

• Collab COMP (Targetrepo): the Collab Zone, the COMP whose network everyone shares.
• Create (Targetrepocreate): make a new, empty Collab Zone and point Collab COMP at it.
• Ignore Tags (Ignoretags): more tags, separated by spaces, that make an operator one of your local tools, as TDXCollab:ignore does.

Keeping the copies the same

• Sync Zone (Synczone): choose whose zone everyone mirrors.
• Resolve Drift (Resolvedrift): show who differs from whom in what. On the host, choose whose copy everyone takes; on a partner, take the host's into your zone.
• Resync on Connect (Resynconconnect, Off): what happens to the zones when a partner connects: nothing, Take Partner's Zone or Send My Zone.
• Check Integrity (Checkintegrity, on): fingerprint the network you view and compare it with the host's copy; see When copies differ.
• Ask on Drift (Askondrift, on): on the host, pop up the drift summary once per new difference. Off, only the status bar, the chip and the log report it.

Kept zones

• Snapshot Name, Snapshot Zone (Snapshotname, Snapshotzone): keep a copy of the zone as it is now, under that name (empty: the date, time and your Display Name).
• Keep Replaced Zone (Keepreplacedzone, on): keep a replaced zone beside the new one.
• Kept Zones Limit (Keptzoneslimit, 5): how many kept zones at most; 0 for none.
• Restore Replaced Zone (Restorereplacedzone): the newest kept zone becomes the Collab Zone again; the current one is kept in its place.
• Save Host Project (Savehostproject): a partner: ask the host to save its project.

Navigate page

See Working together.

• Synced Panes (Syncedpanes): follow a partner into the networks of the zone they go to.
• Follow (Follow): with three or more people, the Display Name of the partner to follow. Empty follows whoever moved last.
• Sync Selection (Syncselection): take a partner's selection, current operator and parameter page; also syncs the viewer flag.
• Sync Parameter Page (Syncparpage, off): take the parameter page a partner turns to, without Sync Selection.
• Sync Pan and Zoom (Syncview, off): keep your view on a partner's while you both look at the same network.
• Sync Pos Zoom on Enter (Syncposzoom): take a partner's position and zoom when you enter their network.
• Enter Zone on Join (Enterzoneonjoin, on): go to the Collab Zone the first time you are in a session after switching Active on.
• Jump to Collab (Jumptocollab): go to the network your partner is in.

Ping and summon

• Ping Here, Ping Hotkey (Ping, Pinghotkey): mark a spot for everyone; the hotkey is yours, such as alt.shift.p.
• Summon Everyone Here, Summon Hotkey (Summon, Summonhotkey): bring everyone's network editor to your view.
• Travel on Summon (Travelonsummon, on): when summoned from two levels or more away, travel there through the networks on the way instead of jumping.
• Allow Pings (Allowpings, on): show partners' pings here (the ring, the pointer towards it, their row in the activity list). Off: a ping only puts a line in the status bar.
• Allow Summons (Allowsummons, on): let a partner's Summon Everyone Here move your network editor. Off: you stay where you are, and the status bar says who summoned you where.

Editing together

• Pars Read-Only (Readonly, on): a parameter a partner is changing is read-only on your side until a second after their last change (on if either of you turns it on).

Show page

See Working together.

• Show Partner Selection (Showpartnerselection, on): mark the operators partners have current or selected.
• Partner Selection Style (Partnerselectionstyle, Box and Colour): a rendered outline, the node's colour, or both.
• Remote Selected Color (Remoteselectedcolor): the colour for a partner who sends none.
• Both Selected Color (Bothselectedcolor): the colour of what you both have selected.
• Show Partner Cursor (Showpartnercursor, on): your partners' mouse pointers with their names.
• Show Partner View (Showpartnerview, on): a dashed outline of what each partner's network editor shows.
• Show Partner Activity (Showpartneractivity, on): the list of partners in a corner of the network editor.
• Activity Corner, Activity Margin (Activitycorner, Activitymargin): where that list sits (top left, 12 points in, by default).

Menu bar

• Menu Bar Order (Menubarorder, 2): where the TDXCollab chip sits among the tools in TouchDesigner's main menu bar: lower comes first, -1 at the end.

More page

Timeline

• Sync Fps (Syncfps): the project's FPS.
• Sync Timeline Settings (Synctimelinesettings): range, start and end, tempo, signature.
• Sync Timeline Transport (Synctimelinetransport): play and pause.
• Sync Current Frame (Synccurrentframe): the current frame.

Logging

• Log Level, Log to Textport, Log to Status Bar (Loglevel, Logtotextport, Logtostatusbar): TDXCollab's own log messages.
• Log Session (Logsession, off): write the session to a file in logs/ beside the project; see the session log.
• Session Log (Sessionlog, read-only): the file being written.
• Open Log Folder (Opensessionlogs): open logs/.

Diagnostics (beta)

See Diagnostics and reports.

• Send Diagnostics (Senddiagnostics, on): anonymous problem signatures to the TDXCollab relay.
• Beta Tester (Betatester, off): accept the beta terms and send fuller reports.
• Tester Tag (Testertag): the name your reports carry as a beta tester. Optional.
• Auto Report (Autoreport, on when you accept the beta terms): send a report by itself when something goes wrong.
• Report a Problem (Reportproblem): a report you see in full before you send it.
• Add Note to Last Report (Addnote): up to 500 characters on the report you sent last.

About page

Package Version, Built With TD (the TouchDesigner build the release was made with), Author (Function Store), Co-Author (TheTouchLab), and Help, Link and Co-Author Link, which open these docs, the author's page and the co-author's page.