SudoMagic Style Guide

Style and voice are different. Style is standard conventions of writing. Voice is the distinct way an individual puts words together. All good writers have a near-uniform understanding of style but a voice all their own.

― Naveed Saleh, The Complete Guide to Article Writing: How to Write Successful Articles for Online and Print Markets

There are as many ways to use TouchDesigner as there are developers and artists that use TouchDesigner. To that end, the aim of a style guide is to provide standards and conventions that we agree upon as a working schema. This has a number of benefits:

it ensures networks follow patterns that are easier for developers to quickly navigate and read
it reduces the cognitive energy required for moving between projects (shared project architectures create reliability and consistency)
it allows for easier code review and discussion between developers
it allows us to work with other developers and artists by using an established and reliable structure

This style guide aims to capture our working standards at SudoMagic, both for network set-up, project structure, and for the use of Python and GLSL in the context of TouchDesigner.