Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
micartey committed Mar 25, 2024
1 parent 5448ecd commit b1b4ab5
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 5 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@ It is implemented in JavaFx and builds on the Spring Boot framework.
### Architecture

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](https://github.com/micartey/jation).
Most parts are covered by the build-in event system of Spring Boot, some other parts are covered
by [jation](https://github.com/micartey/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](https://github.com/micartey/viro/blob/1a8fa0810a2b03d8fedd1727def66c3e9a417cc9/src/main/java/me/micartey/viro/input/MouseObserver.java#L49-L62).
The code can be
found [here](https://github.com/micartey/viro/blob/1a8fa0810a2b03d8fedd1727def66c3e9a417cc9/src/main/java/me/micartey/viro/input/MouseObserver.java#L49-L62).

### Development

Expand All @@ -46,18 +48,36 @@ The code can be found [here](https://github.com/micartey/viro/blob/1a8fa0810a2b0
2. Download a [javafx-sdk](https://gluonhq.com/products/javafx/) and extract it into the `.sdk` folder.
The resulting structure should be: `.sdk/<your-fx-sdk>/lib`
3. 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
```

4. Build the application with Maven. Make sure to skip tests

```shell
mvn package -B -DskipTests=true -f pom.xml
```

## Getting Started

Go to the [releases](https://github.com/micartey/viro/releases) and download the newest version of viro.
Go to the [releases](https://github.com/micartey/viro/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.
You also need to have a Java version newer or equal to Java 17.

### Shortcuts

There are some shortcuts you can use.
They are currently not configurable, but will be in the feature

<div align="center">

| 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 |

</div>
2 changes: 1 addition & 1 deletion src/main/java/me/micartey/viro/window/Window.java
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public Window(@Value("${application.title}") String title, @Value("${application

this.previewGraphics.setLineWidth(width);

this.stage.setAlwaysOnTop(true);
// this.stage.setAlwaysOnTop(true);
this.stage.setOnCloseRequest(Event::consume);

new IconButton(this, this.observer, settings)
Expand Down

0 comments on commit b1b4ab5

Please sign in to comment.