JarCastingCaustic 
Simple, general purpose rendering API with an LWJGL implementation and utilities.
Getting Started
Source Code
The latest and greatest source can be found here on GitHub. If you are using Git, use this command to clone the project:
git clone git://github.com/flow/caustic.git
Or download the latest development archive or the latest stable archive.
Dependencies
We love open-source libraries! This project uses are few of them to make things easier. If you aren't using Maven or Gradle, you'll need these!
- com.flowpowered:flow-math
- net.sf.trove4j:trove4j
- org.lwjgl.lwjgl:lwjgl (cautic-lwjgl only)
- org.lwjgl.lwjgl:lwjgl_util (cautic-lwjgl only)
Test Dependencies
The following dependencies are only needed if you compiling the tests included with this project. Gotta test 'em all!
Building from Source
This project can be built with the latest Java Development Kit and Maven or Gradle. Maven and Gradle are used to simplify dependency management, but using either of them is optional.
For Maven, the command mvn clean package will build the project and will put the compiled JAR in target, and mvn clean install will copy it to your local Maven repository.
For Gradle, the command gradlew will build the project and will put the compiled JAR in ~/build/distributions, and gradlew install will copy it to your local Maven repository.
Contributing
Are you a talented programmer looking to contribute some code? We'd love the help!
- Open a pull request with your changes, following our guidelines and coding standards.
- Please follow the above guidelines for your pull request(s) accepted.
- For help setting up the project, keep reading!
Love the project? Feel free to donate to help continue development! Flow projects are open-source and powered by community members, like yourself. Without you, we wouldn't be here today!
Don't forget to watch and star our repo to keep up-to-date with the latest Flow development!
Usage
If you're using Maven to manage project dependencies, simply include the following in your pom.xml file:
<dependency>
<groupId>com.flowpowered</groupId>
<artifactId>caustic</artifactId>
<version>1.0.1-SNAPSHOT</version>
</dependency>
If you're using Gradle to manage project dependencies, simply include the following in your build.gradle file:
repositories {
mavenCentral()
}
dependencies {
compile 'com.flowpowered:caustic:1.0.1-SNAPSHOT'
}
If you plan on using snapshots and do not already have the snapshot repo in your repository list, you will need to add this as well:
https://oss.sonatype.org/content/groups/public/
If you'd prefer to manually import the latest .jar file, you can get it here.
Documentation
Want to get friendly with the project and put it to good use? Check out the latest Javadocs.
To generate Javadocs with Maven, use the mvn javadoc:javadoc command. To view the Javadocs simply go to target/site/apidocs/ and open index.html in a web browser.
To generate Javadocs with Gradle, use the gradlew javadoc command. To view the Javadocs simply go to build/docs/javadoc/ and open index.html in a web browser.
Version Control
We've adopted the git flow branching model in our projects. The creators of git flow released a short intro video to explain the model.
The master branch is production-ready and contains the latest tagged releases. Before a release is made, it is stagged in release/x branches before being pushed and tagged in the master branch. Small patches from hotfix/x branches are also pushed to master, and will always have a release version. The develop branch is pre-production, and is where we push feature/x branches for testing.
Legal Stuff
Caustic is licensed under the MIT License. Basically, you can do whatever you want as long as you include the original copyright. Please see the LICENSE.txt file for details.
