stephengold/VhacdTuner

VhacdTuner is a GUI application
to tune the V-HACD algorithm for a specific 3-D mesh.

Complete source code (in Java) is provided under
a 3-clause BSD license.

VhacdTuner was designed for a desktop environment with:

• a wheel mouse and
• a display at least 640 pixels wide and 700 pixels tall.

Contents of this document

• How to build and run VhacdTuner from source
• Using VhacdTuner
• Conventions
• External links
• History
• Acknowledgments

How to build and run VhacdTuner from source

1. Install a 64-bit Java Development Kit (JDK),
   version 21 or higher,
   if you don't already have one.
2. Point the JAVA_HOME environment variable to your JDK installation:
   (In other words, set it to the path of a directory/folder
   containing a "bin" that contains a Java executable.
   That path might look something like
   "C:\Program Files\Eclipse Adoptium\jdk-21.0.3.7-hotspot"
   or "/usr/lib/jvm/java-21-openjdk-amd64/" or
   "/Library/Java/JavaVirtualMachines/zulu-21.jdk/Contents/Home" .)

• using Bash or Zsh: export JAVA_HOME=" path to installation "
• using Fish: set -g JAVA_HOME " path to installation "
• using Windows Command Prompt: set JAVA_HOME=" path to installation "
• using PowerShell: $env:JAVA_HOME = ' path to installation '

3. Download and extract the More Advanced Vehicles source code from GitHub:

• using Git:
  • git clone https://github.com/stephengold/VhacdTuner.git
  • cd VhacdTuner

4. Run the Gradle wrapper:

• using Bash or Fish or PowerShell or Zsh: ./gradlew run
• using Windows Command Prompt: .\gradlew run

You can restore the project to a pristine state:

• using Bash or Fish or PowerShell or Zsh: ./gradlew clean
• using Windows Command Prompt: .\gradlew clean

Jump to the table of contents

Using VhacdTuner

(Documentation not yet written.)

Jump to the table of contents

Conventions

The source code and pre-built executables are compatible with JDK 8.

Jump to the table of contents

External links

• V-HACD v4 slideshow

YouTube videos about VhacdTuner:

• August 2022 walkthru of the VhacdTuner application
  watch (7:45)
  source code

Jump to the table of contents

History

Some of the origial source code
was derived from the DacWizard project.

From August 2022 to June 2024, VhacdTuner was a subproject of
the Minie Project.

Since June 2024, VhacdTuner has been a separate project, hosted at
GitHub.

Jump to the table of contents

Acknowledgments

Like most projects, the VhacdTuner Project builds on the work of many who
have gone before. I therefore acknowledge the following
artists and software developers:

• Khaled Mamou for creating and licensing the V-HACD Library
  for decomposing meshes into convex hulls
• Riccardo Balbo (aka "riccardo") for creating and licensing
  the V-HACD Java Bindings Project
• plus the creators of (and contributors to) the following software:
  • the Checkstyle tool
  • the Firefox web browser
  • the Git revision-control system and GitK commit viewer
  • the GitKraken client
  • the Gradle build tool
  • the IntelliJ IDEA and NetBeans integrated development environments
  • the Java compiler, standard doclet, and runtime environment
  • jMonkeyEngine and the jME3 Software Development Kit
  • the Linux Mint operating system
  • LWJGL, the Lightweight Java Game Library
  • the Markdown document-conversion tool
  • the Meld visual merge tool
  • Microsoft Windows
  • the Nifty graphical user-interface library
  • Open Broadcaster Software Studio

I am grateful to GitHub, Sonatype,
MacStadium, YouTube, and Imgur
for providing free hosting for this project
and many other open-source projects.

I'm also grateful to my dear Holly, for keeping me sane.

If I've misattributed anything or left anyone out, please let me know, so I can
correct the situation: sgold@sonic.net

Jump to the table of contents