Skip to content

synckey/tikzpingus

 
 

Repository files navigation

TikZpingus

made-with-latex GPLv3 License PR's Welcome CTAN build

This package is a work-in-progress package allowing you to typeset little penguins in LaTeX with PGF/TikZ. The documentation will constantly evolve.


TikZpingus is actively developed by Florian Sihler (contact me at: [email protected]) under the GPLv3 License. I am very happy about every contribution (see CONTRIBUTING.md).



The purpose of this library is to produce one thing: cute penguins. Using the \pingu-macro, you can pass an arbitrary amount of options to endow the penguin with many extras or change its complete appearance. Furthermore, most options allow additional arguments, defining the color, text, ...

While the documentation contains a reference of all options that are available (or at least, that is the plan), most extras should be named relatively intuitive. For example, if you want a small penguin, you add the option small. If the penguin should be large, you write large. If you want the penguin to hold a cup, you write cup. If the cup should have a specific color, like blue, you add this via cup=blue, ...

Currently, most options I have added arose from concrete situations and are not part of "sets". However, some sets do exist, like the santa or devil collection. If there are more sets in the future, I might add them as first-class components. For now, the documentation contains an overview of the larger gadgets.

If you just load the library by \usepackage{tikzpingus} all options will work, and you might want to use the glows-option (\usepackage[glows]{tikzpingus}) so that lightsabers and other glowing elements look waaay nicer (but may produce artifacts in some pdf-viewers). However, if loading the library takes too long for you, using the bare option will drastically reduce the default options available while allowing you to load specific libraries with \pinguloadlibraries{<list of libraries>}.

Not all gadgets and wing positions work together. While I try to get as many of them working as possible, selecting two different styles of glasses or hats probably looks weird, no matter what code I add. Nonetheless, there is code implemented to deal with a lot of interactions (e.g., items in different wings, multiple items on the hat, ...), and there are several options to cope with them yourself if the need arises. Oh, and by the way, when options are named with left and right they are always from the penguin-perspective.

Clothes are a work in progress for a long time now. While there are pants, shirts, a cape, and a cloak, they interfere with body types and other interaction codes. They work quite well for "not-too-fancy" and exotic combinations, but for more complex scenarios, I just had no time (for now). So feel free to wrap your head around that and open a PR! I would be happy to assist you!

Testing Files

These are some test files that showcase additional capabilities of the library:

For the title image of a computer-science course on software-product-lines, I created a small and incomplete but really fun feature model:

Contributors

Made with contrib.rocks.

About

🐧 Penguins in LaTeX with TikZ

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TeX 98.3%
  • Lua 1.7%