tikzlings-doc.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Documentation for the tikzlings package
% A package to bring cute little animals and other beings into tikz
% Maintained by samcarter
%
% Project repository and bug tracker:
% https://github.com/samcarter/tikzlings
%
% Released under the LaTeX Project Public License v1.3c or later
% See http://www.latex-project.org/lppl.txt
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\documentclass[parskip=half]{scrartcl}

% packages %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage[T1]{fontenc}  
\usepackage[utf8]{inputenc}    
\usepackage[english]{babel}
\usepackage[svgnames]{xcolor}
\usepackage[bitstream-charter]{mathdesign}
\usepackage{tikzlings}
\usepackage[most]{tcolorbox}
\usepackage{bearwear}
\usepackage[paper=a4paper,margin=3cm]{geometry}
\usepackage{url}
\usepackage{xspace}
\usepackage{scrlayer-scrpage} 
\usepackage[hang,flushmargin,bottom]{footmisc}
\usepackage[%
  colorlinks=true,
  breaklinks=true,
  allcolors=SteelBlue!50!black
]{hyperref}
\usetikzlibrary{3d}

% macros %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newcommand{\CTAN}{\textsc{CTAN}\xspace}
\newcommand{\TikZ}{Ti\emph{k}Z\xspace}
\newcommand{\tikzducks}{Ti\emph{k}Zducks\xspace}
\newcommand{\tikzmarmots}{Ti\emph{k}Zmarmots\xspace}
\newcommand{\tikzlings}{Ti\emph{k}Zlings\xspace}
\newcommand{\miktex}{MiK\TeX\xspace}
\newcommand{\texlive}{\TeX{}Live\xspace}

% customisation %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\addtokomafont{sectioning}{\color{SteelBlue}}
\addtokomafont{date}{\normalsize}
\addtokomafont{author}{\normalsize}

\deftocheading{toc}{}%
\setcounter{tocdepth}{1}

