{"id":14980538,"url":"https://github.com/rpgtex/dnd-5e-latex-template","last_synced_at":"2025-04-11T03:28:58.026Z","repository":{"id":28543052,"uuid":"32060157","full_name":"rpgtex/DND-5e-LaTeX-Template","owner":"rpgtex","description":"LaTeX package to typeset material for the fifth edition of the \"world's greatest roleplaying game\".","archived":false,"fork":false,"pushed_at":"2024-12-17T21:51:49.000Z","size":21280,"stargazers_count":1485,"open_issues_count":21,"forks_count":317,"subscribers_count":51,"default_branch":"dev","last_synced_at":"2025-04-03T19:51:08.537Z","etag":null,"topics":["dnd","dnd5e","dungeons-and-dragons","latex","latex-template","rpg","tex"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rpgtex.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-03-12T06:06:49.000Z","updated_at":"2025-03-28T20:11:24.000Z","dependencies_parsed_at":"2024-09-24T05:01:52.650Z","dependency_job_id":"e1b98ffc-3485-46b6-a21a-8aada040eb62","html_url":"https://github.com/rpgtex/DND-5e-LaTeX-Template","commit_stats":{"total_commits":300,"total_committers":35,"mean_commits":8.571428571428571,"dds":0.7133333333333334,"last_synced_commit":"fd317e0507a09c6bb3741232b1842df36c18ccb3"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpgtex%2FDND-5e-LaTeX-Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpgtex%2FDND-5e-LaTeX-Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpgtex%2FDND-5e-LaTeX-Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rpgtex%2FDND-5e-LaTeX-Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rpgtex","download_url":"https://codeload.github.com/rpgtex/DND-5e-LaTeX-Template/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248335165,"owners_count":21086528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dnd","dnd5e","dungeons-and-dragons","latex","latex-template","rpg","tex"],"created_at":"2024-09-24T14:01:57.480Z","updated_at":"2025-04-11T03:28:57.996Z","avatar_url":"https://github.com/rpgtex.png","language":"TeX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DnD 5e LaTeX Template\n\n[![Latest release](https://img.shields.io/github/release/rpgtex/DND-5e-LaTeX-Template/all.svg)](https://github.com/rpgtex/DND-5e-LaTeX-Template/releases/latest)\n[![Build Status](https://img.shields.io/circleci/project/github/rpgtex/DND-5e-LaTeX-Template/master.svg?style=flat)](https://circleci.com/gh/rpgtex/DND-5e-LaTeX-Template)\n\nThis is a LaTeX template for typesetting documents in the style of the fifth edition of the \"world's greatest roleplaying game\".\n\n## Features\n\n* Color schemes, fonts, and layout are close to the core books (but not exactly the same).\n* TeX Live includes the default fonts.\n* Works with pdfTeX, LuaTeX, and XeTeX.\n\n![Preview](scrot.jpg)\n\n## Installation\n\nThere are three options for using this project; choose the one that's\nright for you.\n\n### User install using `TEXMFHOME` (recommended)\n\nThis will install the template for your current user in one of the following locations:\n\n* Linux: `~/.texmf/tex/latex`\n* OS X / macOS: `~/Library/texmf/tex/latex`\n* Windows: `C:\\Users\\{username}\\texmf\\tex\\latex`\n\nLaTeX will find the package automatically.\n\n1. Prepare your `TEXMFHOME` directory.\n\n    ```sh\n    mkdir \"$(kpsewhich -var-value TEXMFHOME)/tex/latex/\"\n    ```\n\n2. Download the [latest release](https://github.com/rpgtex/DND-5e-LaTeX-Template/releases/latest) and extract it in `$TEXMFHOME/tex/latex/`.\n\n    ```sh\n    wget https://github.com/rpgtex/DND-5e-LaTeX-Template/archive/master.zip\n    unzip -d \"$(kpsewhich -var-value TEXMFHOME)/tex/latex/\" master.zip\n    cd \"$(kpsewhich -var-value TEXMFHOME)/tex/latex/\"\n    mv DND-5e-LaTeX-Template-master dnd\n    ```\n\n    Alternatively, clone the repo to the same location:\n\n    ```sh\n    git clone https://github.com/rpgtex/DND-5e-LaTeX-Template.git \"$(kpsewhich -var-value TEXMFHOME)/tex/latex/dnd\"\n    ```\n\n### Using Overleaf\n\n[Overleaf](https://overleaf.com) is an online TeX editor -- think\nabout it like Google Docs for TeX documents.  This option does not\nrequire a local TeX installation and is an ideal approach for one-off\nprojects.\n\n1. Download this GitHub repository as a ZIP archive using the *Clone\n   or download* link above.\n2. On Overleaf, click the *New Project* button and select *Upload\n   Project*.  Upload the ZIP archive you downloaded from this\n   repository.\n\n### Project install using `TEXINPUTS`\n\nYou can also clone a copy of the repository to each LaTeX project. For example, to clone the repository to a `lib/` directory in your project:\n\n```sh\nmkdir lib/\ngit clone https://github.com/rpgtex/DND-5e-LaTeX-Template.git lib/dnd\n```\n\nLaTeX will not find the template automatically. Set `TEXINPUTS` when compiling your project to locate the package:\n\n```sh\nTEXINPUTS=./lib//: pdflatex project.tex\n```\n\n## Usage\n\n### Class (recommended)\n\nLoad the `dndbook` class in your preamble:\n\n```tex\n\\documentclass[10pt,twoside,twocolumn,openany,nodeprecatedcode]{dndbook}\n\n\\usepackage[english]{babel}\n\\usepackage[utf8]{inputenc}\n\n\\begin{document}\n% ...\n```\n\n### Package\n\nYou can also load the `dnd` package directly to use it with another class.\nNote that the package has only been tested with the `book` class.\n\n```tex\n\\documentclass[10pt,twoside,twocolumn,openany]{book}\n\n\\usepackage[english]{babel}\n\\usepackage[utf8]{inputenc}\n\n\\usepackage[layout=true]{dnd}\n\n\\begin{document}\n% ...\n```\n\n### Options\n\n| Option         | Package `dnd`   | Class `dndbook`   |\n| -------------- | :-------------: | :---------------: |\n| `bg`           | ✓               | ✓                 |\n| `justified`    | ✓               | ✓                 |\n| `layout`       | ✓               |                   |\n| `nomultitoc`   | ✓               | ✓                 |\n| `nodeprecatedcode`   | ✓               | ✓                 |\n\nThe `dndbook` class also supports all the options of the `book` class.\n\n#### `bg`\n\nDeclare how to load background and footer images. This is a key-value option with the following possible values:\n\n* `full`: Load both background and footer images. (**default**)\n* `none`: Removes both background and footer images.\n* `print`: Loads only the footer images.\n\n#### `justified`\n\nJustify column copy.\n\n#### `layout`\n\nControls whether loading the `dnd` package also modifies the document layout (geometry, colors, typography, etc.).\nThis is a boolean option with the following possible values:\n\n* `true`: Modify the document layout.\n* `false`: Do not modify the document layout.\n\nThe default value is `true` for backwards compatibility with early releases.\nThis will change in a future release.\n\n#### `nomultitoc`\n\nDisable multi-column table of contents.\n\n#### `nodeprecatedcode`\n\nExcludes all deprecated code from the build process.\n\n## Dependencies\n\nIf you don't have LaTeX installed, we recommend installing a complete [TeX Live distribution](https://www.tug.org/texlive/).\n\n### Ubuntu\n\n```sh\nsudo apt-get install texlive-full\n```\n\n### Arch\n\n```sh\nsudo pacman -S texlive-bin texlive-core texlive-latexextra\n```\n\n### OSX\n\nMacTex has its own [installer](https://www.tug.org/mactex/), but you can install it through brew cask:\n\n#### Full version\n\n```sh\nbrew cask install mactex\n```\n\n#### Slightly smaller version without GUI\n\n```sh\nbrew cask install mactex-no-gui\n```\n\n#### Minimal version\n\nUse `tlmgr` to install packages as needed, see this [answer](https://tex.stackexchange.com/a/470285) for more information\n\n```sh\nbrew cask install basictex\nbrew cask install tex-live-utility\n```\n\nAfter any of this, use the following such that the texlive directory doesn't require admin rights.\n\n```sh\nsudo chown -R myuser:mygroup /usr/local/texlive\n```\n\nFor more information about MacTex permissions, see the following StackExchange [post](https://tex.stackexchange.com/questions/3744/how-do-i-set-up-mactex-so-admin-rights-arent-necessary)\n\n## Known issues and solutions\n\n### Stat block text color does not survive page breaks\n\nThis is a known issue in `tcolorbox`. According to the `tcolorbox` 4.12 manual (p. 363):\n\n\u003e If your text content contains some text color changing commands, your color will not survive the break to the next box.\n\nYou can use LuaTeX to compile the document.\n\n```sh\nlualatex main.tex\n```\n\n### Wrapping `monsterbox` in float disrupts spacing inside stat block\n\nWrapping a `monsterbox` (or `monsterboxnobg`) in a floating figure adds extra space between stat block elements:\n\n```latex\n\\begin{figure}[b]\n  \\begin{monsterbox}{Orc Warden}\n    % ...\n  \\end{monsterbox}\n\\end{figure}\n```\n\nInstead, use the `tcolorbox` `float` parameter:\n\n```latex\n\\begin{monsterbox}[float=b]{Orc Warden}\n  % ...\n\\end{monsterbox}\n```\n\nRefer to the `tcolorbox` documentation (section 4.13) for more float parameters.\n\n## Contributing\n\n### Style\n\nWe use [EditorConfig](https://editorconfig.org/) to enforce consistent formatting.\nInstall the appropriate plugin for your editor.\n\n### Preparing a new release\n\n1. Run `./bin/bump-version` to tag the new version.\n\n    ```sh\n    ./bin/bumpversion \u003cversion\u003e\n    ```\n\n2. Compile the example PDF.\n3. Save the first page of the PDF as scrot.jpg.\n4. Update the change log for the new release; commit your changes.\n5. Push changes.\n\n    ```sh\n    git push \u0026\u0026 git push --tags\n    ```\n\n6. [Create a new release](https://help.github.com/articles/creating-releases/) and attach the PDF and scrot.\n\n## Credits\n\n* Background image from [Lost and Taken](https://lostandtaken.com/)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpgtex%2Fdnd-5e-latex-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frpgtex%2Fdnd-5e-latex-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frpgtex%2Fdnd-5e-latex-template/lists"}