RAVEN

RAVEN is a framework to help you use Godot for creating visual environments. Currently available for Rascal.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

RAVEN is my Master's thesis project. It aims to connect the technological spaces of language workbenches and game engines in a generic way. The goal is to have a prototype for creating visual programming environments with Godot.

Warning

This is a work in progress and has only been tested under macOS.

(back to top)

How to try it out

Warning

Currently only available for macOS

This is an example of how you may give instructions on setting up the project locally.

Prerequisites

• You need at least Java Version 11 on your machine
• Please download the 0.9.1-4.2.2 of the Godot/JVM framework
• If you are under macOS, please move the Godot Application to the Applications folder: /Applications/Godot.app/Contents/MacOS/Godot
• For "enhanced" developer experience, please consider downloading tmux

Installation

1. Clone the repo

   git clone https://github.com/liza-kl/raven-project.git

2. Download Rascal
3. In the raven-rascal-example/raven-protocol go to the src/main/resources/config.yaml and replace the rascal-search-path so it points to the raven-project/raven-rascal-example/raven-core/src/main/rascal project.
4. Setup the project under raven-project/raven-rascal-example/raven-core

   make setup

If you have installed tmux:

3. Run the Rascal example

   make run.rascal

4. See output via tmux:

   tmux -a -t raven-session 

5. To stop tmux session:

   make stop

If you have not installed tmux:

3. Start server

   make run.server

4. Start Godot.

   make run.godot

Now it should display the Tiny State Machine Example

(back to top)

Usage

For an example with Rascal, please see raven-rascal-example

(back to top)

License

Distributed under the BSD2 License. See LICENSE.txt for more information.

(back to top)