├── .gitignore ├── ansible.cfg ├── roles └── meta │ ├── defaults │ └── main.yml │ └── tasks │ └── main.yml ├── tidal.play.yml ├── tidal_vim.play.yml ├── tidal_pulsar.play.yml ├── tidal_vscode.play.yml ├── tidal_emacs.play.yml ├── tidal_neovim.play.yml ├── tidal_feedforward.play.yml ├── tidal_textmanagement.play.yml ├── .test_tidal_all_roles.play.yml ├── vagrant ├── README.md ├── Vagrantfile.mint20_64 ├── Vagrantfile.debian11_64 ├── Vagrantfile.mint21_64 ├── Vagrantfile.mint22_64 ├── Vagrantfile.ubuntu2004_64 ├── Vagrantfile.ubuntu2204_64 ├── Vagrantfile.debiantesting_64 ├── Vagrantfile.ubuntu2404_64 └── Vagrantfile.debian12_64 ├── .gitmodules ├── .github └── workflows │ ├── vagrant-mint.yml │ ├── vagrant-debian.yml │ └── vagrant-ubuntu.yml ├── tidal_remove.play.yml ├── vars ├── .test_vars_all.yml └── all.yml.ex ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .vagrant 2 | vars/all.yml 3 | -------------------------------------------------------------------------------- /ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | interpreter_python = /usr/bin/python3 3 | -------------------------------------------------------------------------------- /roles/meta/defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | git_sample_individual_dir: "/home/{{ansible_env.SUDO_USER}}/.local/share/ansible-tidalcycles/git_sample_individual_dir" 4 | git_sample_sets_dir: "/home/{{ansible_env.SUDO_USER}}/.local/share/ansible-tidalcycles/git_sample_sets_dir" 5 | -------------------------------------------------------------------------------- /tidal.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | -------------------------------------------------------------------------------- /tidal_vim.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | - roles/vim 20 | -------------------------------------------------------------------------------- /tidal_pulsar.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | - roles/pulsar 20 | -------------------------------------------------------------------------------- /tidal_vscode.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | - roles/vscode 20 | -------------------------------------------------------------------------------- /tidal_emacs.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | - roles/emacs 20 | 21 | -------------------------------------------------------------------------------- /tidal_neovim.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | - roles/neovim 20 | 21 | -------------------------------------------------------------------------------- /tidal_feedforward.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | - roles/feedforward 20 | -------------------------------------------------------------------------------- /tidal_textmanagement.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | - roles/text_management 20 | -------------------------------------------------------------------------------- /.test_tidal_all_roles.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - stat: 6 | path: vars/.test_vars_all.yml 7 | register: vars_all 8 | tags: 9 | - config 10 | 11 | - include_vars: vars/.test_vars_all.yml 12 | when: vars_all.stat.exists 13 | tags: 14 | - config 15 | 16 | roles: 17 | - roles/meta 18 | - roles/tidal 19 | - roles/neovim 20 | - roles/emacs 21 | - roles/pulsar 22 | - roles/text_management 23 | - roles/vim 24 | - roles/vscode 25 | 26 | -------------------------------------------------------------------------------- /vagrant/README.md: -------------------------------------------------------------------------------- 1 | # vagrant/ 2 | 3 | Vagrant config files for testing our supported distros. Provisions each of the playbooks against a vagrant box (virtualbox provider) running the specified distro. 4 | 5 | This can be run manually if desired, but exists mostly for use with automated testing in github 6 | 7 | ## package deps 8 | 9 | For VirtualBox: 10 | ``` 11 | sudo apt-get install vagrant virtualbox-qt libvirt-daemon libvirt-daemon-driver-vbox 12 | ``` 13 | 14 | ## running a single container 15 | 16 | Usage: 17 | 18 | ``` 19 | VAGRANT_VAGRANTFILE=Vagrantfile. vagrant up --provision [--provider=virtualbox | libvirt] # initialise and provision 20 | VAGRANT_VAGRANTFILE=Vagrantfile. vagrant provision # run all provision tasks against a running box 21 | VAGRANT_VAGRANTFILE=Vagrantfile. vagrant ssh # login to a shell in the box, useful for debugging 22 | VAGRANT_VAGRANTFILE=Vagrantfile. vagrant destroy # get rid of the box, to allow provision against another clean instance/different distro 23 | # NOTE: add the --provision-with= to provision a specific role only 24 | ``` 25 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "roles/vscode"] 2 | path = roles/vscode 3 | url = https://github.com/cleary/ansible-tidalcycles-editor-vscode.git 4 | [submodule "roles/tidal"] 5 | path = roles/tidal 6 | url = https://github.com/cleary/ansible-tidalcycles-base.git 7 | [submodule "roles/vim"] 8 | path = roles/vim 9 | url = https://github.com/cleary/ansible-tidalcycles-editor-vim.git 10 | [submodule "roles/feedforward"] 11 | path = roles/feedforward 12 | url = https://github.com/cleary/ansible-tidalcycles-editor-feedforward.git 13 | [submodule "roles/neovim"] 14 | path = roles/neovim 15 | url = https://github.com/cleary/ansible-tidalcycles-editor-neovim.git 16 | [submodule "roles/ugens-mutable-instruments"] 17 | path = roles/ugens-mutable-instruments 18 | url = https://github.com/cleary/ansible-tidalcycles-synth-mi-ugens.git 19 | [submodule "roles/emacs"] 20 | path = roles/emacs 21 | url = https://github.com/cleary/ansible-tidalcycles-editor-emacs.git 22 | [submodule "roles/pulsar"] 23 | path = roles/pulsar 24 | url = https://github.com/cleary/ansible-tidalcycles-editor-pulsar.git 25 | [submodule "roles/text_management"] 26 | path = roles/text_management 27 | url = https://github.com/cleary/ansible-tidalcycles-editor-text_management.git 28 | -------------------------------------------------------------------------------- /.github/workflows/vagrant-mint.yml: -------------------------------------------------------------------------------- 1 | 2 | name: vagrant-mint 3 | 4 | on: 5 | push: 6 | branches: master 7 | pull_request: 8 | types: 9 | - opened 10 | 11 | jobs: 12 | vagrant-mint-all: 13 | runs-on: ubuntu-24.04 14 | defaults: 15 | run: 16 | working-directory: ./vagrant 17 | 18 | steps: 19 | - name: add vagrant packages repo 20 | uses: myci-actions/add-deb-repo@11 21 | with: 22 | repo: deb https://apt.releases.hashicorp.com noble main 23 | repo-name: vagrant 24 | keys-asc: https://apt.releases.hashicorp.com/gpg 25 | install: vagrant 26 | 27 | - name: checkout repo 28 | uses: actions/checkout@v4 29 | 30 | - name: install vagrant/qemu provider 31 | uses: ConorMacBride/install-package@v1.1.0 32 | with: 33 | apt: vagrant qemu-kvm virtualbox libvirt-daemon libvirt-daemon-driver-vbox 34 | 35 | - name: test Vagrantfile.mint21_64 36 | if: always() 37 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.mint21_64 vagrant up --provision --provider=virtualbox 38 | 39 | - name: destroy Vagrantfile.mint21_64 40 | if: always() 41 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.mint21_64 vagrant destroy -f 42 | 43 | - name: test Vagrantfile.mint22_64 44 | if: always() 45 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.mint22_64 vagrant up --provision --provider=virtualbox 46 | 47 | - name: destroy Vagrantfile.mint22_64 48 | if: always() 49 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.mint22_64 vagrant destroy -f 50 | -------------------------------------------------------------------------------- /.github/workflows/vagrant-debian.yml: -------------------------------------------------------------------------------- 1 | 2 | name: vagrant-debian 3 | 4 | on: 5 | push: 6 | branches: master 7 | pull_request: 8 | types: 9 | - opened 10 | 11 | jobs: 12 | vagrant-debian-all: 13 | runs-on: ubuntu-24.04 14 | defaults: 15 | run: 16 | working-directory: ./vagrant 17 | 18 | steps: 19 | - name: add vagrant packages repo 20 | uses: myci-actions/add-deb-repo@11 21 | with: 22 | repo: deb https://apt.releases.hashicorp.com noble main 23 | repo-name: vagrant 24 | keys-asc: https://apt.releases.hashicorp.com/gpg 25 | install: vagrant 26 | 27 | - name: checkout repo 28 | uses: actions/checkout@v4 29 | 30 | - name: install vagrant/qemu provider 31 | uses: ConorMacBride/install-package@v1.1.0 32 | with: 33 | apt: vagrant qemu-kvm virtualbox libvirt-daemon libvirt-daemon-driver-vbox 34 | 35 | - name: test Vagrantfile.debian11_64 36 | if: always() 37 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.debian11_64 vagrant up --provision --provider=virtualbox 38 | 39 | - name: destroy Vagrantfile.debian11_64 40 | if: always() 41 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.debian11_64 vagrant destroy -f 42 | 43 | - name: test Vagrantfile.debian12_64 44 | if: always() 45 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.debian12_64 vagrant up --provision --provider=virtualbox 46 | 47 | - name: destroy Vagrantfile.debian12_64 48 | if: always() 49 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.debian12_64 vagrant destroy -f 50 | -------------------------------------------------------------------------------- /roles/meta/tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - block: 4 | - set_fact: 5 | short_name_list: "{{ short_name_list|default([]) + [ item | basename | splitext | first ] }}" 6 | with_items: "{{ git_sample_sets }}" 7 | 8 | - name: "clone sample sets from git repos into {{ git_sample_sets_dir }}" 9 | git: 10 | repo: "{{ item }}" 11 | dest: "{{ git_sample_sets_dir }}/{{ item | basename | splitext | first }}" 12 | with_items: "{{ git_sample_sets }}" 13 | 14 | - name: append sample paths to our custom_sample_paths list 15 | set_fact: 16 | custom_sample_paths: "{{ custom_sample_paths|default([]) + [ git_sample_sets_dir + '/' + item ] }}" 17 | with_items: "{{ short_name_list }}" 18 | 19 | become: yes 20 | become_method: su 21 | become_user: "{{ansible_env.SUDO_USER}}" 22 | become_flags: '-s /bin/bash' 23 | when: git_sample_sets is defined 24 | 25 | - block: 26 | - name: make sure our dir for individual samples exists 27 | file: 28 | path: "{{ git_sample_individual_dir }}" 29 | state: directory 30 | mode: 0755 31 | 32 | - name: "clone individual samples from git repos into {{ git_sample_individual_dir }}" 33 | git: 34 | repo: "{{ item.git_url }}" 35 | dest: "{{ git_sample_individual_dir }}/{{ item.livecode_name }}" 36 | with_items: "{{ git_sample_individuals }}" 37 | 38 | - name: append sample paths to our custom_sample_paths list 39 | set_fact: 40 | custom_sample_paths: "{{ custom_sample_paths|default([]) + [ git_sample_individual_dir ] }}" 41 | 42 | become: yes 43 | become_method: su 44 | become_user: "{{ansible_env.SUDO_USER}}" 45 | become_flags: '-s /bin/bash' 46 | when: git_sample_individuals is defined 47 | 48 | 49 | -------------------------------------------------------------------------------- /tidal_remove.play.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: all 3 | 4 | pre_tasks: 5 | - debug: 6 | msg: 7 | - WARNING WARNING WARNING WARNING 8 | - ---- 9 | - This is not a finely crafted surgical tool, it is a hammer. 10 | - It will delete Tidal related folders in your home directory, namely 11 | - ~/.ghc 12 | - ~/.cabal 13 | - ~/.local/share/SuperCollider 14 | - ~/.config/SuperCollider 15 | - ---- 16 | - To confirm you understand the risk, and have taken your own backups, 17 | - Re-run this playbook with the following command 18 | - - sudo ansible-playbook --connection=local -i localhost, tidal_remove.play.yml -t REMOVE 19 | - END OF WARNING END OF WARNING 20 | when: "'REMOVE' not in ansible_run_tags" 21 | tags: always 22 | failed_when: true 23 | 24 | - stat: 25 | path: vars/all.yml 26 | register: vars_all 27 | tags: 28 | - config 29 | 30 | - include_vars: vars/all.yml 31 | when: vars_all.stat.exists 32 | tags: 33 | - config 34 | 35 | tasks: 36 | - name: remove tidal-related directories from user's home 37 | file: 38 | path: "{{ item }}" 39 | state: absent 40 | with_items: 41 | - "/home/{{ ansible_env.SUDO_USER }}/.cabal" 42 | - "/home/{{ ansible_env.SUDO_USER }}/.ghc" 43 | - "/home/{{ ansible_env.SUDO_USER }}/.local/share/SuperCollider" 44 | - "/home/{{ ansible_env.SUDO_USER }}/.config/SuperCollider" 45 | failed_when: false 46 | become: yes 47 | become_method: su 48 | become_user: "{{ansible_env.SUDO_USER}}" 49 | become_flags: '-s /bin/bash' 50 | tags: 51 | - REMOVE 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /.github/workflows/vagrant-ubuntu.yml: -------------------------------------------------------------------------------- 1 | 2 | name: vagrant-ubuntu 3 | 4 | on: 5 | push: 6 | branches: master 7 | pull_request: 8 | types: 9 | - opened 10 | 11 | jobs: 12 | vagrant-ubuntu-all: 13 | runs-on: ubuntu-24.04 14 | defaults: 15 | run: 16 | working-directory: ./vagrant 17 | 18 | steps: 19 | - name: add vagrant packages repo 20 | uses: myci-actions/add-deb-repo@11 21 | with: 22 | repo: deb https://apt.releases.hashicorp.com noble main 23 | repo-name: vagrant 24 | keys-asc: https://apt.releases.hashicorp.com/gpg 25 | install: vagrant 26 | 27 | - name: checkout repo 28 | uses: actions/checkout@v4 29 | 30 | - name: install vagrant/qemu provider 31 | uses: ConorMacBride/install-package@v1.1.0 32 | with: 33 | apt: vagrant qemu-kvm virtualbox libvirt-daemon libvirt-daemon-driver-vbox 34 | 35 | - name: test Vagrantfile.ubuntu2004_64 36 | if: always() 37 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.ubuntu2004_64 vagrant up --provision --provider=virtualbox 38 | 39 | - name: destroy Vagrantfile.ubuntu2004_64 40 | if: always() 41 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.ubuntu2004_64 vagrant destroy -f 42 | 43 | - name: test Vagrantfile.ubuntu2204_64 44 | if: always() 45 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.ubuntu2204_64 vagrant up --provision --provider=virtualbox 46 | 47 | - name: destroy Vagrantfile.ubuntu2204_64 48 | if: always() 49 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.ubuntu2204_64 vagrant destroy -f 50 | 51 | - name: test Vagrantfile.ubuntu2404_64 52 | if: always() 53 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.ubuntu2404_64 vagrant up --provision --provider=virtualbox 54 | 55 | - name: destroy Vagrantfile.ubuntu2404_64 56 | if: always() 57 | run: sudo VAGRANT_VAGRANTFILE=Vagrantfile.ubuntu2404_64 vagrant destroy -f 58 | -------------------------------------------------------------------------------- /vars/.test_vars_all.yml: -------------------------------------------------------------------------------- 1 | # Test file for automated github workflow testing only 2 | 3 | # list of samples paths 4 | # loaded in: 5 | # * supercollider startup.scd 6 | # * vscode/pulsar tidalcycles extension sample browser 7 | #custom_sample_paths: 8 | # - "/home/user/foo/" 9 | # - "/home/user/bar/" 10 | 11 | # source samples from git repositories 12 | # Individual samples keep the audio files in the top directory of the repository 13 | git_sample_individuals: 14 | - { livecode_name: flbass, git_url: "https://github.com/cleary/samples-flbass.git" } 15 | - { livecode_name: cbow, git_url: "https://github.com/cleary/samples-cello-bowed.git" } 16 | - { livecode_name: cpluck, git_url: "https://github.com/cleary/samples-cello-plucked.git" } 17 | - { livecode_name: uku, git_url: "https://github.com/thgrund/samples-ukulele.git" } 18 | - { livecode_name: eride, git_url: "https://github.com/abalone1969/eRide.git" } 19 | - { livecode_name: ebongos, git_url: "https://github.com/abalone1969/ebongos.git" } 20 | 21 | # Sample sets have the audio files contained in multiple subdirs of the repository 22 | git_sample_sets: 23 | - https://github.com/lwlsn/Misc_Samples.git 24 | - https://github.com/yaxu/dirt-jv1080.git 25 | - https://github.com/yaxu/dirt-impulse.git 26 | - https://github.com/dktr0/estuary-samples.git 27 | - https://github.com/dktr0/supercontinent.git 28 | - https://github.com/dktr0/cybernetic-samples.git 29 | - https://github.com/cleary/samples-hydrogen-drums 30 | 31 | # modify common supercollider startup.scd defaults 32 | # for complete list of available defaults check: 33 | # roles/tidal/defaults/main.yml 34 | # roles/tidal/templates/startup.scd.template 35 | # 36 | # uncomment to modify the number of supercollider outputs (hardware/DAW etc) 37 | # note: superdirt orbit assignment is auto-calculated, ref https://tidalcycles.org/Separate_audio_outputs 38 | sc_option_numOutputBusChannels: 2 39 | 40 | # connect midi client(s) to send patterns *from tidal* (hardware, software synths/plugins etc) 41 | # see: https://tidalcycles.org/SuperDirt_MIDI_Tutorial 42 | # In SuperCollider get the output of: 43 | # MIDIClient.init; 44 | # Which will return a series Sources and Destinations in the following format: 45 | # MIDIEndPoint("full_name", "port_name") 46 | # livecode_name is the name you'd like to use to refer to this midi device in your tidal code 47 | # latency is optional, and defaults to 0 48 | # 49 | custom_midi_clients: 50 | - { livecode_name: midi0, full_name: Midi Through, port_name: Midi Through Port-0, latency: 0 } 51 | # - { livecode_name: midi1, full_name: Focusrite USB MIDI, port_name: Focusrite USB MIDI } 52 | 53 | # install and configure various ugens, currently supported: 54 | # * mutable-instruments (ref https://github.com/v7b1/mi-UGens) 55 | sc_ugens: 56 | - "mutable-instruments" 57 | -------------------------------------------------------------------------------- /vars/all.yml.ex: -------------------------------------------------------------------------------- 1 | # Example file only! 2 | # Copy this file to vars/all.yml and uncomment to use 3 | 4 | # list of samples paths 5 | # loaded in: 6 | # * supercollider startup.scd 7 | # * vscode/pulsar tidalcycles extension sample browser 8 | #custom_sample_paths: 9 | # - "/home/user/foo/" 10 | # - "/home/user/bar/" 11 | 12 | # source samples from git repositories 13 | # Individual samples keep the audio files in the top directory of the repository 14 | #git_sample_individuals: 15 | # - { livecode_name: flbass, git_url: "https://github.com/cleary/samples-flbass.git" } 16 | # - { livecode_name: cbow, git_url: "https://github.com/cleary/samples-cello-bowed.git" } 17 | # - { livecode_name: cpluck, git_url: "https://github.com/cleary/samples-cello-plucked.git" } 18 | # - { livecode_name: uku, git_url: "https://github.com/thgrund/samples-ukulele.git" } 19 | # - { livecode_name: eride, git_url: "https://github.com/abalone1969/eRide.git" } 20 | # - { livecode_name: ebongos, git_url: "https://github.com/abalone1969/ebongos.git" } 21 | 22 | # Sample sets have the audio files contained in multiple subdirs of the repository 23 | #git_sample_sets: 24 | # - https://github.com/lwlsn/Misc_Samples.git 25 | # - https://github.com/yaxu/dirt-jv1080.git 26 | # - https://github.com/yaxu/dirt-impulse.git 27 | # - https://github.com/dktr0/estuary-samples.git 28 | # - https://github.com/dktr0/supercontinent.git 29 | # - https://github.com/dktr0/cybernetic-samples.git 30 | # - https://github.com/cleary/samples-hydrogen-drums 31 | 32 | # modify common supercollider startup.scd defaults 33 | # for complete list of available defaults check: 34 | # roles/tidal/defaults/main.yml 35 | # roles/tidal/templates/startup.scd.template 36 | # 37 | # uncomment to modify the number of supercollider outputs (hardware/DAW etc) 38 | # note: superdirt orbit assignment is auto-calculated, ref https://tidalcycles.org/Separate_audio_outputs 39 | # sc_option_numOutputBusChannels: 2 40 | 41 | # connect midi client(s) to send patterns *from tidal* (hardware, software synths/plugins etc) 42 | # see: https://tidalcycles.org/SuperDirt_MIDI_Tutorial 43 | # In SuperCollider get the output of: 44 | # MIDIClient.init; 45 | # Which will return a series Sources and Destinations in the following format: 46 | # MIDIEndPoint("full_name", "port_name") 47 | # livecode_name is the name you'd like to use to refer to this midi device in your tidal code 48 | # latency is optional, and defaults to 0 49 | # 50 | #custom_midi_clients: 51 | # - { livecode_name: midi0, full_name: Midi Through, port_name: Midi Through Port-0, latency: 0 } 52 | # - { livecode_name: midi1, full_name: Focusrite USB MIDI, port_name: Focusrite USB MIDI } 53 | 54 | # install and configure various ugens, currently supported: 55 | # * mutable-instruments (ref https://github.com/v7b1/mi-UGens) 56 | #sc_ugens: 57 | # - "mutable-instruments" 58 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.mint20_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "epipho/mint-20.0" 16 | 17 | # Disable automatic box update checking. If you disable this, then 18 | # boxes will only be checked for updates when the user runs 19 | # `vagrant box outdated`. This is not recommended. 20 | # config.vm.box_check_update = false 21 | 22 | # Create a forwarded port mapping which allows access to a specific port 23 | # within the machine from a port on the host machine. In the example below, 24 | # accessing "localhost:8080" will access port 80 on the guest machine. 25 | # NOTE: This will enable public access to the opened port 26 | # config.vm.network "forwarded_port", guest: 80, host: 8080 27 | 28 | # Create a forwarded port mapping which allows access to a specific port 29 | # within the machine from a port on the host machine and only allow access 30 | # via 127.0.0.1 to disable public access 31 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 32 | 33 | # Create a private network, which allows host-only access to the machine 34 | # using a specific IP. 35 | # config.vm.network "private_network", ip: "192.168.33.10" 36 | 37 | # Create a public network, which generally matched to bridged network. 38 | # Bridged networks make the machine appear as another physical device on 39 | # your network. 40 | # config.vm.network "public_network" 41 | 42 | # Share an additional folder to the guest VM. The first argument is 43 | # the path on the host to the actual folder. The second argument is 44 | # the path on the guest to mount the folder. And the optional third 45 | # argument is a set of non-required options. 46 | # config.vm.synced_folder "../data", "/vagrant_data" 47 | 48 | # Provider-specific configuration so you can fine-tune various 49 | # backing providers for Vagrant. These expose provider-specific options. 50 | # Example for VirtualBox: 51 | # 52 | config.vm.provider "virtualbox" do |vb| 53 | # Display the VirtualBox GUI when booting the machine 54 | vb.gui = false 55 | 56 | # Customize the amount of memory on the VM: 57 | vb.memory = "2048" 58 | end 59 | 60 | # View the documentation for the provider you are using for more 61 | # information on available options. 62 | 63 | # Enable provisioning with a shell script. Additional provisioners such as 64 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 65 | # documentation for more information about their specific syntax and use. 66 | 67 | # execute ansible on guest directly, most accurate for end user usage replication 68 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 69 | apt-get update && apt-get install -y git ansible 70 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 71 | cd ansible-tidalcycles/ 72 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 73 | SHELL 74 | end 75 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.debian11_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "debian/bullseye64" 16 | 17 | # Disable automatic box update checking. If you disable this, then 18 | # boxes will only be checked for updates when the user runs 19 | # `vagrant box outdated`. This is not recommended. 20 | # config.vm.box_check_update = false 21 | 22 | # Create a forwarded port mapping which allows access to a specific port 23 | # within the machine from a port on the host machine. In the example below, 24 | # accessing "localhost:8080" will access port 80 on the guest machine. 25 | # NOTE: This will enable public access to the opened port 26 | # config.vm.network "forwarded_port", guest: 80, host: 8080 27 | 28 | # Create a forwarded port mapping which allows access to a specific port 29 | # within the machine from a port on the host machine and only allow access 30 | # via 127.0.0.1 to disable public access 31 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 32 | 33 | # Create a private network, which allows host-only access to the machine 34 | # using a specific IP. 35 | # config.vm.network "private_network", ip: "192.168.33.10" 36 | 37 | # Create a public network, which generally matched to bridged network. 38 | # Bridged networks make the machine appear as another physical device on 39 | # your network. 40 | # config.vm.network "public_network" 41 | 42 | # Share an additional folder to the guest VM. The first argument is 43 | # the path on the host to the actual folder. The second argument is 44 | # the path on the guest to mount the folder. And the optional third 45 | # argument is a set of non-required options. 46 | # config.vm.synced_folder "../data", "/vagrant_data" 47 | 48 | # Provider-specific configuration so you can fine-tune various 49 | # backing providers for Vagrant. These expose provider-specific options. 50 | # Example for VirtualBox: 51 | # 52 | config.vm.provider "virtualbox" do |vb| 53 | # Display the VirtualBox GUI when booting the machine 54 | vb.gui = false 55 | 56 | # Customize the amount of memory on the VM: 57 | vb.memory = "2048" 58 | end 59 | 60 | # View the documentation for the provider you are using for more 61 | # information on available options. 62 | 63 | # Enable provisioning with a shell script. Additional provisioners such as 64 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 65 | # documentation for more information about their specific syntax and use. 66 | 67 | # execute ansible on guest directly, most accurate for end user usage replication 68 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 69 | apt-get update && apt-get install -y git ansible 70 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 71 | cd ansible-tidalcycles/ 72 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 73 | SHELL 74 | end 75 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.mint21_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "skaary/LinuxMint21" 16 | 17 | # Disable automatic box update checking. If you disable this, then 18 | # boxes will only be checked for updates when the user runs 19 | # `vagrant box outdated`. This is not recommended. 20 | # config.vm.box_check_update = false 21 | 22 | # Create a forwarded port mapping which allows access to a specific port 23 | # within the machine from a port on the host machine. In the example below, 24 | # accessing "localhost:8080" will access port 80 on the guest machine. 25 | # NOTE: This will enable public access to the opened port 26 | # config.vm.network "forwarded_port", guest: 80, host: 8080 27 | 28 | # Create a forwarded port mapping which allows access to a specific port 29 | # within the machine from a port on the host machine and only allow access 30 | # via 127.0.0.1 to disable public access 31 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 32 | 33 | # Create a private network, which allows host-only access to the machine 34 | # using a specific IP. 35 | # config.vm.network "private_network", ip: "192.168.33.10" 36 | 37 | # Create a public network, which generally matched to bridged network. 38 | # Bridged networks make the machine appear as another physical device on 39 | # your network. 40 | # config.vm.network "public_network" 41 | 42 | # Share an additional folder to the guest VM. The first argument is 43 | # the path on the host to the actual folder. The second argument is 44 | # the path on the guest to mount the folder. And the optional third 45 | # argument is a set of non-required options. 46 | # config.vm.synced_folder "../data", "/vagrant_data" 47 | 48 | # Provider-specific configuration so you can fine-tune various 49 | # backing providers for Vagrant. These expose provider-specific options. 50 | # Example for VirtualBox: 51 | # 52 | config.vm.provider "virtualbox" do |vb| 53 | # Display the VirtualBox GUI when booting the machine 54 | vb.gui = false 55 | 56 | # Customize the amount of memory on the VM: 57 | vb.memory = "2048" 58 | end 59 | 60 | # View the documentation for the provider you are using for more 61 | # information on available options. 62 | 63 | # Enable provisioning with a shell script. Additional provisioners such as 64 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 65 | # documentation for more information about their specific syntax and use. 66 | 67 | # execute ansible on guest directly, most accurate for end user usage replication 68 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 69 | apt-get update && apt-get install -y git ansible 70 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 71 | cd ansible-tidalcycles/ 72 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 73 | SHELL 74 | end 75 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.mint22_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "archman/linuxmint" 16 | 17 | # Disable automatic box update checking. If you disable this, then 18 | # boxes will only be checked for updates when the user runs 19 | # `vagrant box outdated`. This is not recommended. 20 | # config.vm.box_check_update = false 21 | 22 | # Create a forwarded port mapping which allows access to a specific port 23 | # within the machine from a port on the host machine. In the example below, 24 | # accessing "localhost:8080" will access port 80 on the guest machine. 25 | # NOTE: This will enable public access to the opened port 26 | # config.vm.network "forwarded_port", guest: 80, host: 8080 27 | 28 | # Create a forwarded port mapping which allows access to a specific port 29 | # within the machine from a port on the host machine and only allow access 30 | # via 127.0.0.1 to disable public access 31 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 32 | 33 | # Create a private network, which allows host-only access to the machine 34 | # using a specific IP. 35 | # config.vm.network "private_network", ip: "192.168.33.10" 36 | 37 | # Create a public network, which generally matched to bridged network. 38 | # Bridged networks make the machine appear as another physical device on 39 | # your network. 40 | # config.vm.network "public_network" 41 | 42 | # Share an additional folder to the guest VM. The first argument is 43 | # the path on the host to the actual folder. The second argument is 44 | # the path on the guest to mount the folder. And the optional third 45 | # argument is a set of non-required options. 46 | # config.vm.synced_folder "../data", "/vagrant_data" 47 | 48 | # Provider-specific configuration so you can fine-tune various 49 | # backing providers for Vagrant. These expose provider-specific options. 50 | # Example for VirtualBox: 51 | # 52 | config.vm.provider "virtualbox" do |vb| 53 | # Display the VirtualBox GUI when booting the machine 54 | vb.gui = false 55 | 56 | # Customize the amount of memory on the VM: 57 | vb.memory = "2048" 58 | end 59 | 60 | # View the documentation for the provider you are using for more 61 | # information on available options. 62 | 63 | # Enable provisioning with a shell script. Additional provisioners such as 64 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 65 | # documentation for more information about their specific syntax and use. 66 | 67 | # execute ansible on guest directly, most accurate for end user usage replication 68 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 69 | apt-get update && apt-get install -y git ansible 70 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 71 | cd ansible-tidalcycles/ 72 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 73 | SHELL 74 | end 75 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.ubuntu2004_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "ubuntu/focal64" 16 | 17 | # Disable automatic box update checking. If you disable this, then 18 | # boxes will only be checked for updates when the user runs 19 | # `vagrant box outdated`. This is not recommended. 20 | # config.vm.box_check_update = false 21 | 22 | # Create a forwarded port mapping which allows access to a specific port 23 | # within the machine from a port on the host machine. In the example below, 24 | # accessing "localhost:8080" will access port 80 on the guest machine. 25 | # NOTE: This will enable public access to the opened port 26 | # config.vm.network "forwarded_port", guest: 80, host: 8080 27 | 28 | # Create a forwarded port mapping which allows access to a specific port 29 | # within the machine from a port on the host machine and only allow access 30 | # via 127.0.0.1 to disable public access 31 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 32 | 33 | # Create a private network, which allows host-only access to the machine 34 | # using a specific IP. 35 | # config.vm.network "private_network", ip: "192.168.33.10" 36 | 37 | # Create a public network, which generally matched to bridged network. 38 | # Bridged networks make the machine appear as another physical device on 39 | # your network. 40 | # config.vm.network "public_network" 41 | 42 | # Share an additional folder to the guest VM. The first argument is 43 | # the path on the host to the actual folder. The second argument is 44 | # the path on the guest to mount the folder. And the optional third 45 | # argument is a set of non-required options. 46 | # config.vm.synced_folder "../data", "/vagrant_data" 47 | 48 | # Provider-specific configuration so you can fine-tune various 49 | # backing providers for Vagrant. These expose provider-specific options. 50 | # Example for VirtualBox: 51 | # 52 | config.vm.provider "virtualbox" do |vb| 53 | # Display the VirtualBox GUI when booting the machine 54 | vb.gui = false 55 | 56 | # Customize the amount of memory on the VM: 57 | vb.memory = "2048" 58 | end 59 | 60 | # View the documentation for the provider you are using for more 61 | # information on available options. 62 | 63 | # Enable provisioning with a shell script. Additional provisioners such as 64 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 65 | # documentation for more information about their specific syntax and use. 66 | 67 | # execute ansible on guest directly, most accurate for end user usage replication 68 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 69 | apt-get update && apt-get install -y git ansible 70 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 71 | cd ansible-tidalcycles/ 72 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 73 | SHELL 74 | end 75 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.ubuntu2204_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "ubuntu/jammy64" 16 | 17 | # Disable automatic box update checking. If you disable this, then 18 | # boxes will only be checked for updates when the user runs 19 | # `vagrant box outdated`. This is not recommended. 20 | # config.vm.box_check_update = false 21 | 22 | # Create a forwarded port mapping which allows access to a specific port 23 | # within the machine from a port on the host machine. In the example below, 24 | # accessing "localhost:8080" will access port 80 on the guest machine. 25 | # NOTE: This will enable public access to the opened port 26 | # config.vm.network "forwarded_port", guest: 80, host: 8080 27 | 28 | # Create a forwarded port mapping which allows access to a specific port 29 | # within the machine from a port on the host machine and only allow access 30 | # via 127.0.0.1 to disable public access 31 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 32 | 33 | # Create a private network, which allows host-only access to the machine 34 | # using a specific IP. 35 | # config.vm.network "private_network", ip: "192.168.33.10" 36 | 37 | # Create a public network, which generally matched to bridged network. 38 | # Bridged networks make the machine appear as another physical device on 39 | # your network. 40 | # config.vm.network "public_network" 41 | 42 | # Share an additional folder to the guest VM. The first argument is 43 | # the path on the host to the actual folder. The second argument is 44 | # the path on the guest to mount the folder. And the optional third 45 | # argument is a set of non-required options. 46 | # config.vm.synced_folder "../data", "/vagrant_data" 47 | 48 | # Provider-specific configuration so you can fine-tune various 49 | # backing providers for Vagrant. These expose provider-specific options. 50 | # Example for VirtualBox: 51 | # 52 | config.vm.provider "virtualbox" do |vb| 53 | # Display the VirtualBox GUI when booting the machine 54 | vb.gui = false 55 | 56 | # Customize the amount of memory on the VM: 57 | vb.memory = "2048" 58 | end 59 | 60 | # View the documentation for the provider you are using for more 61 | # information on available options. 62 | 63 | # Enable provisioning with a shell script. Additional provisioners such as 64 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 65 | # documentation for more information about their specific syntax and use. 66 | 67 | # execute ansible on guest directly, most accurate for end user usage replication 68 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 69 | apt-get update && apt-get install -y git ansible 70 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 71 | cd ansible-tidalcycles/ 72 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 73 | SHELL 74 | end 75 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.debiantesting_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "debian/testing64" 16 | 17 | # Disable automatic box update checking. If you disable this, then 18 | # boxes will only be checked for updates when the user runs 19 | # `vagrant box outdated`. This is not recommended. 20 | # config.vm.box_check_update = false 21 | 22 | # Create a forwarded port mapping which allows access to a specific port 23 | # within the machine from a port on the host machine. In the example below, 24 | # accessing "localhost:8080" will access port 80 on the guest machine. 25 | # NOTE: This will enable public access to the opened port 26 | # config.vm.network "forwarded_port", guest: 80, host: 8080 27 | 28 | # Create a forwarded port mapping which allows access to a specific port 29 | # within the machine from a port on the host machine and only allow access 30 | # via 127.0.0.1 to disable public access 31 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 32 | 33 | # Create a private network, which allows host-only access to the machine 34 | # using a specific IP. 35 | # config.vm.network "private_network", ip: "192.168.33.10" 36 | 37 | # Create a public network, which generally matched to bridged network. 38 | # Bridged networks make the machine appear as another physical device on 39 | # your network. 40 | # config.vm.network "public_network" 41 | 42 | # Share an additional folder to the guest VM. The first argument is 43 | # the path on the host to the actual folder. The second argument is 44 | # the path on the guest to mount the folder. And the optional third 45 | # argument is a set of non-required options. 46 | # config.vm.synced_folder "../data", "/vagrant_data" 47 | 48 | # Provider-specific configuration so you can fine-tune various 49 | # backing providers for Vagrant. These expose provider-specific options. 50 | # Example for VirtualBox: 51 | # 52 | config.vm.provider "virtualbox" do |vb| 53 | # Display the VirtualBox GUI when booting the machine 54 | vb.gui = false 55 | 56 | # Customize the amount of memory on the VM: 57 | vb.memory = "2048" 58 | end 59 | 60 | # View the documentation for the provider you are using for more 61 | # information on available options. 62 | 63 | # Enable provisioning with a shell script. Additional provisioners such as 64 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 65 | # documentation for more information about their specific syntax and use. 66 | 67 | # execute ansible on guest directly, most accurate for end user usage replication 68 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 69 | apt-get update && apt-get install -y git ansible 70 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 71 | cd ansible-tidalcycles/ 72 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 73 | SHELL 74 | end 75 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.ubuntu2404_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "luminositylabsllc/ubuntu-24.04" 16 | 17 | # Disable automatic box update checking. If you disable this, then 18 | # boxes will only be checked for updates when the user runs 19 | # `vagrant box outdated`. This is not recommended. 20 | # config.vm.box_check_update = false 21 | 22 | # Create a forwarded port mapping which allows access to a specific port 23 | # within the machine from a port on the host machine. In the example below, 24 | # accessing "localhost:8080" will access port 80 on the guest machine. 25 | # NOTE: This will enable public access to the opened port 26 | # config.vm.network "forwarded_port", guest: 80, host: 8080 27 | 28 | # Create a forwarded port mapping which allows access to a specific port 29 | # within the machine from a port on the host machine and only allow access 30 | # via 127.0.0.1 to disable public access 31 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 32 | 33 | # Create a private network, which allows host-only access to the machine 34 | # using a specific IP. 35 | # config.vm.network "private_network", ip: "192.168.33.10" 36 | 37 | # Create a public network, which generally matched to bridged network. 38 | # Bridged networks make the machine appear as another physical device on 39 | # your network. 40 | # config.vm.network "public_network" 41 | 42 | # Share an additional folder to the guest VM. The first argument is 43 | # the path on the host to the actual folder. The second argument is 44 | # the path on the guest to mount the folder. And the optional third 45 | # argument is a set of non-required options. 46 | # config.vm.synced_folder "../data", "/vagrant_data" 47 | 48 | # Provider-specific configuration so you can fine-tune various 49 | # backing providers for Vagrant. These expose provider-specific options. 50 | # Example for VirtualBox: 51 | # 52 | config.vm.provider "virtualbox" do |vb| 53 | # Display the VirtualBox GUI when booting the machine 54 | vb.gui = false 55 | 56 | # Customize the amount of memory on the VM: 57 | vb.memory = "2048" 58 | end 59 | 60 | # View the documentation for the provider you are using for more 61 | # information on available options. 62 | 63 | # Enable provisioning with a shell script. Additional provisioners such as 64 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 65 | # documentation for more information about their specific syntax and use. 66 | 67 | # execute ansible on guest directly, most accurate for end user usage replication 68 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 69 | apt-get update && apt-get install -y git ansible 70 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 71 | cd ansible-tidalcycles/ 72 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 73 | SHELL 74 | end 75 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile.debian12_64: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | # All Vagrant configuration is done below. The "2" in Vagrant.configure 5 | # configures the configuration version (we support older styles for 6 | # backwards compatibility). Please don't change it unless you know what 7 | # you're doing. 8 | Vagrant.configure("2") do |config| 9 | # The most common configuration options are documented and commented below. 10 | # For a complete reference, please see the online documentation at 11 | # https://docs.vagrantup.com. 12 | 13 | # Every Vagrant development environment requires a box. You can search for 14 | # boxes at https://vagrantcloud.com/search. 15 | config.vm.box = "debian/bookworm64" 16 | config.vm.box_version = "12.20240814.1" 17 | 18 | # Disable automatic box update checking. If you disable this, then 19 | # boxes will only be checked for updates when the user runs 20 | # `vagrant box outdated`. This is not recommended. 21 | # config.vm.box_check_update = false 22 | 23 | # Create a forwarded port mapping which allows access to a specific port 24 | # within the machine from a port on the host machine. In the example below, 25 | # accessing "localhost:8080" will access port 80 on the guest machine. 26 | # NOTE: This will enable public access to the opened port 27 | # config.vm.network "forwarded_port", guest: 80, host: 8080 28 | 29 | # Create a forwarded port mapping which allows access to a specific port 30 | # within the machine from a port on the host machine and only allow access 31 | # via 127.0.0.1 to disable public access 32 | # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" 33 | 34 | # Create a private network, which allows host-only access to the machine 35 | # using a specific IP. 36 | # config.vm.network "private_network", ip: "192.168.33.10" 37 | 38 | # Create a public network, which generally matched to bridged network. 39 | # Bridged networks make the machine appear as another physical device on 40 | # your network. 41 | # config.vm.network "public_network" 42 | 43 | # Share an additional folder to the guest VM. The first argument is 44 | # the path on the host to the actual folder. The second argument is 45 | # the path on the guest to mount the folder. And the optional third 46 | # argument is a set of non-required options. 47 | # config.vm.synced_folder "../data", "/vagrant_data" 48 | 49 | # Provider-specific configuration so you can fine-tune various 50 | # backing providers for Vagrant. These expose provider-specific options. 51 | # Example for VirtualBox: 52 | # 53 | config.vm.provider "virtualbox" do |vb| 54 | # Display the VirtualBox GUI when booting the machine 55 | vb.gui = false 56 | 57 | # Customize the amount of memory on the VM: 58 | vb.memory = "2048" 59 | end 60 | 61 | # View the documentation for the provider you are using for more 62 | # information on available options. 63 | 64 | # Enable provisioning with a shell script. Additional provisioners such as 65 | # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the 66 | # documentation for more information about their specific syntax and use. 67 | 68 | # execute ansible on guest directly, most accurate for end user usage replication 69 | config.vm.provision "tidal", type:'shell', inline: <<-SHELL 70 | apt-get update && apt-get install -y git ansible 71 | [ -d ${HOME}/ansible-tidalcycles ] || git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 72 | cd ansible-tidalcycles/ 73 | ansible-playbook --connection=local -i localhost, .test_tidal_all_roles.play.yml 74 | SHELL 75 | end 76 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # simplify installation of tidalcycles and editor(s) with ansible 2 | ansible playbooks for installing the [Tidal Cycles](https://tidalcycles.org) live coding environment with a single command, supporting multiple editors commonly used with Tidal. 3 | 4 | Common Tidal-related modifications to the SuperCollider `startup.scd` are also supported, see `vars/all.yml` below 5 | 6 | ## NOTE: if you are upgrading from Tidal <= 1.8.1 7 | `tidal 1.9.0` (and later) brings some big changes in the cabal package handling, working best with `cabal >= 3.0.0.0` and a different install command. 8 | 9 | ***You need to*** move/delete `~/.ghc` and `~/.cabal` directories, ie completely reset your haskell package environment. 10 | 11 | I have now added a [`remove`](./README.md#removal) function to this tool which can setup a clean tidal slate for you 12 | 13 | # supported distros 14 | - ubuntu 24.04, 22.04, 20.04 (and derivatives ie studio kubuntu lubuntu xubuntu etc) 15 | - debian 12, 11 16 | - Linux Mint 22, 21 17 | - ansible >= 2.5 18 | 19 | ### probably also works 20 | - any other debian based distribution with `cabal >= 3.0.0.0` available 21 | - debian 10, Linux Mint 20 22 | 23 | Unsupported: 24 | - non-linux environments 25 | - Archlinux/Manjaro (some attempts were made, please check the [arch_support branch](https://github.com/cleary/ansible-tidalcycles/tree/arch_support)) 26 | - other non-debian based linux distributions (patches welcome!) 27 | - `feedforward` is [no longer receiving maintenance](https://github.com/yaxu/feedforward/issues/37#issuecomment-1266558317), I recommend following progress on **text.management** which has similar goals/features 28 | 29 | # usage: 30 | 31 | ## initial installation 32 | 33 | This repository uses git-submodules for roles, so the following clone command is required: 34 | 35 | ``` 36 | sudo apt install ansible git 37 | git clone --recurse-submodules https://github.com/cleary/ansible-tidalcycles.git 38 | cd ansible-tidalcycles/ 39 | ``` 40 | To apply the setup to a local machine, pick a playbook (please note they are not mutually exclusive - try them all out!): 41 | 42 | for **tidalcycles standalone** 43 | ``` 44 | sudo ansible-playbook --connection=local -i localhost, tidal.play.yml 45 | ``` 46 | 47 | for **tidalcycles + vscode** 48 | ``` 49 | sudo ansible-playbook --connection=local -i localhost, tidal_vscode.play.yml 50 | ``` 51 | 52 | for **tidalcycles + pulsar** (was: atom) 53 | ``` 54 | sudo ansible-playbook --connection=local -i localhost, tidal_pulsar.play.yml 55 | ``` 56 | 57 | for **tidalcycles + emacs** 58 | ``` 59 | sudo ansible-playbook --connection=local -i localhost, tidal_emacs.play.yml 60 | ``` 61 | 62 | for **tidalcycles + neovim** 63 | ``` 64 | sudo ansible-playbook --connection=local -i localhost, tidal_neovim.play.yml 65 | ``` 66 | 67 | for **tidalcycles + vim** 68 | ``` 69 | sudo ansible-playbook --connection=local -i localhost, tidal_vim.play.yml 70 | ``` 71 | 72 | for **text.management** (experimental) 73 | ``` 74 | sudo ansible-playbook --connection=local -i localhost, tidal_textmanagement.play.yml 75 | ``` 76 | 77 | ## upgrading 78 | 79 | The playbooks are designed to be run and re-run, so just run them again to get latest versions of repository packages, haskell packages, git repos etc. 80 | 81 | This repo is under active development, so grabbing the latest changes is recommended (remember the `--recurse-submodules` option): 82 | ``` 83 | git pull --recurse-submodules 84 | ``` 85 | 86 | The only minor gotcha is if you significantly modify any config files that are templated, eg `.vimrc`, `startup.scd` (please see `vars/all.yml` below), or `settings.json` (vscode) you will need to restore the backed up version (from the install directory) after running - alternatively, you can *exclude* the config writing tasks via the `config` tag: 87 | ``` 88 | sudo ansible-playbook --connection=local -i localhost, tidal.play.yml --skip-tags "config" 89 | ``` 90 | 91 | ## removal 92 | 93 | There is a very raw tool for doing removal of tidal related directories. 94 | 95 | It is useful when upgrades are failing, `cabal` isn't playing ball, or you may have used the rainbow of install commands available and be in an unknown state. 96 | 97 | It will double confirm with you before deleting anything - make sure you understand the message, consequence and have taken care of your own backups of the affected folders. 98 | 99 | ``` 100 | sudo ansible-playbook --connection=local -i localhost, tidal_remove.play.yml 101 | ``` 102 | 103 | The tool does not touch packages installed by the package manager, or editor plugins. They are up to you to deal with. 104 | 105 | # roles 106 | 107 | ## tidal 108 | Install Tidal Cycles (http://tidalcycles.org) and dependencies (SuperCollider, haskell, SuperDirt, SuperDirt-samples etc). 109 | 110 | This role automates the installation of SuperDirt, and SuperDirt samples in SuperCollider. It also writes a basic startup.scd as per [this recommendation](https://github.com/musikinformatik/SuperDirt/blob/develop/superdirt_startup.scd). 111 | 112 | If you provide a list of samples paths via the variable *custom_sample_paths* in `vars/all.yml`, these will be added to your startup.scd and loaded on SuperCollider boot. 113 | 114 | Please note, this *will* replace any existing startup.scd, but keep a backup in the same directory, to allow merge/revert. This can be excluded with `--skip-tags "config"` 115 | 116 | It will also check for a newer version of `sclang` (eg if installed from source) and skip package installation if a newer version is found 117 | 118 | This is a git submodule: https://github.com/cleary/ansible-tidalcycles-base 119 | 120 | ## vscode 121 | Install the vscode editor from microsoft, including useful plugins for Tidal Cycles and Haskell. 122 | 123 | If you provide a list of samples paths via the variable *custom_sample_paths* in `vars/all.yml`, these will be added to your settings.json for the Sound Browser in the tidalcycles plugin. 124 | 125 | Please note, this *will* replace any existing settings.json, but keep a backup in the same directory, to allow merge/revert. This can be excluded with `--skip-tags "config"` 126 | 127 | This is a git submodule: https://github.com/cleary/ansible-tidalcycles-editor-vscode 128 | 129 | ## pulsar (was: atom) 130 | Install the pulsar editor, including useful plugins for Tidal Cycles. 131 | 132 | If you provide a list of samples paths via the variable *custom_sample_paths* in `vars/all.yml`, these will be added to your config.cson for the Sound Browser in the tidalcycles plugin. 133 | 134 | This is a git submodule: https://github.com/cleary/ansible-tidalcycles-editor-pulsar 135 | 136 | ## emacs 137 | Install the emacs editor, including the tidal.el plugin for Tidal Cycles. 138 | 139 | Please note, this *will* replace any existing `~/.emacs`, but keep a backup in the same directory, to allow merge/revert. This can be excluded with `--skip-tags "config"` 140 | 141 | This is a git submodule: https://github.com/cleary/ansible-tidalcycles-editor-emacs 142 | 143 | ## neovim 144 | Install the neovim editor, including the tidal-vim plugin (sans tmux) for Tidal Cycles. 145 | 146 | Please note, this *will* replace any existing init.vim, but keep a backup in the same directory, to allow merge/revert. This can be excluded with `--skip-tags "config"` 147 | 148 | This is a git submodule: https://github.com/cleary/ansible-tidalcycles-editor-neovim 149 | 150 | ## vim 151 | Install the vim-nox editor, including the tidal-vim plugin (and dependencies) for Tidal Cycles. 152 | 153 | Please note, this *will* replace any existing .vimrc, but keep a backup in the same directory, to allow merge/revert. This can be excluded with `--skip-tags "config"` 154 | 155 | This is a git submodule: https://github.com/cleary/ansible-tidalcycles-editor-vim 156 | 157 | ## text.management 158 | Install the (currently experimental) [text.management livecode editor by Matthew Kaney](https://github.com/mindofmatthew/text.management), intended as a dedicated livecode editor, currently supporting tidalcycles out of the box. 159 | 160 | This is a git submodule: https://github.com/cleary/ansible-tidalcycles-editor-text_management 161 | 162 | ## ugens-mutable-instruments 163 | Install the open source [Mutable Instruments](https://mutable-instruments.net/) [Ugens for SuperCollider](https://github.com/v7b1/mi-UGens), configures autoloading required parameter mappings in all editors. 164 | 165 | To enable, create/edit `vars/all.yml` (see `vars/all.yml.ex` for examples), and uncomment the lines: 166 | ``` 167 | sc_ugens: 168 | - "mutable-instruments" 169 | ``` 170 | 171 | - For available Synths, have a look at the [SynthDef](https://raw.githubusercontent.com/cleary/ansible-tidalcycles-synth-mi-ugens/master/files/mutable-instruments-synthdefs.scd) 172 | - For available options and effects, check out the [parameters.hs](https://raw.githubusercontent.com/cleary/ansible-tidalcycles-synth-mi-ugens/master/files/mutable-instruments-ugens_parameters.hs) 173 | 174 | This is a git submodule: https://github.com/cleary/ansible-tidalcycles-synth-mi-ugens 175 | 176 | # vars 177 | 178 | ## all.yml.ex 179 | Support for various custom config attributes can be provided by copying this file to `vars/all.yml` and uncommenting. A summary of options: 180 | - add a list of paths to local Samples directories, which will be picked up and included in the `startup.scd` file for supercollider, and the Sound Browsers in vscode/pulsar 181 | - source sample sets/directories from git repositories (curated examples provided) 182 | - `startup.scd` defaults can be modified here, including `sc.numOutputBusChannels` commonly used for splitting audio outputs to a DAW 183 | - MIDI clients can be defined with a simple syntax, which then generates the needed entries in `startup.scd` 184 | 185 | It is possible to use ansible tags to *only* update the configs (eg if you add a new Sample dir to `vars/all.yml`): 186 | ``` 187 | sudo ansible-playbook --connection=local -i localhost, tidal_vscode.play.yml --tags "config" 188 | ``` 189 | 190 | # vagrant 191 | 192 | Vagrant config files for testing our supported distros. Provisions each of the playbooks against a vagrant box (virtualbox provider) running the specified distro. 193 | 194 | See vagrant/README.md for usage 195 | 196 | # todo 197 | * investigate `$ QT_QPA_PLATFORM=offscreen sclang` for starting sc instead of virt display 198 | * add vars for loading custom .hs files to boottidal.hs 199 | * add vars for loading custom .scd files to startup.scd 200 | * add custom synthdefs to vars 201 | * piv4 support `cabal install tidal --lib --ghc-options=-opta-march=armv8.4a` ref jarm@discord 202 | * sc load more file extensions 203 | * sc change recordings dir 204 | * investigate custom quarks 205 | 206 | # notes to self: 207 | * `git pull --recurse-submodules` 208 | * `git submodule update --remote [--merge]` 209 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------