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.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The initial work of Planimation JS Library, and the frontend is waiting to be developed.
3
+
planimation is a modular and extensible open source framework to visualize sequential solutions of planning problems specified in PDDL. planimation has a preliminary declarative PDDL-like animation profile specification, expressive enough to synthesise animations of arbitrary initial states and goals of a benchmark with just a single profile.(https://planimation.github.io/documentation/).
4
4
5
-
## Features
6
-
- Visualise Planimation VFG file
7
-
- Visualise the last action of a given plan
8
5
9
-
## Tech
6
+
# Table of Contents
7
+
[1.0 Project Overview](#1.0)
10
8
11
-
-[PIXIJS] - The HTML5 Creation Engine
12
-
-[RequireJS] - RequireJS is a JavaScript file and module loader
9
+
[2.0 Deployment](#2.0)
10
+
11
+
[3.0 Development Environment Document](#3.0)
12
+
13
+
[4.0 Using the system](#4.0)
14
+
15
+
[5.0 Architecture Diagrams](#5.0)
16
+
17
+
[6.0 Change Log](#6.0)
18
+
19
+
[7.0 Quality Assurance](#7.0)
20
+
21
+
<h1id="1.0"> 1.0 Project Overview </h1>
22
+
23
+
## Background
24
+
25
+
Planimation is an openSource framework to visualise sequential solutions of planning problems specified in PDDL. The framework was built by a team of University of Melbourne students in the context of the course SWEN90013 and under the lead of Professor Nir Lipovetzky and it has been continually supported by students and contributors. The project has important awards and recognitions.
26
+
27
+
The planimation goals are:
28
+
29
+
* help to debug PDDL code for Online PDDL Editor users
30
+
31
+
* increases user understanding of planning problems
32
+
33
+
* showing planning solutions to non-technical audiences
34
+
35
+
The system uses a domain PDDL script, a problem PDDL script and a Animation profile script to produce visualisation.
36
+
37
+
## Goal for This Project
38
+
39
+
The main goal is:
40
+
* Improve project efficiency, maintainability and extendability of Planimation software
41
+
42
+
The specific goals are:
43
+
* replace the current frontend programed in C# with the Unity engine, for a Javascript and PixiJS framework
44
+
45
+
* decrease the loading times produced by the Unity engine
46
+
47
+
* maintaining its current features
48
+
49
+
* integrate with current development tools (Online pddl Editor plugin)
50
+
51
+
* develop a new plugin for Visual Studio Code
52
+
53
+
<h1id="2.0"> 2.0 Deployment </h1>
54
+
55
+
## Overview
56
+
57
+
Before building your development environment, you’ll need:
58
+
A code editor
59
+
VS Code is suggested. Download link
60
+
61
+
Recommended extensions: Jest; GitLens;tslint;
62
+
63
+
WebStorm is an alternative JavaScript IDE for frontend development.
64
+
65
+
Git
66
+
Check if you installed Git:
67
+
68
+
```
69
+
git --version
70
+
```
71
+
Please refer to https://docs.github.com/en/get-started/quickstart/set-up-git to see the installment and basic usage of Git.
72
+
73
+
### Node
74
+
Please follow the instructions and download Node.js to your system. https://nodejs.org/en/
75
+
76
+
Recommended version: 14.17.5. Npm is the package manager for the Node JavaScript It is already installed along with Node.
### It’s good if you could setup your username and email address for the repository, so the other team members will have a clear idea the contributors of branches and codes on GitHub.
Go to the first page to generate visualisation using PDDL files.
156
+
157
+
### 4.1.2 Go to VFG file upload page
158
+
159
+
Go to the second page to generate visualisation using VFG files.
160
+
161
+
### 4.1.3 Check document for the project
162
+
163
+
Check the documentation for Planimation
164
+
165
+
### 4.1.4 Check demo video for the project
166
+
167
+
Check the Demo Video for Planimation
168
+
169
+
170
+
## 4.2. PDDL file upload page
171
+
172
+
On this page, you need to upload 3 PDDL file to the PDDL editor server, and it will lead you to the visualization page with a generated vfg file.
173
+
174
+
## 4.3. VFG file upload page
175
+
176
+
On this page, you need to upload a single vfg file for animation generating. It will lead you to the visualization page once your .vfg file is accepted.
177
+
178
+
## 4.4. Document Page
179
+
180
+
On document page, you can access the resources for how to use planimation and how to deploy it on your computer.
181
+
182
+
## 4.5. Demo Page
183
+
184
+
In the demo page we have a youtube video which would teach you how does planimation works and how we deployed it.
185
+
186
+
## 4.6. Visualization Page
187
+
188
+
This is the main functionality page for the project. It will show the animation generated from the VFG file on pages 1 and page 2. On this page, your could de the following operation.
189
+
190
+
### 4.6.1 Check the stage list on the left side of the page
191
+
On the left, you will see a list of all the stages for this problem. And you can check the visualization for this stage by clicking on it.
192
+
193
+
### 4.6.2 Check the subgoal list on the right side of the page
194
+
On the right, you will see a list of all the subgoal conditions for this problem. And you can check the visualization for the condition where this sub goal is satisfied by clicking on that step.
195
+
196
+
### 4.6.3 Operation on visualization
197
+
In the middle of the page, you will see the visualization sections which will look different depends on your problem. By clicking on the control button in this section, you can easily pause, play, reset, speed up, slow down and move to the pre/next step.
When you develop the new features for Planimation JS Libary, please try to modularise it. So it will be easier to maintain the front-end in future. Also, the potential user can use the relevant feature to build their application. Visualise the search tree with Planimation is a good example here.
0 commit comments