Vide

Vide is the IDE for Vikari. Specifically it was designed with the purpose of providing syntax-highlighting for the language. So Vide utilizes the Vikari interpreter directly to lex and parse Vikari source files and support a syntax-highlighting strategy that is backed directly by the interpreter's output.

Dependencies

• Java
• Maven
• Vikari
• jpackage
• sips
• iconutil

Usage

Build the program with Maven. Vikari is a dependency of Vide. So Vikari must be downloaded and built in the .m2 directory first before Vide will build.

# Step 1: install and build Vikari.
cd ~/code/java
git clone https://github.com/atonement-crystals/Vikari.git
cd Vikari
mvn install

# Step 2: Install and build Vide.
cd ~/code/java
git clone https://github.com/atonement-crystals/Vide.git
cd Vide
mvn install

# Execute the jar file directly.
java -jar target/Vide-1.0.0.jar

Aliasing

Suggested usage of Vide is to alias the jar command in .zshrc.

# Your local root directory for Vide goes here.
VIDE_PROJECT_DIR="~/code/java/Vide"

# Fetch the most recent version of the jar build.
alias vide="java -jar `ls -r ${VIDE_PROJECT_DIR}/target/Vide*.jar | head -n1`"

After aliasing Vide, the Vikari demo file as pictured in the screenshot above can be opened with the following command:

# Assuming Vikari was downloaded here,
cd ~/code/java/Vikari

# open the demo file for editing.
vide demo/statements.dnr

Cross-Platform Use

Vide builds and runs on macOS, Linux, and Windows. macOS is 100% supported. Linux should work, but 100% functionality cannot be guaranteed on all distributions as it has only been tested on ZorinOS. Windows is not fully supported.

macOS

Vide was developed primarily for macOS. Therefore, the best support is guaranteed for this platform. A script to generate an installer package file is located at jpackage.sh. Running the script generates the following installer package: target/Vide-1.0.0.pkg, This will install Vide as an app on macOS.

Linux

Vide has been tested on ZorinOS 16. Any noticeable incompatibilities have been fixed. Use the executable jar process detailed above to run Vide on Linux.

Windows

There is a known major bug on Windows. The syntax highlighting is not aligned correctly. The author does not have adequate resources to commit to fully fixing the issue at this time.