/sprites

Custom sprites for plantuml diagrams

Primary LanguageShellGNU General Public License v3.0GPL-3.0

Custom Sprites

Custom sprites for plantuml diagrams

create_sprites.sh file copied from PlantUML Repository

How to create sprite from PNG image

  • find image and scale it down to 100x100 px (large icon) or smaller

    • to easily resize image on Ubuntu, use convert example.png -resize 100x100 example.png
    • you can also run convert example.png -resize 100x100! example.png to force image resize ignoring aspect ratio
    • resizing only height or width will allow for other size calculation
  • save image in the same filder as the create_sprites.sh script

  • use create_sprites.sh to generate sprites

  • reference sprites in your plantuml diagram like so:

    !include https://raw.githubusercontent.com/Piotr1215/sprites/master/rest-api.puml

Alternative flow

  • if svg image: inkscape -z -e out.png -w 100 -h 100 in.svg
  • use plantuml command line to encode: plantuml --encodesprite 16 out.puml"

Logos

All logo icons are the registered trademarks of their respective owners.