Project icon

com.io7m.jarabica

Build status Maven Central Codecov

The jarabica package attempts to provide a type-safe, mildly object-oriented frontend to the OpenAL API. Currently, it uses the high-quality LWJGL bindings internally, and wraps them with a thin layer of short-lived immutable types for safety and efficiency. It strongly separates the API and implementation to allow for easy unit testing and mocking of code that calls OpenAL.

Contents

Features

  • Type-safe OpenAL frontend.
  • Strong separation of API and implementation to allow for switching to different bindings at compile-time
  • Strongly-typed interfaces with a heavy emphasis on immutable value types
  • Fully documented (JavaDoc)
  • Example code included
  • OSGi-ready
  • JPMS-ready
  • ISC license

Releases

The most recently published version of the software is 1.0.0.

Source code and binaries are available from the repository.

Documentation

Documentation for the 1.0.0 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

See the README for documentation.

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.jarabica</groupId>
  <artifactId>com.io7m.jarabica</artifactId>
  <version>1.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jarabica</groupId>
  <artifactId>com.io7m.jarabica.api</artifactId>
  <version>1.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jarabica</groupId>
  <artifactId>com.io7m.jarabica.tests</artifactId>
  <version>1.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jarabica</groupId>
  <artifactId>com.io7m.jarabica.lwjgl</artifactId>
  <version>1.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jarabica</groupId>
  <artifactId>com.io7m.jarabica.extensions.efx</artifactId>
  <version>1.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jarabica</groupId>
  <artifactId>com.io7m.jarabica.demo</artifactId>
  <version>1.0.0</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2024-06-01 Release: com.io7m.jarabica 1.0.0
2024-06-01 Change: Initial release.

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/jarabica

$ git clone https://www.github.com/io7m-com/jarabica

License

Copyright © 2024 Mark Raynsford <code@io7m.com> https://www.io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.