{"id":15559776,"url":"https://github.com/qmasingarbe/rv-plugin-boilerplate","last_synced_at":"2025-07-13T22:07:28.393Z","repository":{"id":134461771,"uuid":"257913582","full_name":"qmasingarbe/RV-plugin-boilerplate","owner":"qmasingarbe","description":"Template code and explanation to quickly start building a python plugin for RV player","archived":false,"fork":false,"pushed_at":"2020-09-02T22:29:28.000Z","size":59,"stargazers_count":16,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-09T16:56:01.405Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/qmasingarbe.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-22T13:43:26.000Z","updated_at":"2024-11-27T01:01:34.000Z","dependencies_parsed_at":"2023-08-14T07:00:20.208Z","dependency_job_id":null,"html_url":"https://github.com/qmasingarbe/RV-plugin-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/qmasingarbe/RV-plugin-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmasingarbe%2FRV-plugin-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmasingarbe%2FRV-plugin-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmasingarbe%2FRV-plugin-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmasingarbe%2FRV-plugin-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qmasingarbe","download_url":"https://codeload.github.com/qmasingarbe/RV-plugin-boilerplate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmasingarbe%2FRV-plugin-boilerplate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265212699,"owners_count":23728578,"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-02T15:57:23.190Z","updated_at":"2025-07-13T22:07:28.376Z","avatar_url":"https://github.com/qmasingarbe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RV plugin boilerplate\nThis repo aims to provide a template and some explanations for TDs wanting to quickly create a RV plugin.\n\n![Result image](./result.jpg)\n_This is the result of the start code, a Qt widget populated by paths when new sources are added (include basic menu + basic settings)_\n\n### Setup\n  - copy the content of the `code` directory of this repo to somewhere in your source code repository   \n  - create a **rvpkg** using this command `zip my_package-0.0.rvpkg PACKAGE my_code.py` (or a tool like 7zip/winRar)\n  The .rvpkg file is the proper way to install a plugin in RV, it should contain everything needed for the plugin.\n  - install the rvpkg by starting RV, going in RV \u003e Preferences... \u003e Packages \u003e Add packages...    \n  RV will show you were the package is going to be installed, keep note of this path\n  - check the `Installed` and `Load` checkboxes in the package list     \n  After restarting RV you should see the new menu\n  - to edit our plugin, we can write in the python file in the installation directory under the Python folder    \n  This avoid creating a new package and reinstalling it using the UI.\n  You have to restart RV to see any change to the .py file, I didn't find a way to reload the plugin inside RV.    \n  A simple reloadPlugin.sh script is provided in this repo to quicly reload RV with updated py for testing purposes.\n\n### Code\nThe code folder contains 2 files :\n  - PACKAGE : this file is mandatory and should be named like this, it contains a description of our plugin\n  - my_code.py : fell free to rename it, this is the actual python code\n\nAny `print` statements in the python code will be in the RV console (Window \u003e Console) or in the terminal which launched the RV process.\n\n### Ressources\n- python quickstart : https://support.shotgunsoftware.com/hc/en-us/articles/219042308-RV-Python-quickstart\n- main documentation on plugins : https://support.shotgunsoftware.com/hc/en-us/articles/360024280254-Reference-Manual\n\n### Disclaimer\nCode is provided as is, with no guaranty/support  \nIt was tested on RV 7.1.1 on win10 and RV 7.3.1 on linux","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqmasingarbe%2Frv-plugin-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqmasingarbe%2Frv-plugin-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqmasingarbe%2Frv-plugin-boilerplate/lists"}