\newcommand*\gobbleentrynumber[1]{}
\newcommand*\mytocformat[1]{#1}
\newcommand*\mytocpageformat[1]{#1}
\RedeclareSectionCommand[
  toclinefill=\TOCLineLeaderFill,
  tocnumwidth=0pt,
  tocentrynumberformat=\gobbleentrynumber,
  tocentryformat=\mytocformat,
  tocpagenumberformat=\mytocpageformat,
  tocbeforeskip=0.8ex plus 1pt minus 1pt
]{section}

\makeatletter
\renewcommand{\sectionlinesformat}[4]{%
\Ifstr{#1}{section}{%
    \parbox[t]{\linewidth}{%
      \raggedsection\@hangfrom{\hskip #2#3}{#4}\par%
      \kern-.75\ht\strutbox\rule{\linewidth}{.8pt}%
    }%
  }{%
    \@hangfrom{\hskip #2#3}{#4}}% 
}
\makeatother

\renewcommand*{\subsectionformat}{}
\renewcommand*{\sectionformat}{}

\setlength{\footnotemargin}{0.7em}

\colorlet{blue}{SteelBlue}

\lstdefinestyle{duckstyle}{%
  language={[latex]TeX},
  tabsize=2,
  breaklines,
  basicstyle=\ttfamily,
  commentstyle={\color{green!50!black}\slshape}, 
  columns=fullflexible,
  alsodigit={-},
  alsoletter={3},
  emphstyle=\color{red!60!black},
  emph=[1]{
    tikzlings,
    tikzlings-marmots, tikzlings-bears, tikzlings-coatis, tikzlings-koalas, tikzlings-marmots, tikzlings-owls, tikzlings-penguins, tikzlings-snowmans, tikzlings-mice, tikzlings-moles, tikzlings-sloths, tikzlings-pigs, tikzlings-cats, tikzlings-hippos, tikzlings-rhinos, tikzlings-pandas, tikzlings-bees, tikzlings-anteaters, tikzlings-squirrels, tikzlings-sheep,
    body, 3D, rotatehead, sideward, blush, sleeping, whiskers, teeth, shadow, askphil, leftstep, rightstep, eye, nose, pupil, bill, feet, belly, ask, phil, mouth, buttons, rotatearms, paws, back, pupilwidth, globalwarming, wings, antennas, stripes,
    scale, yshift, xshift, rotate, hands, muzzle, schroedinger, toes,
    hat, tophat, beret, strawhat, ribbon, harlequin, niuqelrah, witch, magichat, magicstars, crown, queencrown, kingcrown, santa, chef, graduate, tassel, alien, book, bookcolour, signpost, signcolour, signback, speech, think, bubblecolour, pizza, cheese, baguette, cake, icecream, flavoura, flavourb, flavourc, milkshake, wine, cricket, hockey, football, crystalball, magicwand, rollingpin, lightsaber, torch, basket, easter, egga, eggb, eggc, crozier, shovel, pickaxe, umbrella, umbrellaclosed, handbag, cocktail, monocle, contour,
  },
  texcsstyle=*\color{SteelBlue!50!black}\bfseries,
  keywordstyle=\color{red!60!black}\bfseries,
  morekeywords={tikzpicture},
  moretexcs={
    usepackage, usetikzlibrary, marmot, coati, bear, koala, owl, penguin, thing, tikzling, snowman, mouse, moles, sloth, pig, cat, hippo, rhino, panda, bee, anteater, squirrel, bearwear, sheep, tikzlinghookbackground, tikzlinghookbelly, tikzlinghookbody, tikzlinghookforeground, mousehookbelly
  },
  delim ={[s][\ttfamily\color{green!50!black}]{$}{$}},
  moredelim=[is][\footnotesize\ttfamily\color{orange!70!black}]{|}{|},
  index=[1][emph]
}

\tcbset{%
  colframe=SteelBlue!50!black,
  arc=0mm,
  fonttitle=\bfseries,
  sidebyside,
  listing options={style=duckstyle},
  center lower,
  righthand width=6.5cm,
  bottom=0pt, 
  top=0pt,
  tikz lower,
  height plus=3cm,
  colback=SteelBlue!30!white
}

\lstset{style=duckstyle}

\pgfmathsetseed{2}
\setlength{\footheight}{50pt}

\cfoot{\thepage} 
\pagestyle{scrheadings}

\newcommand{\coatihookbackground}{\path (-1.63,0.1) rectangle (1.63,2.26);}
\newcommand{\mousehookbackground}{\path (-1.6,0.1) rectangle (0.905, 2.17);}
\newcommand{\cathookbackground}{\path (-1.6,0.1) rectangle (0.905, 2.17);}

\cfoot{%
  \begin{tikzpicture}[scale=0.5] 
      \tikzling[signpost={\thepage}]
  \end{tikzpicture}
} 

% meta %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\title{The \texorpdfstring{\tikzlings}{tikzlings} package}
\subtitle{drawing animals and beings in \TikZ}
\author{%
  \texorpdfstring{\texttt{samcarter}\\[0.8em]
    \url{https://github.com/samcarter/tikzlings}\\
    \url{https://www.ctan.org/pkg/tikzlings}
  }{samcarter}}
\date{Version v0.5 \textendash{} 2021/03/17}

\begin{document}
\maketitle
\thispagestyle{scrheadings}

\section*{Introduction}
\label{intro}

The \tikzlings are a collection of little animals (and beings) drawn in \TikZ. It is the next evolutionary phase of the \tikzmarmots package extending it with further animals (and beings) and also adding the ability to natively use many of the accessories known from the \tikzducks package. 

This package is work in progress, therefore I would be happy to hear your feedback and ideas how to improve the package. 
The head version of the source code can be found on \url{github.com/samcarter/tikzlings}, including a bug tracker -- please make constructive use of it! 
If you seek any other assistance (not bug reports/feature requests), I suggest asking a question at \url{topanswers.xyz/tex}.
A more stable package version can be found on \CTAN (\url{https://www.ctan.org/pkg/tikzlings}) and is included in both \miktex and \texlive as \tikzlings. 

\subsection*{Acknowledgements}

I'd like to thank the friendly and helpful community of \TeX{} users for their suggestions, feedback and help to create this package and find a suitable name for it. As a thank you all the \tikzlings have a name which is in some way or another connected to the users of \TeX{}.

\subsection*{License}

Copyright \raisebox{0.2em}{\tiny\fontfamily{cmr}\selectfont\textcopyright}
\texttt{samcarter}. Permission is granted to copy, distribute and\slash or modify this software under the terms of the LaTeX project public licence, version 1.3c or later \url{http://www.latex-project.org/lppl.txt}.

\clearpage
\section*{The \tikzlings}

The \tikzlings package is a collection of packages. It can either be loaded as a whole with \lstinline|\usepackage{tikzlings}| or the subpackages containing the individual animals (and beings) can be used separately, e.g.\ by loading \lstinline|\usepackage{tikzlings-marmots}|.

The basic usage is the same for all animals (and beings). Inside a \lstinline|tikzpicture|, the \tikzlings can be added via \color{SteelBlue!50!black}\lstinline|\<name_of_the_tikzling>|\color{black}. For example

\begin{tcblisting}{}
\marmot
\end{tcblisting}

will produce a marmot. All usual \TikZ and \lstinline|pgf| keys can be passed as optional argument to change the appearance. For example scaling and rotating the \tikzlings can be done by

\begin{tcblisting}{}
\penguin[rotate=30,scale=0.5]
\end{tcblisting}

In addition to the standard options provided by \TikZ each \tikzlings also comes with some additional options which are listed in the following sections. If these additional options consist of multiple words they are available both with and without spaces, for example \lstinline|askphil| and \lstinline|ask phil| will be treated as the same.

To make customisation  of the \tikzlings easier, some hooks are provided, which can be redefined by the user in order to add commands at specific layers:
\begin{itemize}
  \color{SteelBlue!50!black}
  \item \lstinline|\<name_of_the_tikzling>hookbackground|
  \item \lstinline|\<name_of_the_tikzling>hookbelly|
  \item \lstinline|\<name_of_the_tikzling>hookbody| 
  \item \lstinline|\<name_of_the_tikzling>hookforeground|
\end{itemize}

With regard to the individual components of the \tikzlings, they are located in the following z order:
\begin{center}
\begin{tikzpicture}[scale=1.05]
    \newcommand{\planes}{\fill[SteelBlue!30!white,opacity=0.9]  (-1.9,-0.1) rectangle (1.9,2.4);}
    \newcommand{\hooks}{\draw[SteelBlue!50!black, rounded corners=3pt, line width=1pt]  (-1.9,-0.1) rectangle (1.9,2.4);}
    \newcounter{layer}
    \setcounter{layer}{0}
    \begin{scope}[canvas is zy plane at x=\thelayer*1.8]
      \hooks
      \node[font=\footnotesize\ttfamily,rotate=45] at (0,0.1) {background};
    \end{scope}
    \addtocounter{layer}{1}
    \begin{scope}[canvas is zy plane at x=\thelayer*1.8]
      \planes
      \newcommand{\rhinohookbelly}{
        \pgfsetfillopacity{0}
        \pgfsetstrokeopacity{0}
      }
      \rhino
    \end{scope}
    \addtocounter{layer}{1}
    \begin{scope}[canvas is zy plane at x=\thelayer*1.8]
      \hooks
      \node[font=\footnotesize\ttfamily,rotate=45] at (0,0.1) {belly};
    \end{scope}
    \addtocounter{layer}{1}
    \begin{scope}[canvas is zy plane at x=\thelayer*1.8]
      \planes
      \newcommand{\rhinohookbackground}{
        \pgfsetfillopacity{0}
        \pgfsetstrokeopacity{0}
      }      
      \newcommand{\rhinohookbelly}{
        \pgfsetfillopacity{1}
        \pgfsetstrokeopacity{1}
      }
      \rhino
    \end{scope}
    \addtocounter{layer}{1}
    \begin{scope}[canvas is zy plane at x=\thelayer*1.8]
      \hooks
      \node[font=\footnotesize\ttfamily,rotate=45] at (0,0.1) {body};
    \end{scope}
    \addtocounter{layer}{1}
    \begin{scope}[canvas is zy plane at x=\thelayer*1.8]
      \planes
      \thing[magichat,magicwand]
    \end{scope}
    \addtocounter{layer}{1}
    \begin{scope}[canvas is zy plane at x=\thelayer*1.8]
      \hooks
      \node[font=\footnotesize\ttfamily,rotate=45] at (0,0.1) {foreground};
    \end{scope}
  \end{tikzpicture}
\end{center}

In addition the hooks \lstinline|\tikzlinghookbackground|, \lstinline|\tikzlinghookbelly|, \lstinline|\tikzlinghookbody| and \lstinline|\tikzlinghookforeground| are available and will effect all \tikzlings.

A short example how the hooks can be used:
\begin{tcblisting}{}
\newcommand{\mousehookbelly}{%
 \fill[red!80!black] 
(0.55, 1.35) -- (0.65, 0.3) -- 
(-0.65, 0.3) -- (-0.55, 1.35) 
-- (0.0, 0.9) -- cycle;
}
\mouse
\end{tcblisting}

\subsection*{List of all \tikzlings:}

\begingroup
  \hypersetup{hidelinks}
  \tableofcontents
\endgroup

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Anteater 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Anteater]{Peter, the anteater}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-anteaters}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\anteater
\end{tcblisting}

\subsection{Options}

The basic anteater can be modified by changing its colour:
\begin{tcblisting}{}
\anteater[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\anteater[eye=red]
\end{tcblisting}

To view the anteater from behind:
\begin{tcblisting}{}
\anteater[back]
\end{tcblisting}

The key \lstinline|3D| will make the anteater 3-dimensional:
\begin{tcblisting}{}
\anteater[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\anteater[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Bear 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Bear]{B\"ar, the teddy bear}

\emph{If you look very closely at the group picture in \href{https://www.tug.org/TUGboat/tb39-2/tb122wright-tug18.pdf}{TUG goes to Rio} you can spot the real B\"ar in it}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-bears}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\bear
\end{tcblisting}

\subsection{Options}

The basic teddy bear can be modified by changing its colour:
\begin{tcblisting}{}
\bear[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\bear[eye=red]
\end{tcblisting}

To view the teddy bear from behind:
\begin{tcblisting}{}
\bear[back]
\end{tcblisting}

The key \lstinline|3D| will make the teddy bear 3-dimensional:
\begin{tcblisting}{}
\bear[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\bear[contour=black]
\end{tcblisting}

\subsection{Extension}

The B\"ar and Ulrike Fischer wrote the fantastic \lstinline|bearwear| package, that provides many different clothing options for the \lstinline|TikZbears|. All the other \tikzlings admire them for the nice clothing!

A short example:

\begin{tcblisting}{}
%\usepackage{bearwear}
\bear
\bearwear[
  long sleeves, 
  shirt=red!80!black
]
\end{tcblisting}

Many more options and examples can be found in the package documentation \url{https://ctan.org/pkg/bearwear}. 

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Bee 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Bee]{Beeing, the bee}

\emph{The bee was kindly contributed by @marmot}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-bees}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\bee
\end{tcblisting}

\subsection{Options}

The basic bee can be modified by changing its colour:
\begin{tcblisting}{}
\bee[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of various body parts can be adjusted:
\begin{tcblisting}{}
\bee[antennas=red]
\end{tcblisting}
\begin{tcblisting}{}
\bee[eye=red]
\end{tcblisting}
\begin{tcblisting}{}
\bee[mouth=red]
\end{tcblisting}
\begin{tcblisting}{}
\bee[wings=red]
\end{tcblisting}
\begin{tcblisting}{}
\bee[hands=red]
\end{tcblisting}
\begin{tcblisting}{}
\bee[stripes=red]
\end{tcblisting}

To view the bee from behind:
\begin{tcblisting}{}
\bee[back]
\end{tcblisting}

The key \lstinline|3D| will make the bee 3-dimensional:
\begin{tcblisting}{}
\bee[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\bee[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Cat
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Cat]{MisTi$k$Zelees, the cat}

\emph{Named after the worlds best singing cat}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-cats}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\cat
\end{tcblisting}

\subsection{Options}

The basic cat can be modified by changing its colour:
\begin{tcblisting}{}
\cat[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of various body parts can be adjusted:
\begin{tcblisting}{}
\cat[eye=green]
\end{tcblisting}
\begin{tcblisting}{}
\cat[pupil=red]
\end{tcblisting}
\begin{tcblisting}{}
\cat[nose=red]
\end{tcblisting}
\begin{tcblisting}{}
\cat[whiskers=red]
\end{tcblisting}
\begin{tcblisting}{}
\cat[paws=red]
\end{tcblisting}

The shape of the \lstinline|pupil| can be changed with the \lstinline|pupilwidth| option:
\begin{tcblisting}{}
\cat[pupilwidth=0.015]
\end{tcblisting}

Additionally several predefined widths exist:
\begin{tcolorbox}
\begin{lstlisting}[morekeywords={narrow,medium,wide,very,pupils}]
\cat[narrow pupils]

\cat[medium pupils]

\cat[wide pupils]

\cat[very wide pupils]
\end{lstlisting} 

\tcblower
\begin{tikzpicture}[yshift=2.4cm,xshift=1.8cm]
\cat[narrow pupils]
\cat[medium pupils,xshift=2.5cm]
\cat[wide pupils,yshift=-2.5cm]
\cat[very wide pupils,xshift=2.5cm,yshift=-2.5cm]
\end{tikzpicture}
\end{tcolorbox}

There is also the special option \lstinline|schroedinger|. This cat is both alive and dead as long as you did not compile your document.
Be prepared for a possibly disturbing scene when you open the pdf, this option is not suited for sensitive \tikzlings.
\begingroup
\makeatletter
\renewcommand*{\cat}[1][]{%
    \tikzset{/cat/.cd,#1}%
    \cat@tombstone%
}
\renewcommand{\cathookbackground}{}
\makeatother
\begin{tcblisting}{}
\cat[schroedinger]
\end{tcblisting}
\endgroup

To view the cat from behind:
\begin{tcblisting}{}
\cat[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the cat 3-dimensional:
\begin{tcblisting}{}
\cat[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\cat[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Coati 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Coati]{007, the coati}

\emph{Named after a coati living in the zoo of M\"onchengladbach}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-coatis}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\coati
\end{tcblisting}

\subsection{Options}

The basic coati can be modified by changing its colour:
\begin{tcblisting}{}
\coati[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\coati[eye=red]
\end{tcblisting}

The head of the coati can be rotated, but please don't overdo this, otherwise his neck might break!
\begin{tcblisting}{}
\coati[rotatehead=-15]
\end{tcblisting}

For the head an alternative sidewards facing head is available. It can be combined with the \lstinline|rotatehead| option.
\begin{tcblisting}{}
\coati[sideward]
\end{tcblisting}

To view the coati from behind:
\begin{tcblisting}{}
\coati[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the coati 3-dimensional:
\begin{tcblisting}{}
\coati[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\coati[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Hippo
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Hippo]{Sieglinde, the hippo}

\emph{For the winner of the 2019 Groundhog Challenge}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-hippos}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\hippo
\end{tcblisting}

\subsection{Options}

The basic hippo can be modified by changing its colour:
\begin{tcblisting}{}
\hippo[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\hippo[eye=red]
\end{tcblisting}
\begin{tcblisting}{}
\hippo[pupil=red]
\end{tcblisting}

The hippo can also do its nails:
\begin{tcblisting}{}
\hippo[toes=red]
\end{tcblisting}

To view the hippo from behind:
\begin{tcblisting}{}
\hippo[back]
\end{tcblisting}

The key \lstinline|3D| will make the hippo 3-dimensional:
\begin{tcblisting}{}
\hippo[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\hippo[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Koala 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Koala]{Will, the koala}

\emph{The koala was generously contributed by @marmot and is named in honour of a \LaTeX{} developer from Down Under}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-koalas}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\koala
\end{tcblisting}

\subsection{Options}

The basic koala can be modified by changing its colour:
\begin{tcblisting}{}
\koala[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\koala[eye=red]
\end{tcblisting}

It can also blush
\begin{tcblisting}{}
\koala[blush]
\end{tcblisting}

and if tired, it is going to take a nap:
\begin{tcblisting}{}
\koala[sleeping]
\end{tcblisting}

To view the koala from behind:
\begin{tcblisting}{}
\koala[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the koala 3-dimensional:
\begin{tcblisting}{}
\koala[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\koala[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Marmot 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Marmot]{Phil, the marmot}

\emph{Phil got his name from Punxsutawney Phil, the famous weather forecasting groundhog}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-marmots}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\marmot
\end{tcblisting}

\subsection{Options}

The basic marmot can be modified by changing its colour:
\begin{tcblisting}{}
\marmot[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\marmot[eye=red]
\end{tcblisting}

The marmot can also blush
\begin{tcblisting}{}
\marmot[blush]
\end{tcblisting}

and whiskers can be added:
\begin{tcblisting}{}
\marmot[whiskers=gray]
\end{tcblisting}

Some marmots even show their chisel teeth:
\begin{tcblisting}{}
\marmot[teeth=white]
\end{tcblisting}

or can cast a shadow:
\begin{tcblisting}{}
\marmot[shadow]
\end{tcblisting}

This ability is important if you want to ask Punxsutawney Phil\footnote{\url{https://en.wikipedia.org/wiki/Punxsutawney_Phil}} on Groundhog Day how the weather is going to be. With a probability derived from the statistics of 120 Groundhog Days\footnote{\url{https://www.livescience.com/32974-punxsutawney-phil-weather-prediction-accuracy.html}} the option \lstinline|askphil| might or might not result in a shadow.
\begin{tcblisting}{}
\marmot[askphil]
\end{tcblisting}

If a good weather prognosis is derived, the happy marmot can dance by lifting up its left and right foot: 
\begin{tcblisting}{}
\marmot[leftstep]
\marmot[rightstep,xshift=2cm]
\end{tcblisting}

To view the marmot from behind:
\begin{tcblisting}{}
\marmot[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the marmot 3-dimensional:
\begin{tcblisting}{}
\marmot[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\marmot[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Moles 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Mole]{Wilhelm, the mole}

\emph{The mole was added in celebration of the international mole day and is named after the chemist Wilhelm Ostwald}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-moles}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\textcolor{red!60!black}{\textbf{Attention:} In contrast to the other \tikzlings the macro name is the plural form to avoid conflicts with  \lstinline|siunitx| and similar packages.}
\begin{tcblisting}{}
\moles
\end{tcblisting}

\subsection{Options}

The basic mole can be modified by changing its colour:
\begin{tcblisting}{}
\moles[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of various body parts can be adjusted:
\begin{tcblisting}{}
\moles[eye=red]
\end{tcblisting}

\begin{tcblisting}{}
\moles[muzzle=red]
\end{tcblisting}

\begin{tcblisting}{}
\moles[hands=red]
\end{tcblisting}

\begin{tcblisting}{}
\moles[feet=red]
\end{tcblisting}

To view the mole from behind:
\begin{tcblisting}{}
\moles[back]
\end{tcblisting}

The key \lstinline|3D| will make the mole 3-dimensional:
\begin{tcblisting}{}
\moles[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\moles[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Mouse 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Mouse]{Tokz, the mouse}

\emph{The idea for the mouse came from an Italian \LaTeX{} user -- Tokz is a combination of the Italian word for mouse and \TikZ}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-mice}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\mouse
\end{tcblisting}

\subsection{Options}

The basic mouse can be modified by changing its colour:
\begin{tcblisting}{}
\mouse[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\mouse[eye=red]
\end{tcblisting}

The rotation angle of its arms can be adjusted:
\begin{tcblisting}{}
\mouse[rotatearms=40]
\end{tcblisting}

And the mouse can lift its legs:
\begin{tcblisting}{}
\mouse[leftstep]
\mouse[rightstep,xshift=2cm]
\end{tcblisting}

To view the mouse from behind:
\begin{tcblisting}{}
\mouse[back]
\end{tcblisting}

The key \lstinline|3D| will make the mouse 3-dimensional:
\begin{tcblisting}{}
\mouse[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\mouse[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Owl 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Owl]{Jake, the owl}

\emph{The owl Jake was inspired by the avatar of one of the world's top TikZperts}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-owls}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\owl
\end{tcblisting}

\subsection{Options}

The basic owl can be modified by changing its colour:
\begin{tcblisting}{}
\owl[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of various body parts can be adjusted:
\begin{tcblisting}{}
\owl[eye=red]
\end{tcblisting}
\begin{tcblisting}{}
\owl[pupil=red]
\end{tcblisting}
\begin{tcblisting}{}
\owl[bill=red]
\end{tcblisting}
\begin{tcblisting}{}
\owl[feet=red]
\end{tcblisting}

To view the owl from behind:
\begin{tcblisting}{}
\owl[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the owl 3-dimensional:
\begin{tcblisting}{}
\owl[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\owl[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Panda
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Panda]{Meng Meng, the panda}

\emph{Meng Meng is named after one of the pandas at the zoological garden Berlin}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-pandas}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\panda
\end{tcblisting}

\subsection{Options}

The basic panda can be modified by changing its colour:
\begin{tcblisting}{}
\panda[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\panda[eye=red]
\end{tcblisting}
\begin{tcblisting}{}
\panda[pupil=red]
\end{tcblisting}

To view the panda from behind:
\begin{tcblisting}{}
\panda[back]
\end{tcblisting}

The key \lstinline|3D| will make the panda 3-dimensional:
\begin{tcblisting}{}
\panda[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\panda[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Penguin 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Penguin]{Tux, the penguin}

\emph{Dedicated to the Linux mascot}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-penguins}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\penguin
\end{tcblisting}

\subsection{Options}

The basic penguin can be modified by changing its colour:
\begin{tcblisting}{}
\penguin[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of various body parts can be adjusted:
\begin{tcblisting}{}
\penguin[eye=red]
\end{tcblisting}
\begin{tcblisting}{}
\penguin[pupil=red]
\end{tcblisting}
\begin{tcblisting}{}
\penguin[bill=red]
\end{tcblisting}
\begin{tcblisting}{}
\penguin[belly=red]
\end{tcblisting}
\begin{tcblisting}{}
\penguin[feet=red]
\end{tcblisting}

To view the penguin from behind:
\begin{tcblisting}{}
\penguin[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the penguin 3-dimensional:
\begin{tcblisting}{}
\penguin[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\penguin[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Pig 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Pig]{Ms Piggy, the pig}

\emph{Added on February 5th, 2019 to commemorate the Chinese year of the pig}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-pigs}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\pig
\end{tcblisting}

\subsection{Options}

The basic pig can be modified by changing its colour:
\begin{tcblisting}{}
\pig[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\pig[eye=red]
\end{tcblisting}

To view the pig from behind:
\begin{tcblisting}{}
\pig[back]
\end{tcblisting}

The key \lstinline|3D| will make the pig 3-dimensional:
\begin{tcblisting}{}
\pig[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\pig[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Rhino
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Rhino]{D\"urer, the rhino}

\emph{Named after Albrecht D\"urer who painted an amazing rhino merely based on stories}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-rhinos}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\rhino
\end{tcblisting}

\subsection{Options}

The basic rhino can be modified by changing its colour:
\begin{tcblisting}{}
\rhino[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\rhino[eye=red]
\end{tcblisting}
\begin{tcblisting}{}
\rhino[pupil=red]
\end{tcblisting}

The hippo can also do its nails:
\begin{tcblisting}{}
\rhino[toes=red]
\end{tcblisting}

To view the rhino from behind:
\begin{tcblisting}{}
\rhino[back]
\end{tcblisting}

The key \lstinline|3D| will make the rhino 3-dimensional:
\begin{tcblisting}{}
\rhino[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\rhino[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Sheep
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Sheep]{Mókollur, the sheep}

\emph{The sheep was kindly contributed by @Plergux. Mókollur is a bit silly and likes to goof off. This sheep's favourite food are boiled potatoes.}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-sheep}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\sheep
\end{tcblisting}

\subsection{Options}

The basic sheep can be modified by changing its colour:
\begin{tcblisting}{}
\sheep[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\sheep[eye=red]
\end{tcblisting}

The sheep can also blush
\begin{tcblisting}{}
\sheep[blush]
\end{tcblisting}

and put on a monocle
\begin{tcblisting}{}
\sheep[monocle]
\end{tcblisting}

To view the sheep from behind:
\begin{tcblisting}{}
\sheep[back]
\end{tcblisting}

The key \lstinline|3D| will make the sheep 3-dimensional:
\begin{tcblisting}{}
\sheep[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\sheep[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Sloth 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Sloth]{Riley, the sloth}

\emph{One of good souls behind the TugBoat once met a sloth called Riley}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-sloths}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\sloth
\end{tcblisting}

\subsection{Options}

The basic sloth can be modified by changing its colour:
\begin{tcblisting}{}
\sloth[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\sloth[eye=red]
\end{tcblisting}

If tired, the sloth can take a nap:
\begin{tcblisting}{}
\sloth[sleeping]
\end{tcblisting}

To view the sloth from behind:
\begin{tcblisting}{}
\sloth[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the sloth 3-dimensional:
\begin{tcblisting}{}
\sloth[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\sloth[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Squirrel 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Squirrel]{Ratatosk, the squirrel}

\emph{named after the squirrel from Norse mythology who climbs around Yggdrasil}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-squirrels}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\squirrel
\end{tcblisting}

\subsection{Options}

The basic squirrel can be modified by changing its colour:
\begin{tcblisting}{}
\squirrel[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of the eyes can be adjusted:
\begin{tcblisting}{}
\squirrel[eye=red]
\end{tcblisting}
\begin{tcblisting}{}
\squirrel[pupil=red]
\end{tcblisting}

To view the squirrel from behind:
\begin{tcblisting}{}
\squirrel[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the squirrel 3-dimensional:
\begin{tcblisting}{}
\squirrel[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\squirrel[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Snowman 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Snowman]{Yuki, the snowman}

\emph{Yuki is the transcription of the Japanese word for snow}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings-snowmans}| 
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\snowman
\end{tcblisting}

\subsection{Options}

The basic snowman can be modified by changing its colour:
\begin{tcblisting}{}
\snowman[body=blue]
\end{tcblisting}

In addition to the colour of the body, the colour of various body parts can be adjusted:
\begin{tcblisting}{}
\snowman[eye=red]
\end{tcblisting}
\begin{tcblisting}{}
\snowman[nose=red]
\end{tcblisting}
\begin{tcblisting}{}
\snowman[mouth=red]
\end{tcblisting}
\begin{tcblisting}{}
\snowman[buttons=red]
\end{tcblisting}

The biggest enemy of the snowman are raising temperatures:
\begin{tcblisting}{}
\snowman[globalwarming,tophat]
\end{tcblisting}

To view the snowman from behind:
\begin{tcblisting}{}
\snowman[back]
\end{tcblisting}

Finally the key \lstinline|3D| will make the snowman 3-dimensional:
\begin{tcblisting}{}
\snowman[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\snowman[contour=black]
\end{tcblisting}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Random Tikzling 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section[Ti\emph{k}Zling]{... , the Ti\emph{k}Zling}

\emph{The inventor of the word \tikzlings has yet to come up with a name for the Ti\emph{k}Zling}

\subsection{Package name}

\begin{tcolorbox}[lower separated=false, lefthand width=.8\linewidth]
\vspace*{0.5cm}
\lstinline|\usepackage{tikzlings}|
\vspace*{0.5cm}
\end{tcolorbox}

\subsection{Basic Usage}

\begin{tcblisting}{}
\tikzling
\end{tcblisting}

\subsection{Options}

Only options common for all \tikzlings are supported for the \lstinline|\tikzling|. These are the ability to change the body colour
\begin{tcblisting}{}
\tikzling[body=blue]
\end{tcblisting}

to view the \tikzlings from behind
\begin{tcblisting}{}
\tikzling[back]
\end{tcblisting}

and the \lstinline|3D| key, which will make the Ti\emph{k}Zlings 3-dimensional:
\begin{tcblisting}{}
\tikzling[3D]
\end{tcblisting}

And finally the \lstinline|contour| key will only draw the outlines:
\begin{tcblisting}{}
\tikzling[contour=black]
\end{tcblisting}

If an option of a specific tikzlings is used (for example \lstinline|sleeping| which only the koala and sloth can do) this only works if you are lucky and one of them is drawn, in all other cases it will result in an error. 

In addition all usual \TikZ and \lstinline|pgf| keys can be used in the optional argument as well as the accessories presented in the following section.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Accessories 
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
\section{Accessories}

To customise the \tikzlings the package provides a number of accessories which can be added to all the \tikzlings simply by adding the respective keyword as optional argument:

\begin{tcblisting}{}
\bear[hat]
\end{tcblisting}
 
For most of these items, the colour can be customised:

\begin{tcblisting}{}
\koala[crown=orange!50!yellow]
\end{tcblisting}

Unfortunately it is very difficult to create accessories that will fit all the different shapes of the \tikzlings. Therefore it is also possible to add them separately as optional argument of the \lstinline|\thing| macro, which allows more control of their size and placement:

\begin{tcblisting}{}
\owl
\thing[tophat,scale=1.5,yshift=-0.6cm,xshift=-0.05cm]
\end{tcblisting}

A list of all available accessories is given below. For completeness the default colours for each key are shown, but actually it is unnecessary unless it should be changed. In case more than one key is shown, all but the first are optional.

\subsection{Hats}

\begin{tcblisting}{}
\penguin[
  hat=blue!40!black
]
\end{tcblisting}

\begin{tcblisting}{}
\snowman[
  tophat=black!90!white
]
\end{tcblisting}

\begin{tcblisting}{}
\mouse[
  beret=black
]
\end{tcblisting}

\begin{tcblisting}{}
\anteater[
  strawhat=blue,
  ribbon=black
]
\end{tcblisting}

\begin{tcblisting}{}
\coati[
  harlequin=blue,
  niuqelrah=red
]
\end{tcblisting}

\begin{tcblisting}{}
\cat[
  witch=gray
]
\end{tcblisting}

\begin{tcblisting}{}
\bear[
  magichat=violet,
  magicstars=yellow!80!brown
]
\end{tcblisting}

\begin{tcblisting}{}
\sheep[
  crown=yellow!90!orange
]
\end{tcblisting}

\begin{tcblisting}{}
\koala[
  queencrown=yellow
]
\end{tcblisting}

\begin{tcblisting}{}
\marmot[
  kingcrown=gray
]
\end{tcblisting}

\begin{tcblisting}{}
\mouse[
  santa=red!80!black
]
\end{tcblisting}

\begin{tcblisting}{}
\bear[
  chef=gray!20!white
]
\end{tcblisting}

\begin{tcblisting}{}
\snowman[
  graduate=black,
  tassel=red
]
\end{tcblisting}

\begin{tcblisting}{}
\penguin[
  alien=green
]
\end{tcblisting}

\subsection{Communication}

\begin{tcblisting}{}
\coati[
  book={\tiny\TeX},
  bookcolour=brown
]
\end{tcblisting}

\begin{tcblisting}{}
\pig[
  signpost={\TeX},
  signcolour= brown!50!black,
  signback=green!40!black
]
\end{tcblisting}

\begin{tcblisting}{}
\bear[
  speech={\TeX},
  bubblecolour=gray!30!white
]
\end{tcblisting}

\begin{tcblisting}{}
\penguin[
  think={\TeX},
  bubblecolour=gray!30!white
]
\end{tcblisting}

\subsection{Food}

\begin{tcblisting}{}
\koala[
  pizza
]
\end{tcblisting}

\begin{tcblisting}{}
\mouse[
  cheese=yellow!30!orange!60!white
]
\end{tcblisting}

\begin{tcblisting}{}
\coati[
  baguette=brown
]
\end{tcblisting}

\begin{tcblisting}{}
\moles[
  cake=violet
]
\end{tcblisting}

\begin{tcblisting}{}
\marmot[
  icecream=brown!60!gray,
  flavoura=brown!50!black,
  flavourb=white!70!brown,
  flavourc=red!50!white
]
\end{tcblisting}

\begin{tcblisting}{}
\penguin[
  milkshake=red!20!white
]
\end{tcblisting}

\begin{tcblisting}{}
\owl[
  wine=red!70!black
]
\end{tcblisting}

\subsection{Sports}

\begin{tcblisting}{}
\coati[
  cricket=brown
]
\end{tcblisting}

\begin{tcblisting}{}
\bee[
  hockey=brown
]
\end{tcblisting}

\begin{tcblisting}{}
\squirrel[
  football=white
]
\end{tcblisting}

\subsection{Other items}

\begin{tcblisting}{}
\marmot[
  crystalball=cyan
]
\end{tcblisting}

\begin{tcblisting}{}
\bear[
  magicwand
]
\end{tcblisting}

\begin{tcblisting}{}
\coati[
  rollingpin=brown
]
\end{tcblisting}

\begin{tcblisting}{}
\penguin[
  lightsaber=green
]
\end{tcblisting}

\begin{tcblisting}{}
\snowman[
  torch=gray
]
\end{tcblisting}

\begin{tcblisting}{}
\mouse[
  basket=brown!70!gray
]
\end{tcblisting}

\begin{tcblisting}{}
\sloth[
  easter=brown!70!gray,
  egga=blue,
  eggb=green,
  eggc=red
]
\end{tcblisting}

\begin{tcblisting}{}
\koala[
  crozier=brown
]
\end{tcblisting}

\begin{tcblisting}{}
\snowman[
  shovel=gray
]
\end{tcblisting}

\begin{tcblisting}{}
\penguin[
  pickaxe=gray
]
\end{tcblisting}

\begin{tcblisting}{}
\rhino[
  umbrella=cyan
]
\end{tcblisting}

\begin{tcblisting}{}
\marmot[
  umbrellaclosed=cyan
]
\end{tcblisting}

\begin{tcblisting}{}
\mouse[
  handbag=red!70!black
]
\end{tcblisting}

\begin{tcblisting}{}
\bear[
  cocktail
]
\end{tcblisting}

\end{document}