bindings/PySCLang/ReadMe.txt

   1 PySCLang - a python module for SuperCollider Lang
   2 Project : Psycollider
   3
   4 by:
   5 Benjamin Golinvaux
   6 benjamin.golinvaux@euresys.com
   7 messenger: bgolinvaux@hotmail.com
   8
   9 currently maintained by:
  10 Christopher Frauenberger
  11 frauenberger@iem.at
  12
  13 -------------------------------------------------------------------------------
  14
  15 PySCLang is a python module that implements the SuperCollider lang and makes it
  16 scriptable from python.
  17
  18 Functions available from python:
  19
  20 sendMain(string)
  21         string is one of the following commands to the language:
  22         interpretPrintCmdLine - evaluates the current command line string
  23         run - runs something (defined in the library, does nothing if you didint override it)
  24         stop - stops the lang
  25         openWinCodeFile - opens any code window
  26         methodTemplates -
  27         methodReferences - finds references to the method selected
  28
  29 compileLibrary()
  30         compiles the library
  31
  32 setCmdLine(string)
  33         sets the current command line to any string that contains usually sc3 code
  34
  35 start()
  36         start the module
  37
  38 setSCLogSink(window)
  39         set where the module should post to
  40
  41 compiledOK
  42         returns a bool whether the library was compiled correctly
  43
  44 Rtf2Ascii
  45         ugly conversion...
  46
  47 setPyPrOpenWinTextFile(path,startRange,rangeSize)
  48         a file to open
  49
  50 Example usage in python:
  51
  52 >>> import PySCLang, os
  53 >>> os.chdir("/Applications/SuperCollider3/")
  54 >>> PySCLang.start()
  55
  56 >>> PySCLang.setCmdLine("s = Server.local; s.boot; ")
  57 >>> PySCLang.sendMain('interpretPrintCmdLine')
  58 >>> PySCLang.setCmdLine("s.initTree; s.serverRunning=true")
  59 >>> PySCLang.sendMain('interpretPrintCmdLine')
  60
  61 >>> PySCLang.setCmdLine(" { SinOsc.ar(440, 0, 0.4) }.play(s) ")
  62 >>> PySCLang.sendMain('interpretPrintCmdLine')
  63
  64 -------------------------------------------------------------------------------
  65 Compilation
  66
  67 Windows: PySCLang is part of the Solution, please refer to the Windows documentation
  68
  69 OSX: open the Xcode file and
  70         * make sure Xcode findes libscsysnth.a (in Frameworks) - if in red navigate to it manually
  71         * set the active build to "Deployment"
  72
  73 Have fun!