ChucK : Build/Install Instructions

version: 1.4.x.x (numchucks)



Installing ChucK + miniAudicle

On MacOS and Windows, the straightforward way to install ChucK is through the respective installers found on the release page. This will install ChucK for the command line and miniAudicle (a GUI-based integrated ChucK development environment) to your system.

If you are planning to use miniAudicle and it installed without error, then you can skip the rest of this page. If you'd like to also use the command line version of ChucK, continue.

At this point, you should be able to invoke 'chuck' from either Terminal (in MacOS) or 'cmd' under windowsm, from any directory:

%> chuck
[chuck]: no input files... (try --help)

(this is the correct output, since we didn't specify the files to run)
  • Optionally, feel free to skip to step 7 below to test further on command...



Building ChucK from source

To build chuck from the source on Linus, MacOS, or Windows:
  1. Follow instructions for your platform on the download page.

  2. If you are building in Windows with Visual C++ 6.0 (or higher), open src/chuck_win32.dsw, choose build -> set active config -> release, hit F7 to build.

    Otherwise:

  3. unzip/tar the source (replace chuck-x.x.x.x.tgz with the actual file name):

    %> tar xvzf chuck-x.x.x.x.tgz

  4. Go to the src/ directory (replace chuck-x.x.x.x with the actual directory name):

    %> cd chuck-x.x.x.x/src/

  5. If you type 'make' here, you should get the following message:

    %> make
    [chuck build]: please use one of the following configurations:
       make linux-alsa, make linux-jack, make linux-oss,
       make osx, make osx, make win32

    Now, type the command corresponding to your platform...

    for example, for MacOS:

    %> make osx

    If all goes well, you should end up with a 'chuck' file in the current directory.

  6. If you like to install chuck manually, do the following. By default "make install" will copy chuck into /usr/local/bin. If you prefer a different destination, edit the makefile under 'install', or skip this step altogether. (we recommend putting it somewhere in your path)

    # (optional: edit the makefile first)
    %> make install

    If you haven't gotten any egregous error messages up to this point, then you should be done!

  7. For a quick sanity check, execute the following (use './chuck' if chuck is not in your path), and see if you get the same output:

    %> chuck
    [chuck]: no input files...

    To test out the audio/vm, go to the examples/ directory and run (assuming 'chuck' is in your path). To stop, pressed ctrl-c:

    # (run otf_05.ck - the .ck is optional...)
    %> chuck otf_05.ck
    
    # (run any number of files in parallel...)
    %> chuck otf_01 otf_06
    
    # (or...)
    %> chuck otf_01 otf_02 otf_05
    
    # (or run all whose name starts with 'otf'...)
    %> chuck otf*
    
    # (and fire up the mand-o-matic, in stk/ directory...)
    %> chuck stk/mand-o-matic.ck

    (if you do get error messages during compilation, or you run into some other problem - please let us know and we will do our best to provide support)

  8. You are ready to ChucK. If this is your first time programming in ChucK, you may want to look at the documentation, or take the ChucK Tutorial. Thank you, go forth, and ChucK - contact us for support or to make a suggestion or to call us idiots.
- Ge + Perry


chuck | soundlab | cs | music | ccrma