- Haskell 95.8%
- Elm 3.9%
- Nix 0.3%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
4b338de094
ImageMagick version 7 provides command 'magick' (as well as legacy 'convert'), is readily available on Windows but is not, currently, readily available on Ubuntu. On Windows, the name of ImageMagick's `convert` utility clashes with Microsoft's `C:\Windows\System32\convert.exe` utility. Using `magick`, if available, avoids the conflict. For clarity and to be command name-agnostic, the raster option name is changed from 'convert' (the command) to 'imagemagick' (the name of the software). For consistency with the version 7 command name, references in the code to 'convert' are changed to 'magick', throughout. |
||
| .azure | ||
| .github | ||
| data | ||
| docs | ||
| examples | ||
| src | ||
| test | ||
| videos | ||
| viewer-elm | ||
| .gitignore | ||
| azure-pipelines.yml | ||
| ChangeLog.md | ||
| hie.yaml | ||
| LICENSE | ||
| mkdocs.yml | ||
| README.md | ||
| reanimate.cabal | ||
| RESOURCES.md | ||
| Setup.hs | ||
| stack-lts-12.yaml | ||
| stack-lts-13.yaml | ||
| stack-lts-14.yaml | ||
| stack-lts-15.yaml | ||
| stack.yaml | ||
Reanimate
Reanimate is a library for programmatically generating animations with a twist towards mathematics / 2D vector drawings. A lot of inspiration was drawn from 3b1b's manim library.
Reanimate aims at being a batteries-included way of gluing together different technologies: SVG as a universal image format, LaTeX for typesetting, ffmpeg for video encoding, inkscape/imagemagick for rasterization, potrace for vectorization, blender/povray for 3D graphics, and Haskell for scripting.
In more practical terms, reanimate is a library for turning code like this:
main = reanimate $ docEnv $ playThenReverseA drawCircle
... into animations like this:
What is reanimate good at?
Vector graphics and math
Mapping and tracing
Mathematical typesetting and effects
2D physics and 3D graphics
Prerequisites
Reanimate is built using the Haskell Tool Stack. For installation instructions, see: https://docs.haskellstack.org/en/stable/README/
Optionally, you can install one or more of these programs to enable additional features:
- ffmpeg, enables rendering animations to video files.
- latex, enables mathematical typesetting.
- inkscape/imagemagick, enables SVG->PNG convertions.
- potrace, enables PNG->SVG tracing.
- povray, enables raytracing.
- blender, enables 3D graphics.
I highly recommend that you install at least 'ffmpeg' and 'latex'.
Installing / Running an example
Reanimate ships with a web-based viewer and automatic code reloading. To get a small demo up and running, clone the repository, run one of the examples (this will install the library), and wait for a browser window to open:
$ git clone https://github.com/reanimate/reanimate.git
$ cd reanimate/
$ stack build
$ stack ./examples/doc_drawCircle.hs
This should render the doc_drawCircle example in a new browser window. If you then change the
animation source code, the browser window will automatically reload and show the updated animation.
Documentation
- API reference: https://hackage.haskell.org/package/reanimate/docs/Reanimate.html
- Core concepts: https://reanimate.readthedocs.io/en/latest/introduction/
- Design overview: https://reanimate.readthedocs.io/en/latest/glue_tut/
- N-Queens tutorial (somewhat dated, uses reanimate from October 2019): https://williamyaoh.com/posts/2020-05-31-reanimate-nqueens-tutorial.html
Authors
- David Himmelstrup.
- Jan Hrcek.
License
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
Acknowledgments
- Huge thanks to 3b1b's manim which inspired this library.
- Thanks to svg-tree for their SVG library.
- Thanks to CthulhuDen/chiphunk for making a 2D physics library easily available.
- Thanks to Peter Johnson for reserving the 'reanimate' organization on GitHub.
YouTube
Completed animations are uploaded to the Reanimated Science channel.
Animation snippets are uploaded to the Reanimated Science Shorts channel.