Introduction • Getting Started • Troubleshooting
viro is a java overlay doodle application meant to quickly draw and highlight things in screen sharings or recordings. It is implemented in JavaFx and builds on the Spring Boot framework.
Due to scalability and ease of development, an event-based architecture is being used. Most parts are covered by the build-in event system of Spring Boot, some other parts are covered by jation. jation is being used to only execute events for the current selected brush. It provides a possibility to add a filter before invoking a method, which checks if the brush is the selected brush. The code can be found here.
(Writing this for future me in order to not spend an entire evening to get this up and running)
- Create a
.sdkfolder - Download a javafx-sdk and extract it into the
.sdkfolder. The resulting structure should be:.sdk/<your-fx-sdk>/lib - Edit the Run configuration in your ide and add the following JVM flag
--module-path ./.sdk/<your-fx-sdk>/lib --add-modules javafx.controls,javafx.fxml,javafx.graphics
- Build the application with Maven. Make sure to skip tests
mvn package -B -DskipTests=true -f pom.xmlGo to the releases and download the newest version of viro. This can either be a commit or the latest stable version. As both should work you can choose for yourself.
You also need to have a Java version newer or equal to Java 17.
There are some shortcuts you can use. They are currently not configurable, but will be in the feature. At the moment, the following shortcuts are pre-defined and static:
| Shortcut | Name | Description |
|---|---|---|
| CTRL + Z | Undo | Remove shape |
| CTRL + Y | Redo | Recreate removed shape |
| CTRL + SHIFT + I | Import Image | Import a png / jpg into the scene |