{"id":16753443,"url":"https://github.com/thbar/opaz-plugdk","last_synced_at":"2025-03-21T22:32:16.946Z","repository":{"id":568364,"uuid":"199764","full_name":"thbar/opaz-plugdk","owner":"thbar","description":"Implement your VST plugins with JRuby, Mirah, Java and JavaFX","archived":false,"fork":false,"pushed_at":"2012-09-08T22:18:59.000Z","size":58302,"stargazers_count":71,"open_issues_count":4,"forks_count":9,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-18T05:51:17.456Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thbar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2009-05-13T12:30:42.000Z","updated_at":"2025-01-10T10:32:52.000Z","dependencies_parsed_at":"2022-07-16T14:47:20.062Z","dependency_job_id":null,"html_url":"https://github.com/thbar/opaz-plugdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thbar%2Fopaz-plugdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thbar%2Fopaz-plugdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thbar%2Fopaz-plugdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thbar%2Fopaz-plugdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thbar","download_url":"https://codeload.github.com/thbar/opaz-plugdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244880449,"owners_count":20525507,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T02:50:08.862Z","updated_at":"2025-03-21T22:32:15.669Z","avatar_url":"https://github.com/thbar.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://secure.travis-ci.org/thbar/opaz-plugdk.png)](http://travis-ci.org/thbar/opaz-plugdk)\n\nWHAT'S THERE ?\n--------------\n\nOpaz-PlugDK makes it easier/faster to create portable (Mac OS X, Windows, Linux) VST 2 plugins.\n\nYou can mix and match JRuby, Duby and Java to implement the plugins.\n\nQUICK COURSE\n------------\n\n* [Blog post by Thibaut](http://blog.logeek.fr/2009/11/17/how-to-prototype-vst-audio-plugins-with-jruby-and-java)\n* [Screencast by Daniel309](http://www.vimeo.com/8654173)\n\nAVAILABLE EXAMPLES\n------------------\n\nThe examples are under the plugins folder:\n\n* DubyGain, DubyFilta and DubyFreeComp are reflecting our current work trend, ie: mix JRuby (for declarative stuff) and Duby (for computation)\n* HybridGain, HybridFilta and HybridSynth mix JRuby (for declarative stuff) and Java (for computation)\n* RubyDelay, RubyFreeComp and RubyGain are pure JRuby version\n\nDEPENDENCIES\n------------\n\nRequired:\n\n* Java JDK (tested with version 1.6+) - the JRE is not sufficient\n* JRuby (tested with version 1.6.7)\n\nOptional:\n\n* Mirah: jgem install mirah (or on Windows: jruby -S gem install mirah)\n* JavaFX: install the JavaFX SDK 1.2.3\n\nHOW TO BUILD A PLUGIN\n---------------------\n\nSee under plugins/ then use the available rake tasks to package one of them:\n\n\trake -f build.rakefile package plugin=DubyFreeComp\n  \nThe package system will create ready-to-use VST for Windows, Mac OS X and Linux under the build subfolder of the plugin.\n\nBUILD ORDER\n===========\n\nThings are currently compiled in this order:\n\n* src/* (Opaz stuff)\n* your_plugin/*.duby\n* your_plugin/*.java\n* your_plugin/*.fx\n\nPLUGINS STATUS\n==============\n\nAll the plugins compile and are able to be loaded in Ableton Live, except the Ruby based ones (temporary issue).\n\nGUI SUPPORT\n-----------\n\nBasic GUI support is included. Example:\n\n\tclass MyEditor\n\t\tdef initialize(frame)\n\t\t\tframe.setTitle(\"Hello from DefaultEditor!\")\n\t\t\tframe.setSize(400, 300)\n\t\tend\n\tend\n\t\n\tclass MyPlugin \u003c OpazPlug\n\t\tplugin \"MyPlugin\", \"Opaz\", \"LoGeek\"\n\t\t# ...\n\t\t\n\t\teditor MyEditor\n\tend\n\t\nYou'll be passed the main container frame so that you can add stuff in it.\n\nLIVE DEBUGGING\n--------------\n\nThanks to Daniel309, it's possible to enable live plugin patching through an IRB session.\n\nTweak tasks/tools.rb around line 90 to enable the IRB debugging editor:\n\n\tPluginUIClass=IRBPluginGUI\n\nLOGGING\n-------\n\nIt's often useful to log some informations while creating plugins. You can achieve this by calling \"log\" from the plugin:\n\n\tclass MyPlugin \u003c OpazPlug\n\t\tdef some_stuff\n\t\t\tlog(\"message!\")\n\t\tend\n\tend\n\nThe logs end up inside some txt file in the plugin folder.\n\nNOTES\n-----\n\nThe libs and templates folders are generated using rake prepare:templates and rake prepare:libs. Have a look at the rake file to see more about available tasks (compile, package, deploy).\n\nAUTHORS AND CONTRIBUTORS\n------------------------\n\n* [Thibaut Barrère](http://twitter.com/thibaut_barrere) and Daniel309 (author of [jVSTwRapper](http://jvstwrapper.sourceforge.net/)) for the whole thing\n* [Robert Pitts](http://github.com/rbxbx) for his test clean-up patch\n* Big thanks to Charles Oliver Nutter for his help on JRuby/Duby!\n* Thanks as well to JFXtras for their implementation of SceneToJComponent.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthbar%2Fopaz-plugdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthbar%2Fopaz-plugdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthbar%2Fopaz-plugdk/lists"}