{"id":18562746,"url":"https://github.com/ruby-processing/propane","last_synced_at":"2025-07-10T16:09:51.298Z","repository":{"id":45115261,"uuid":"64989871","full_name":"ruby-processing/propane","owner":"ruby-processing","description":"A simpler ruby-processing for linux/Windows/MacOS?","archived":false,"fork":false,"pushed_at":"2023-03-27T22:20:21.000Z","size":6234,"stargazers_count":28,"open_issues_count":2,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-19T22:02:54.526Z","etag":null,"topics":["art","generative-art","graphics","jruby","processing","ruby","sound","video"],"latest_commit_sha":null,"homepage":"https://ruby-processing.github.io/propane","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ruby-processing.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-08-05T05:00:43.000Z","updated_at":"2024-11-17T15:37:25.000Z","dependencies_parsed_at":"2022-09-24T21:20:51.392Z","dependency_job_id":"87b7e788-4acc-4b91-ac89-b08bc235cb7d","html_url":"https://github.com/ruby-processing/propane","commit_stats":{"total_commits":381,"total_committers":3,"mean_commits":127.0,"dds":0.1076115485564304,"last_synced_commit":"41a7c3093c8e6f089ef0ae6ea9d6f9a2ebb63c3c"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/ruby-processing/propane","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby-processing%2Fpropane","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby-processing%2Fpropane/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby-processing%2Fpropane/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby-processing%2Fpropane/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruby-processing","download_url":"https://codeload.github.com/ruby-processing/propane/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruby-processing%2Fpropane/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264605016,"owners_count":23635986,"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":["art","generative-art","graphics","jruby","processing","ruby","sound","video"],"created_at":"2024-11-06T22:10:44.154Z","updated_at":"2025-07-10T16:09:51.253Z","avatar_url":"https://github.com/ruby-processing.png","language":"Java","readme":"# Propane [![Gem Version](https://badge.fury.io/rb/propane.svg)](https://badge.fury.io/rb/propane) ![Travis CI](https://travis-ci.org/ruby-processing/propane.svg)\n\nThis version is intended to work with openjdk11+.\n\nA slim layer to communicate with Processing from JRuby, features maven build. We have created a configuration free version of ruby processing, for processing-4.0+, where we include a modified processing core (`public runPropane()` to replace `protected runSketch()`. These jars are small enough to include in a gem distribution, and hence we do not require configuration. This has created a scriptable version, ie files get run direct from jruby. Currently JavaFX is unsupported. Using maven to create an automatic module, to be refined.\n\nadjust above for your OS/distro setup.\n\n## Requirements\n\nTested with OpenJDK17.\n\n- `jdk-17.01+`\n- `jruby-9.3.2.0`\n\n## Building and testing\n\n```bash\nrake\nrake gem\nrake javadoc\n```\n\n## Installation\n\n```bash\njgem install propane # from rubygems\njgem install propane-4.0.0-java.gem # local install\n# Alternative\njruby -S gem install propane # from rubygems\njruby -S gem install propane-4.0.0-java.gem # local install\n```\n\n## Check Install\nTo check version and confirm gem bin files are on your path (also checks JDK version)\n\n```bash\npropane --version\n```\n## Usage\n\nA propane sketch:-\n\n``` ruby\nrequire 'propane'\n\nclass FlashingLightsSketch \u003c Propane::App\n\n  def settings\n    size(800, 600)\n  end\n\n  def setup\n    sketch_title 'Flashing Light Sketch'\n  end\n\n  def draw\n    background(rand(255), rand(255), rand(255))\n  end\nend\n\nFlashingLightsSketch.new\n```\n\nCreate template sketches with the sketch creator tool\n\n```bash\npropane -c my_sketch 200 200 # for default renderer\npropane -c my_sketch 200 200 p2d # for opengl 2D renderer\npropane -c my_sketch 200 200 p3d # for opengl 3D renderer\n```\n\nTo run sketches\n\n```bash\njruby my_sketch.rb # or use script to run sketches from atom\n```\n\nTo install the sound and video libraries `~/.propane/libraries`. Depends on wget.\n```bash\npropane --install sound\npropane --install video\n```\n\nOther java libraries can be manually installed to the same folder (no need for processing ide)\n\nSee [gh-pages][gh-pages] for more detailed instructions and much more.\n\n## Examples\n\n[Worked Examples](https://github.com/ruby-processing/propane-examples) more to follow, feel free to add your own, especially ruby-2.5\n+ syntax now we can. To install the samples.  The samples get copied to `~/propane_samples`. Depends on wget.\n```bash\npropane --install samples\n```\n please move existing `propane_samples` if you wish to keep them. The current release features some noise sketches that exploit the new choice of noise implementation.\n\n[adopt]: https://adoptopenjdk.net/\n[building]:http://ruby-processing.github.io/building/building/\n[gh-pages]:https://ruby-processing.github.io/propane/\n[vanilla]:https://github.com/processing/processing/pull/5753\n[warning]: https://monkstone.github.io/jruby_art/update/2019/09/10/Reflective_Access.html\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruby-processing%2Fpropane","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruby-processing%2Fpropane","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruby-processing%2Fpropane/lists"}