\documentclass{article}

% #-----------------------------------------------------#
%             beamertheme-geode package
%                    by Camille Jaret
%   under the LaTeX Project Public License 1.3c
% #-----------------------------------------------------#

\usepackage[hidelinks]{hyperref}
\usepackage{graphicx}
\usepackage{xcolor}


\title{\textbf{\emph{beamertheme-geode} package documentation}}
\author{Camille Jaret (\textcolor{blue}{\href{mailto:camille.jaret1@gmail.com}{camille.jaret1@gmail.com}})}
\date{16 May 2026}



\begin{document}
  \maketitle
  \tableofcontents
\section*{Introduction}
  \emph{geode} is a beamer package aiming to change the default theme to a new, modern look  with a diversity of colour tones. All illustrations are derivatives from the \texttt{geode-example.tex} file provided along the package. 
\section{Installation}
  \emph{geode} can be installed on \LaTeX \ like any other package using \texttt{\textbackslash usepackage\{beamertheme-geode\}}.
\section{Dependencies}
	\emph{geode} requires the following packages to work properly : 
	\begin{itemize}
	  \item Tikz
	  \item xcolor
	  \item helvet
	\end{itemize}
\section{Subthemes}
  \emph{geode} currently offers two ways to modify the default look of beamers using the following options : resolution and colour.
\subsection{Resolution}
  The resolution determine the amount of polygons of the background and surrounding elements. Three settings are available at this time : 
  \begin{itemize}
    \item \texttt{default} - the default value, for a better visual effect;
    \item \texttt{lowpoly} - a simplified background for a more minimalistic aspect;
    \item \texttt{ultralowpoly} - a very simplified effect (fastest compilation time);
    \item \texttt{highpoly} - a more complex tesselation (may increase processing time).
  \end{itemize}
  \begin{center}
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-amethyst_title.png}\\
        \footnotesize{default setting}
      \end{center}
    \end{minipage}
    \hfill
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-highpoly.png}
         \footnotesize{\texttt{highpoly} setting}
       \end{center}
    \end{minipage}
    \\
    \vfill
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-lowpoly.png}
         \footnotesize{\texttt{lowpoly} setting}
      \end{center}
    \end{minipage}
    \hfill
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-ultralowpoly.png}
          \footnotesize{\texttt{ultralowpoly} setting}
        \end{center}
    \end{minipage}
  \end{center}
  
\subsection{Colour palettes}
  The currently available colour palettes are showcased below along the name of their option.
  \begin{center}
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-amethyst_page.png}\\
        \footnotesize{\texttt{amethyst} palette}
      \end{center}
    \end{minipage}
    \hfill
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-obs_page.png}\\
        \footnotesize{\texttt{obs} palette}
      \end{center}
    \end{minipage}
    \vfill
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-phos_page.png}\\
         \footnotesize{\texttt{phos} palette}
       \end{center}
    \end{minipage}
    \hfill
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-citrine_page.png}\\
         \footnotesize{\texttt{citrine} palette}
       \end{center}
    \end{minipage}
    \vfill
    \begin{minipage}{5.5cm}
      \begin{center}
        \includegraphics[scale=0.3]{geode-diamond_page.png}\\
         \footnotesize{\texttt{diamond} palette}
       \end{center}
    \end{minipage}
    \hfill
    \begin{minipage}{5.5cm}
    \begin{center}
        \includegraphics[scale=0.3]{geode-pinkquartz_page.png}\\
        \footnotesize{\texttt{pquartz} palette}
        \end{center}
    \end{minipage}    
  \end{center}
  The colours of the presentation can be accessed through their names : \texttt{bg1},\texttt{bg2},\texttt{bg3},\texttt{bg4} correspond to background colour in order of brightness, \texttt{accent} is the colour of titles, and \texttt{geode} is the colour of some background elements.
  \\Further customisation is available through the \texttt{\textbackslash custompalette} macro detailed in the next section.
\section{Macros}
\subsection{Presentation}
	Presentation macros are meant to make your life slightly easier when giving form to your beamer document.
	\begin{itemize}
	  \item \texttt{\textbackslash geotitle} - inserts a title card in your presenation;
	  \item \texttt{\textbackslash geosection} - inserts a section card in your presenation;
	  \item \texttt{\textbackslash geosubsec} - inserts a subsection card in your presenation.
	\end{itemize}
\subsection{Custom colour palette}
	In order to modify key colours of the presentation theme, the following macros are available : 
	\begin{itemize}
	  \item \texttt{\textbackslash custompalette\{element\}\{r\}\{g\}\{b\}} - the \texttt{r,g,b} commponents will affect the hue of the desired  \texttt{element} of the current palette. \emph{Note that the rgb chanels take values between 0 and 1}
	\end{itemize}
	The editable elements are defined as follows, disinguished in two categories : \\
	  \begin{itemize}
	    \item Overall modifiers :
		  \begin{itemize}
		    \item \texttt{background} - hue of the background tesselation
		    \item \texttt{tone} - hue of the important texts, as well as headline and footline
		  \end{itemize}
		  \item Specific modifiers :
		  \begin{itemize}
		    \item \texttt{bg1}, \texttt{bg2}, \texttt{bg3}, \texttt{bg4} - colours for the background. (\texttt{bg1} is highlighted in yellow bellow).
		    \item \texttt{accent} - colour of the most important text
		    \item \texttt{geode} - colour of some background elements
		    \item \texttt{dots} - colour of the bullet points (set to \texttt{accent} by default, and should be changed if the latter is set to a light colour)
		   \end{itemize}
		 \end{itemize}

	   \begin{center}
	    \includegraphics[scale=0.6]{geode-title_c1_highlight.png}
	   \end{center}

The sleleton for a color theme is as follows : \\

\texttt{
\% Theme colours \\
\textbackslash definecolor\{accent\}\{rgb\}\{0,0,0\} \\
\textbackslash definecolor\{geode\}\{rgb\}\{0,0,0\} \\
\textbackslash definecolor\{dot\}\{rgb\}\{0,0,0\} \\
\\
\% Background \\
\textbackslash definecolor\{bg1\}\{rgb\}\{0,0,0\} \\
\textbackslash definecolor\{bg2\}\{rgb\}\{0,0,0\} \\
\textbackslash definecolor\{bg3\}\{rgb\}\{0,0,0\} \\
\textbackslash definecolor\{bg4\}\{rgb\}\{0,0,0\} \\
}

By naming the file \texttt{beamercolorthemegeode-mytheme.sty}, it  can be called within a beamer document using \texttt{\textbackslash usecolortheme\{geode-mytheme\}} to more easily use the same layout over multiple documents. 
Additionally, the package's \textcolor{blue}{\href{https://github.com/camillejaret/geode/tree/main}{Github page}} feature a 'palette submissions' folder where custom palettes can be added, so that they can be implemented in latter versions of the package.

\end{document}