Skip to content

Commit

Permalink
Prepare 4.3.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Hangman committed May 4, 2024
1 parent 93a61c2 commit 661f800
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</td></tr></table>

## Introduction
TuningFork is a library for [libGDX](https://github.com/libgdx/libgdx) that provides advanced audio features. The goal was to make most of the features of [OpenAL](https://github.com/kcat/openal-soft) accessible and provide a comfortable, easy to use, low overhead and object oriented high-level API. In addition, the library offers some convenience features that are needed for most games, such as the music player.<br>
TuningFork is a library for [libGDX](https://github.com/libgdx/libgdx) that provides advanced audio features. The goal was to make most of the features of [OpenAL Soft](https://github.com/kcat/openal-soft) accessible and provide a comfortable, easy to use, low overhead and object oriented high-level API. In addition, the library offers some convenience features that are needed for most games, such as the music player.<br>
Note that TuningFork is not an extension to libGDX audio but a replacement.

### Main Features
Expand All @@ -35,6 +35,7 @@ This library widens the range of supported audio formats compared to libGDX, suc
* mp3
* flac
* aiff
* [qoa](https://qoaformat.org/)

### Limitations
* Desktop only
Expand All @@ -45,14 +46,14 @@ I didn't want to make any compromises by finding the lowest common denominator b
Add TuningFork as a dependency to your project (I recommend to add it in the core project if you develop for desktop only):
[![Release](https://jitpack.io/v/Hangman/TuningFork.svg)](https://jitpack.io/#Hangman/TuningFork)
```groovy
implementation 'com.github.Hangman:TuningFork:4.2.1'
implementation 'com.github.Hangman:TuningFork:4.3.0'
```

### Compatibility
Java 8 is required, make sure to set `sourceCompatibility = JavaLanguageVersion.of(8)` (or higher) in your gradle scripts.
| Version of libGDX | Latest compatible version of TuningFork |
| :----: | :--- |
| 1.12.1 | 4.2.1 |
| 1.12.1 | 4.3.0 |
| 1.12.0 | 4.1.0 |
| 1.9.12 - 1.11.0 | 3.3.0 |
| 1.9.11 | 2.0.1 |
Expand All @@ -67,13 +68,15 @@ The wiki should provide all the information you need to get started quickly. If
[Link to the Wiki!](https://github.com/Hangman/TuningFork/wiki)

## Building From Source
To build TuningFork from source, you need a JDK >= 8 installed. Like [Adoptium JDK](https://adoptium.net/) for example.
TuningFork uses [Gradle](https://gradle.org/) as it's build tool (you don't need to have Gradle installed).
To build the library from source, you need a JDK >= 8 installed. You can grab one here: [Liberica JDK](https://bell-sw.com/pages/downloads/).
TuningFork uses [Gradle](https://gradle.org/) as it's build tool (you don't need to have Gradle installed).
<br>
This will compile the library. The resulting jar can be found under `core/build/libs/`.
```console
./gradlew build
```
Compiles the library. The resulting jar is located under `core/build/libs/`.

This will publish the core artifact to your local Maven repository.
```console
./gradlew publishToMavenLocal
```
Publishes the core artifact to your local Maven repository.

0 comments on commit 661f800

Please sign in to comment.