Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/redragonx/tesseract-java

http://en.wikipedia.org/wiki/Tesseract
https://github.com/redragonx/tesseract-java

Last synced: 13 days ago
JSON representation

http://en.wikipedia.org/wiki/Tesseract

Awesome Lists containing this project

README

        

Tesseract
=========
A 3D rendering of a 4D object called a tesseract using Java OpenGL.

Navigation
-----------
[Tesseract](#tesseract) |
[Purpose](#purpose) |
[Screenshot](#screenshot) |
[Team](#team) |
[Configuration](#configuration) |
[JAR and Natives Configuration](#JAR and Natives Configuration) |
[Folder Structure](#Folder Structure) |
[Running the program](#running the program) |
[License](#license) |
[TODO](#todo)

Purpose
-------
This project aims to create an animated 3D rendering of a 4D cube known as a tesseract. We are using Java's LWJGL library and OpenGL to make the animation, and Gradle/Groovy as a build tools to make the JAR, automate testing, and to link required resources and natives. So, we're kind of doing 4 things here.

Screenshot
----------
![Picture](https://dicesoft.net/publicDownloads/tesseract/tesseract2.jpg)

Final result may look like this below.

![Picture](http://rabbitfighter.net/wp-content/uploads/2014/12/tesseract.jpg)

Team
----------------

Configuration
==============================
This program requires the lwjgl vers 3.0.0a JAR file as well as natives for Windows, Linux, and OSX. As per our Gradle build program, these files must be obtained and put into the correct folders in the project structure or you will be an unhappy camper, and the program will fail. So the following steps are necessary:

JAR and Natives Configuration
-----------------------------


  1. Obtain the LWJGL zip file from: http://www.lwjgl.org/download and extract the files somewhere.

  2. Create a folder in the main directory of the project called libs/

  3. Create a subfolder in the libs/ folder called jar/

  4. Move the native folder from wherever you extracted the lwjgl.zip folder and rename it to natives, and then move the whole folder into the libs/ folder in the project.

  5. Then copy the lwjgl.jar from the exttracted files and move it into the libs/jar/ folder in the project. You must then rename it lwjgl3.jar.

Folder Structure
----------------


.
├── build.gradle
├── libs
│   ├── jar
│   │   └── lwjgl3.jar
│   └── natives
│   ├── linux
│   ├── macosx
│   └── windows
├── LICENSE
├── README.md
├── src
│   └── main
│   └── java

9 directories, 5 files

This should be your folder structure before running any commands.

Running the Program
-------------------


  1. If gradle is not installed, install it. Then from the project directory, run gradle build.

  2. Run the program by typing gradle runJar

The program should run now. Yay!

Liscence
---------
???

TODO
----
This is a work in progress...