{"id":20649920,"url":"https://github.com/micartey/viro","last_synced_at":"2025-03-09T20:32:16.915Z","repository":{"id":37569591,"uuid":"384070503","full_name":"micartey/viro","owner":"micartey","description":"A Java doodle application","archived":false,"fork":false,"pushed_at":"2024-04-04T15:06:39.000Z","size":114474,"stargazers_count":1,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-17T10:21:04.343Z","etag":null,"topics":["doodle","drawing","education","graphics","java","overlay","paint","paint-application","painting"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/micartey.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-07-08T09:25:02.000Z","updated_at":"2024-03-25T20:21:17.000Z","dependencies_parsed_at":"2024-03-25T20:49:31.256Z","dependency_job_id":null,"html_url":"https://github.com/micartey/viro","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micartey%2Fviro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micartey%2Fviro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micartey%2Fviro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micartey%2Fviro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/micartey","download_url":"https://codeload.github.com/micartey/viro/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242750532,"owners_count":20179249,"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":["doodle","drawing","education","graphics","java","overlay","paint","paint-application","painting"],"created_at":"2024-11-16T17:17:05.109Z","updated_at":"2025-03-09T20:32:16.895Z","avatar_url":"https://github.com/micartey.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# viro\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.oracle.com/java/\" target=\"_blank\"\u003e\n    \u003cimg\n      src=\"https://img.shields.io/badge/Written%20in-java-%23EF4041?style=for-the-badge\"\n      height=\"30\"\n    /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/micartey/viro/actions/workflows/maven-build-and-release.yml\" target=\"_blank\"\u003e\n    \u003cimg\n      src=\"https://img.shields.io/badge/actions-build-%27a147?style=for-the-badge\"\n      height=\"30\"\n    /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#-introduction\"\u003eIntroduction\u003c/a\u003e •\n  \u003ca href=\"#-getting-started\"\u003eGetting Started\u003c/a\u003e •\n  \u003ca href=\"https://github.com/micartey/viro/issues\"\u003eTroubleshooting\u003c/a\u003e\n\u003c/p\u003e\n\n## 📚 Introduction\n\nviro is a java overlay doodle application meant to quickly draw and highlight things in screen sharings or recordings.\nIt is implemented in JavaFx and builds on the Spring Boot framework.\n\n![](images/preview.png)\n\n### Architecture\n\nDue to scalability and ease of development, an event-based architecture is being used.\nMost parts are covered by the build-in event system of Spring Boot, some other parts are covered\nby [jation](https://github.com/micartey/jation).\njation is being used to only execute events for the current selected brush.\nIt provides a possibility to add a filter before invoking a method, which checks if the brush is the selected brush.\nThe code can be\nfound [here](https://github.com/micartey/viro/blob/1a8fa0810a2b03d8fedd1727def66c3e9a417cc9/src/main/java/me/micartey/viro/input/MouseObserver.java#L49-L62).\n\n### Development\n\n*(Writing this for future me in order to not spend an entire evening to get this up and running)*\n\n1. Create a `.sdk` folder\n2. Download a [javafx-sdk](https://gluonhq.com/products/javafx/) and extract it into the `.sdk` folder.\n   The resulting structure should be: `.sdk/\u003cyour-fx-sdk\u003e/lib`\n3. Edit the Run configuration in your ide and add the following JVM flag\n\n```\n--module-path ./.sdk/\u003cyour-fx-sdk\u003e/lib --add-modules javafx.controls,javafx.fxml,javafx.graphics\n```\n\n4. Build the application with Maven. Make sure to skip tests\n\n```shell\nmvn package -B -DskipTests=true -f pom.xml\n```\n\n## Getting Started\n\nGo to the [releases](https://github.com/micartey/viro/releases) and download the newest version of viro.\nThis can either be a commit or the latest stable version.\nAs both should work you can choose for yourself.\n\nYou also need to have a Java version newer or equal to Java 17.\n\n### Shortcuts\n\nThere are some shortcuts you can use.\nThey are currently not configurable, but will be in the feature.\nAt the moment, the following shortcuts are pre-defined and static:\n\n\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n| Shortcut         | Name         | Description                       |\n|------------------|--------------|-----------------------------------|\n| CTRL + Z         | Undo         | Remove shape                      |\n| CTRL + Y         | Redo         | Recreate removed shape            |\n| CTRL + SHIFT + I | Import Image | Import a png / jpg into the scene | \n\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicartey%2Fviro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicartey%2Fviro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicartey%2Fviro/lists"}