Home

Welcome to the lick wiki!

h3.User documentation

To include LiCK in your own ChucK scripts:

$ chuck --loop &

$ chuck + import.ck
...
"LiCK imported." : (string)

$ chuck + my-script.ck

Currently, the best place to look for user documentation is in the unit test classes (e.g. ArrayListTest.ck demonstrates how to use ArrayList.ck).

h3.Developer documentation

ChucK doesn’t provide interfaces or explicit abstract classes, so LiCK uses empty or no-op classes to represent those concepts. For example, List.ck really ought to be an interface that ArrayList.ck and LinkedList.ck would implement. In LiCK, List.ck is a class with empty or no-op implementations of all its methods which are then overridden by ArrayList.ck.

There are a lot of small classes in LiCK, by design. Simplified access to all these small classes is provided by static methods (e.g. Loops.ck provides static methods that create and return instances of Loop.ck or Repeat.ck).

If you add classes to LiCK, be sure to update import.ck with the new classes and their dependencies in the correct order.