Skip to content

Commit

Permalink
Update README with animations, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
ztangent committed Oct 19, 2023
1 parent 264f6d9 commit a271751
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

A library for visualizing, animating, and interacting with PDDL domains, built on top of [Makie.jl](https://github.com/MakieOrg/Makie.jl).

| Doors, Keys & Gems | Blocksworld | Zeno Travel |
| --- | --- | --- |
| ![Example gridworld animation](assets/gridworld.gif) | ![Example blocksworld animation](assets/blocksworld.gif) | ![Example zeno-travel animation](assets/zeno_travel.gif) |

## Installation

Press `]` at the Julia REPL to enter the package manager, then install this package along with `PDDL` and a `Makie` backend of your choice (e.g. `GLMakie`):
Expand All @@ -15,7 +19,7 @@ To install the development version, replace `PDDLViz` above with `https://github

## Usage

`PDDLViz.jl` provides a number of built-in renderer types for certain classes of domains, such as [`GridworldRenderer`](test/gridworld/test.jl) or [`GraphworldRenderer`](test/graphworld/test.jl). Each renderer can be customized for a specific domain by passing in options to its constructor:
`PDDLViz.jl` provides a number of built-in renderer types for certain classes of domains, such as [`GridworldRenderer`](test/gridworld/doors_keys_gems.jl), [`GraphworldRenderer`](test/graphworld/zeno_travel.jl) or [`BlocksworldRenderer`](test/graphworld/blocksworld.jl). Each renderer can be customized for a specific domain by passing in options to its constructor:

```julia
using PDDLViz, GLMakie
Expand Down Expand Up @@ -73,4 +77,4 @@ Renderers can also be used to create animations as well:

![Example gridworld trajectory animated by PDDLViz.jl](assets/gridworld.gif)

See [`test/gridworld/test.jl`](test/gridworld/test.jl) for examples of how to render plans, trajectories and planner solutions, how to animate trajectories, and how to enable interactive controls.
See the [`test`](test/) folder for examples of how to render plans, trajectories and planner solutions, how to animate trajectories, and how to enable interactive controls.
Binary file added assets/blocksworld.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/zeno_travel.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

2 comments on commit a271751

@ztangent
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/93741

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.7 -m "<description of version>" a271751d8ca59227882b40627c5d5062668f318f
git push origin v0.1.7

Please sign in to comment.