Gwion is a programming language, aimed at making music
< Bran, our mascot, kindly provided by neverRare
strongly inspired by ChucK, but adding a bunch high-level features; templating, first-class functions and more.
Checkout the community, and join us on discord: https://discord.gg/KmHqbTKSmS. You can also check this very nice server about programming language devlopment: https://discord.gg/4Kjt3ZE, since a lot of improvements to gwion are discussed there.
Please also consider taking the (WIP) tour
Download the source
git clone --recursive https://github.com/Gwion/Gwion cd Gwion make
You can get a list of config files to tweak with
find . -name "config.mk"
Please rebuild to take your change into account.
make -C util clean make -C ast clean make clean make
Besides developer options, you migth want to check USE_DOUBLE, in util/config.mk, which set the floating point size (float or double). Note that the option you choose must match how you built your soundpipe library (more on soundpipe later).
Executing your first code (hello_world.gw):
This assumes you have successfully compiled gwion. To build follow these steps . To check, if the build was successfully run
if this gives out some error, there were problems with your compilation.
Try building again, and open a issue
if the problem persists. We would love to help you out.
If you see no errors, Congratulations!! You have successfully compiled gwion, and can move ahead.
Create a new file "hello_world.gw" in the same directory.(You are free to use any command)
Open this file using your favourite text editor
Add the following lines to print "Hello World" (Note the semicolon at the end)
<<< "Hello World" >>>;
Save and exit the file(:wq in vim). Use the following command to run your first gwion program
Congratulations!! You ran your first gwion program.
This section is currently very Linux-centric. We are working to improve that. Pull requests welcome!
Gwion relies on plugins for most of its language features, including all those that make sound. Plugins are located in the subdirectories of
plug. To get some sounds going under linux using jack sound server, you can build the plugins
Modules. Make sure you have Jack installed.
Start by downloading the sources
git submodule update plug cd plug
Starting from the Gwion base directory, to build
cd plug/Jack make
This will give you a shared object file,
Jack.so. The default place Gwion will look for plugins is in a subdir of your home directory
.gwplug. So create that directory and move
mkdir ~/.gwplug mv Jack.so ~/.gwplug
Repeat for the other plugins mentioned. The
Soundpipe plugin requires the gwion-soundpipe library, which we hope to have build seamlessly for you when you build the
Soundpipe module, but we're not quite there yet. For now, please clone gwion-soundpipe in the Soundpipe plugin directory
plug/Soundpipe. Please ask for help if this isn't working.
When all those plugin
.so files are in your
~/.gwplug directory, you should be able to run a Gwion program that makes sound! In
plug/Modules there's a
test.gw program which plays a sine wave for 5 seconds. If the
gwion you built is still in the base dir of your cloned repo, from the
plug/Modules subdirectory you should be able to run
../../gwion -d Jack test.gw and hear some sound!
It's a good idea to install Gwion now that you have tried it out. Use the following command to install it
sudo make install
To confirm Gwion can make sound, update
#import Modules <<<"Sound from Gwion!">>>; new SinOsc ~> dac; 5::second => now;
To run it with Jack as the driver:
gwion hello_world.gw -dJack. Hopefully you will hear a smooth sine wave. If not, please reach out on Discord and we'll help you out.
Reporting bugs / Contributing
If there's anything you see that can make Gwion better, please let us know!
Thanks goes to these wonderful people (emoji key):
Muhammad Umer Farooq
This project follows the all-contributors specification. Contributions of any kind welcome!
NOTE: if you should be on the list of contributors but we forgot you, don't be shy and let us know!