valgolang Goto Github PK

VAlgoLang (formerly known as ManimDSL) is a domain specific language using Manim to create animations for data structures and algorithms.

• Installation
• Web Editor
• Building VAlgoLang Locally
• Usage
• Documentation
• Contributing

VAlgoLang produces Python code that needs to run on Manim to generate the mp4 files. Please follow the documentation to install manim and follow the instructions according to your operating system.

Once manim is installed there are multiple ways to get VAlgoLang.

VAlgoLang is avaliable on Homebrew using the instructions below:

    brew tap VAlgoLang/homebrew-valgolang
    brew install valgolang

Typing valgolang in your terminal should show give you access to the compiler.

curl -sLO https://github.com/VAlgoLang/VAlgoLang/releases/download/latest/valgolang_1.0.SNAPSHOT-1_all.deb && sudo dpkg -i valgolang_1.0.SNAPSHOT-1_all.deb

If you do not want to install all the dependencies, you can use the web editor to write and compile code in VAlgoLang.

To get started on your local machine, please do the following:

1. Fork and clone the repository and open in your favourite editor. Since the interpreter is written in Kotlin, our choice is IntelliJ.
2. Install Manim and its dependencies.
3. Make changes to the compiler as you wish.
4. Run the following command to build the JAR file for the compiler:

./gradlew build -x test

Remember that you'll need to do this every time you make a change and would like to see its effect.

5. Run the following on a .val file to see whether your changes are working as expected:

./compile <your-file-name>.val

During development, it might be easier for you to read through the .py output file each time you make a change than to wait for Manim to generate a video. In this case, we recommend using the -p flag during compilation. For more on the command line arguments for VAlgoLang, see here.

Here is an example on how to use VAlgoLang:

    let stack = Stack<number>();
    stack.push(1);
    let x = stack.pop();

Save this file with the .val extension and run the compiler on it:

    java -jar valgolang.jar <your-file-name>.val out.mp4

This should save the animation to out.mp4, animating the stack with 1 being pushed and popped off the stack.

Documentation is in progress at valgolang.github.io.

We welcome all contributions! If you would like to contribute, please see the corresponding guidelines. By contributing, you are agreeing to our code of conduct.