Design, evaluation and implementation of a new small DSL for creating animation intros for Youtube videos.
Built as a group project for UBC CPSC 410 (Advanced Software Engineering).

• Technology Stack 🛠️
• Prerequisites 🍪
• DSL Documentation 📑
• Setup 🔧
• Team ‎😃

• Java
• ANTLR
• JavaScript
• Three.js

You should have Git, Java JDK, and IntelliJ installed on your PC.

You can find the documentation for our DSL here.

1. Clone the repo using:

     git clone https://github.com/sassansh/YouAnimate

2. To install the SDK:

   1. Download the Java JDK (this project has been tested with SDK 16.0.2 - not sure about other versions).
   2. If you download the installer for your specific machine and run it, the Java version should be set up for you.
   3. Select File > Project Structure.
   4. Under 'Project Settings', choose 'Project' and for 'Project SDK' select '16' (it should automatically be detected and selectable).

3. To install ANTLR:

   1. Select File > Project Structure.
   2. Under 'Project Settings', choose 'Libraries' and select the '+' icon to add a new project library.
   3. Choose 'JAVA' and select YouAnimate/lib/antlr-4.9.2-complete.jar.

4. To generate (or update) the lexer files:

   1. Right-click on YouAnimate/src/parser/YouAnimateLexer.g4.
   2. Select 'Generate ANTLR Recognizer.'
   3. The files will show up under gen/parser.

5. To generate (or update) the parser files:

   1. Right-click on YouAnimate/src/parser/YouAnimateParser.g4.
   2. Select 'Generate ANTLR Recognizer.'
   3. The files will show up under gen/parser.

6. To set the project's source folders:

   1. Select File > Project Structure.
   2. Under 'Project Settings', choose 'Modules.' Right-click the gen folder, and select 'Sources.'
   3. Make sure both the 'src' and 'gen' folders are blue and listed underneath the 'Source Folders' header on the right.

7. To build the project:

   1. Select Build > Build Project.

8. To generate your animation

   1. Write your input inside of YouAnimate/input.ttxt
   2. Then run the Main class.
   3. In the console log, a list of the tokens detected will be displayed, along with any errors for the lexer / parser / evaluator.
   4. You will now have a generated HTML file at YouAnimate/index.html
   5. Open YouAnimate/index.html in a browser to view your animation

NOTE: If you encounter any errors (ex. with the ANTLR files, class imports, project builds, etc.), try selecting File > Invalidate Caches. Then select 'Invalidate & Restart.'

Sassan Shokoohi - GitHub - LinkedIn - Personal Website

Cara Wong - GitHub - LinkedIn

Amir Jafarvand - GitHub - LinkedIn - Personal Website

Angela Tian - GitHub - LinkedIn - Personal Website

Anna Takeuchi - GitHub - LinkedIn