cvd is a LaTeX package for simulating color vision deficiency.
The package is not yet on CTAN, so you need to install it from source. Assuming you have l3build installed as well as an up-to-date LaTeX distribution, you can install cvd by running:
git clone https://github.com/jolars/cvd.git
cd cvd
l3build installcvd requires LuaTeX to work and currently supports
- any colors defined with
\textcolor,\colorbox,\fcolorbox, etc. - PDF images included with
\includegraphics
Raster images are optionally supported via a custom script, but this requires
compiling LuaTeX with the --shell-escape flag enabled.
%! TEX program = luatex
\documentclass{article}
\usepackage{graphicx}
\usepackage{cvd}
\cvdtype{deuteranopia}
\cvdseverity{0.9}
\begin{document}
\subsection{Basic Colors}
\textcolor{red}{Red text} and \textcolor{green}{green text} and \textcolor{blue}{blue text}.
\textcolor{orange}{Orange}, \textcolor{purple}{purple}, \textcolor{cyan}{cyan}.
\subsection{Color Boxes}
\fcolorbox{black}{red}{\color{white} Red Box}
\fcolorbox{black}{green}{\color{white} Green Box}
\fcolorbox{black}{blue}{\color{white} Blue Box}
\subsection{Custom RGB Colors}
\definecolor{myred}{rgb}{0.8, 0.1, 0.1}
\definecolor{mygreen}{rgb}{0.1, 0.8, 0.1}
\definecolor{myblue}{rgb}{0.1, 0.1, 0.8}
\textcolor{myred}{Custom red}, \textcolor{mygreen}{custom green}, \textcolor{myblue}{custom blue}.
\subsection{Severity Test}
Normal text in black.
\cvdseverity{0.5}
\textcolor{red}{Red at 50\% severity} and \textcolor{green}{green at 50\% severity}.
\cvdseverity{1.0}
\textcolor{red}{Red at 100\% severity} and \textcolor{green}{green at 100\% severity}.
\subsection{Disable/Enable}
\cvddisable
CVD disabled - \textcolor{red}{normal red} and \textcolor{green}{normal green}.
\cvdenable
CVD enabled - \textcolor{red}{simulated red} and \textcolor{green}{simulated green}.
\cvdseverity{0.85}
\cvdtype{protanopia}
\cvdincludegraphics{test-image.pdf}
\end{document}Contributions are welcome!
Also, when writing commit messages, please use the conventional commits format.
The project uses semantic versioning.