Halcyon (MP4J 3.0)

Copyright (C) 2021-2022 Halcyon (MP4J) to Jack Meng

This is rework of an original project by me MP4J

This is a music player written in Java with a nice GUI to facilitate your musical
playing needs.

Notice: This is not a guide on how to use the program, instead just a simple README for the main repository. A user-guide markdown document will be created later.

Version Info

This README is updated for the version: 3.1 [For the program]
This README's constant version is 3.0 [For the iteration]

Installation

Currently there are no direct pre-compiled binary and executables that I have made
for you to simply download and run. However, you can download this project and run it from source.

Main Class: Halcyon here

Audio Framework

This program uses a heavily modified version of this framework with my own
implementations to improve performance and fit with the needs of this program. If you are going to use the framework,
you should not use the JAR from this repository. Instead, use it from here: https://github.com/exoad/SimpleAudio/releases/tag/1.0ex as there might be broken implementations that might not work from this project's inclusion of the framework.

This engine currently enables playing wav & mp3. However, soon it will allow for other types (check features

Current

Currently this program is still in development and is not yet ready for consumer usage,
with yet some missing features and bugs. (Check out BUGS & FEATURES);

However, improvements upon it's backend audio framework will be needed in order to introduce newer features to the program.

Contributing

The current state of the repository will not enable the usage of the ISSUEs tab. To contribute, like suggest a feature or report a bug, you must edit the BUGS OR FEATURES files via a pull request. I will then review it from there.

Why you may ask? It is because adding this PR only feature allows me to better look at the issues on my side without having to pull up GitHub or another
Git service every time I want to look at issues.

Legals

This program uses external libraries and framework, and their attributed licenses
can be found here.