HypeDyn

HypeDyn (pronounced "hyped in") is a procedural hypertext fiction authoring tool for people who want to create text-based interactive stories that adapt to reader choice.

This project is split into several modules:

• api - The API that the other modules and plugins use to communicate
• core - The backend of the system, handling things such as data structure management, serialisation, etc.
• default-story-viewer - A plugin that is the default implementation for visualising a HypeDyn story
• ui - The UI of the system, including the main entry point into the application

System Requirements

• Java 8u141 or later
• Gradle >= 4.01
  • If using a local Gradle version and not the included Gradle wrapper

Installation

The latest stable installers can be found at http://www.narrativeandplay.org/hypedyn/.

Gradle is used as the build tool for this project; more information about Gradle can be found at its website.

To run the source version (if you cloned it from this repo), run the following command in a terminal:

./gradlew run

On Windows, gradlew may need to be replaced with gradlew.bat.

To execute the tests, run ./gradlew test.

Building packages

To build the binary packages, run ./gradlew build in a terminal.

The Gradle JavaFX plugin used in the project will by default build all appropriate packages for the system it is being built on. The built packages will be found in build/distributions. On all platforms, a base package containing an executable and all the required files will be built in a build/distributions/HypeDyn2 folder.

On Windows, if Inno Setup 5 or later is installed and available on the PATH, an installable exe will be created (details here for how to correctly place the path onto the PATH variable). Also, if the WiX toolset is available, MSI installers will be built.

On OS X, this will also build DMG and pkg files automatically.

On Linux, if the required build tools are present (RPMBuild and/or deb packaging tools), the appropriate package will be built.

More details on the packaging process can be found here.

Contributing

This project follows standard gitflow conventions, with the only deviation from standard conventions being that the develop branch is named development instead.

All code contributions must follow the code style as set out in the style guide

License

Copyright © 2015-2019 National University of Singapore

Licensed under the GNU General Public License v3. See LICENSE for details.