Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codedead/opal
Plays relaxing music in the background
https://github.com/codedead/opal
atlantafx gradle java java20 javafx javafx-application javafx-desktop-apps javafx-gui javafx22 jdk22 jfx jfx22 jlink jre22 music musicplayer openjfx relax relaxation
Last synced: about 1 month ago
JSON representation
Plays relaxing music in the background
- Host: GitHub
- URL: https://github.com/codedead/opal
- Owner: CodeDead
- License: gpl-3.0
- Created: 2020-12-23T04:10:42.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-16T19:08:14.000Z (4 months ago)
- Last Synced: 2024-10-12T18:24:07.006Z (about 1 month ago)
- Topics: atlantafx, gradle, java, java20, javafx, javafx-application, javafx-desktop-apps, javafx-gui, javafx22, jdk22, jfx, jfx22, jlink, jre22, music, musicplayer, openjfx, relax, relaxation
- Language: Java
- Homepage: https://codedead.com
- Size: 62.8 MB
- Stars: 57
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Opal
[](https://github.com/CodeDead/opal/actions/workflows/test.yml)
Opal is a free and open-source [JavaFX](https://openjfx.io/) application that can play relaxing music in the background.
## Building
### Windows
#### Installer
You can create an executable installer by running the `jpackage` Gradle task on a Windows host:
```shell
./gradlew jpackage
```
*Do note that you will need the [WiX Toolset](https://wixtoolset.org/) in order to create `msi` packages.*
#### Portable image
You can create a portable image by running the `jpackageImage` Gradle task on a Windows host:
```shell
./gradlew jpackageImage
```
### Linux
#### rpm
You can create an `rpm`, by running the `jpackage` Gradle task on a Linux host:
```shell
./gradlew jpackage
```
*Do note that you will need the `rpm-build` package in order to create an `rpm`.*
#### AppImage
You can create an [AppImage](https://appimage.github.io/) by executing the `AppImage` Gradle task on a Linux host:
```shell
./gradlew AppImage
```
*Do note that running this task will execute a shell script in order to download and run the [appimagetool](https://appimage.github.io/appimagetool/) in order to create the `AppImage` file.*
#### Portable image
You can create a portable image by running the `jpackageImage` Gradle task on a Linux host:
```shell
./gradlew jpackageImage
```
### macOS
#### dmg
You can create a `dmg`, by running the `jpackage` Gradle task on a macOS host:
```shell
./gradlew jpackage
```
#### Portable image
You can create a portable image by running the `jpackageImage` Gradle task on a macOS host:
```shell
./gradlew jpackageImage
```
## Dependencies
A couple of dependencies are required in order to build Opal. Some of which require a specific host machine,
especially if you're targeting a specific platform and installation method.
The following dependencies are universal:
* [JDK21](https://openjdk.java.net/projects/jdk/21/)
* [JavaFX](https://openjfx.io)
* [Gradle](https://gradle.org)
* [FasterXML/jackson](https://github.com/FasterXML/jackson)
* [badass-jlink-plugin](https://github.com/beryx/badass-jlink-plugin)
* [Log4j2](https://logging.apache.org/log4j/2.x/)
* [AtlantaFX](https://github.com/mkpaz/atlantafx)
### Windows
#### MSI
In order to build an installer (*MSI*) of Opal on Windows, you will need:
* [WiX Toolset](https://wixtoolset.org)
### Linux
#### rpm
In order to create an [RPM](https://en.wikipedia.org/wiki/RPM_Package_Manager), you will need to have the following package(s) installed:
* rpm-build (`dnf install rpm-build`)
## Credits
### Audio
All audio files have been provided by [ZapSplat](https://zapsplat.com).
### Images
All images have been provided by [Remix Icon](https://remixicon.com/).
## About
This library is maintained by CodeDead. You can find more about us using the following links:
* [Website](https://codedead.com)
* [Twitter](https://twitter.com/C0DEDEAD)
* [Facebook](https://facebook.com/deadlinecodedead)
* [Reddit](https://reddit.com/r/CodeDead)
* [ X ](https://x.com/C0DEDEAD)
Copyright © 2024 CodeDead