Building Vis From Source

Paweł Pastuszak edited this page Aug 24, 2017 · 14 revisions

Prerequisites:

  • Git
  • Optionally Git LFS extension installed if you want to download raw SVG skin files
  • JDK 8

Clone repository:

git clone https://github.com/kotcrab/vis-editor vis-editor

VisUI only mode

Since VisEditor is deprecated by default only VisUI and VisUSL modules will be imported. If you want to work on other deprecated VisEditor modules you need to open settings.gradle and change visuiOnly to false.

Intellij IDEA

Intellij IDEA is recommend IDE for Vis development. This section will explain how to setup Vis development environment. Select File, New, Project from Existing Sources and then select root build.gradle file. Press OK in next window and then press OK again in module selection window.

Common problems

If you are getting errors about invalid source level press Ctrl+Shift+Alt+S to open Project Settings, go to Project tab and set project language level to 8.

Launching VisUI test application

  1. Create new Gradle run configuration, change name to something like "Run UI test app"
  2. Set Gradle project to :ui
  3. Set task to run
  4. Save configuration and launch, use this configuration for future launches.

Launching Editor

  1. In settings.gradle set visuiOnly to false.
  2. Create new Gradle run configuration, change name to something like "Run Editor"
  3. Set Gradle project to :editor
  4. Set task to run
  5. Set VM options to -Dfile.encoding=UTF-8
  6. Save configuration and launch, use this configuration for future launches.

Command line (VisEditor only)

Running from command line:

gradlew :editor:run

Building zip distribution:

gradlew distZip

This will create zip file in vis-editor\build\distributions containing main jar file, built-in plugins and all required editor libraries.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.