Skip to content

User Guide

Dasho edited this page Jan 22, 2021 · 1 revision

Short Introduction

D&D//DNK is an open-source website (Licensed under the MIT license) which is designed to be able to be used by anyone who wishes to curate the content of their D&D 5e books in a simplified digital manner, (online or on their local computers or ... if you're a bit of coder ... customized on their own private or public websites for their and their player's use.)

The site is developed to help provide an easier means to search and work with the resources users already own IRL (in real life). Allowing a player or DM to carry all their books and supplements on their laptop even if they do not have internet access wherever they are.

If you are developer, please see this page if you wish to contribute time to a project.

Where to start...

You're likely here because you've found the site, and want to do "x" with it and want to know how to do it. or you tried to do "x" with and it's not working. So, for that here's a direct link to where you likely want to go...

History

Lol, I'm just fooling ya, there's no history!

Code

The public Github (which is the most updated code) is the best place to get the code. Go to the releases tab to find it. I only have v3 and greater versions of the site. v1 and v2 are lost to time.

As previously mentioned the site and its code are opensource and released under the MIT license. Which (paraphrased) means you are welcome to use it, modify it, distribute it, and build from it.

Page Layout

The website's content is mostly shown in a pretty consistent format, depending upon the topic/subject. Below are the options with which you can familiarize yourself with those, the common layout and the features around such.

Website Navbar

navbarimg The Navbar appears at the top of most of the pages on the site and helps quickly navigate between its features, and will help (at a glance) identify what page you are on, and even give some specific advice for its use, and a link to the wiki for the site's feature(s).

OmniSearch

omnisearchimg Virtually every page (the DM Screen being the obvious exclusion) will have the omnisearch box. Denoted by box on the right side of the navbar, with the words "Search everywhere..." The Omnisearch box searches the dataset's titles for matching content. It does not search the description (ie Fluff) text, but rather focuses upon key data fields in Monster, Items, Tables, Rules, Feats, etc. fields like title, name.

Dice Utility

At the bottom of most pages, there will be this icondiceutilityimg. When it is clicked (as the animation shows) it will open a small window which can be used to either roll or return the results of actions triggered by clicking other elements of the site. (usually triggered by a link on the page that most often looks like 2d10. (There are some instructions on how to do this within the JSON data in the Renderer Demo should you want to enable this for your own documents - see Homebrew.

The roller uses the common format for dice rolling (that being d where is the number of dice rolled number of times. The results of the roll(s) is(are) presented to the roller window with separate entries and then the sum of the rolls are calculated as well.

Clone this wiki locally