aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 4f966c70c074322b3865665fd4ecf652ad88dca4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# NPE Hero v2.0
One-year anniversary update!

Goals:
- [x] New integrated level editor
- [X] Custom keybindings
- [X] Accept mp3 song files
- [ ] UI improvements
- [ ] Code cleanup
- [X] Installer / Linux package

Todo - needs design:
- Improve errorList and error handling
- tweak game end
- make noteseditor2 resizeable

Todo - bugs:
- fix noteseditor1
- fix reliance on local font
- Fix notesEditor note preview being too small with no notes
- Properly center background image

# Building
### Run the app
Run the Driver class from your IDE (known to work with Intellij)

OR

Execute the maven goal javafx:run
- windows: `mvnw.cmd javafx:run`
- linux: `./mvnw javafx:run`

### Create an installer for your OS
Execute the maven package phase
- windows: `mvnw.cmd package`
- linux: `./mvnw package`

The installer executables should output to `target/dist`

# Development Links

[Figma link](https://www.figma.com/file/dpeMlWStSWrVHfLd0Uohws/Untitled?node-id=0%3A1&t=PVQi61Ig3AWtWNMm-1)

[JavaFX docs (with search)](https://openjfx.io/javadoc/15)

javafx guides (really helpful website):
[edencoding.com](https://edencoding.com/javafx-layouts/)