Skip to content

Installation Guide

Knight Hat edited this page Nov 4, 2023 · 2 revisions

Table of Contents

  1. Requirements
  2. Manual Installation
  3. Download Prebuilt

Requirements

System demands will be increased as later versions roll out, check back for changes.

  1. 2-core processor. (Single core processor may work but will experience hiccups)
  2. 256MB of RAM.
  3. JRE 17 or higher. [DOWNLOAD HERE]
  4. Windows, Linux, MacOS.

Manual Installation

This section will walk you through how to download & compile the code.
This project is operated using Maven. Therefore, you need MAVEN (version 3.8 or higher) to compile the source code.

  1. Download an appropriate version that is compatible with your machine from the link above.
  2. Follow the instruction from maven's readme.
  3. Clone this repo:
    • Development branch: git clone --depth 1 https://github.com/knighthat/InteractiveDeck-Desktop
    • Release (latest): git clone --depth 1 https://github.com/knighthat/InteractiveDeck-Desktop/tree/latest
  4. Go to source directory: cd InteractiveDeck-Desktop
  5. Compile source with: mvn validate test package
    • validate command is optional.
    • test command is optional (Source code is tested on branch latest, but untested on development).
  6. Compiled JAR file will be located inside target/ folder.

Download Prebuilt

Project is still in beta version, it is marked release because it met certain requirements, not because it is stable.

The latest release can be found HERE.

If you prefer the truly latest version (bleeding edge/experimental features).
Please follow Manual Installation steps to compile code from development branch.

Clone this wiki locally