</ItemGroup>

  <PropertyGroup>
    <Description>D&amp;D simulation utilities</Description>
    <Authors>Murphy</Authors>
    <Copyright>Copyright ⓒ 2019-2020 Thomas C. Chust</Copyright>
    <PackageTags>f#;fsharp;d&amp;d;dungeons;dragons;rpg;role;playing;game;simulation;statistics</PackageTags>
    <PackageProjectUrl>https://chust.org/repos/dragondice</PackageProjectUrl>
    <PackageLicenseUrl>https://chust.org/repos/dragondice/doc/tip/LICENSE.txt</PackageLicenseUrl>
    <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
  </PropertyGroup>

</Project>

# README #

*DragonDice* is a small utility library that helps with the simulation and statistical evaluation of actions in the [Dungeons & Dragons](https://dnd.wizards.com/) roleplaying game, specifically using the 5th edition of the rules as described in the [Systems Reference Document](https://dnd.wizards.com/articles/features/systems-reference-document-srd).

In addition to the core library, a [Telegram](https://telegram.org/) bot exposes the functionality for interactive use.

### Installation ###

You can install the *DragonDice* library via [NuGet](https://www.nuget.org/packages/Murphy.DragonDice/) or use the [DragonDice Bot](https://telegram.me/dragon_dice_bot) interactively.

To build *DragonDice* from [source](https://chust.org/repos/dragondice) you will need an F# 4.5 compiler (or newer) and a .NET development environment. The `.sln` and `.fsproj` files in the source directories should be understood by [.NET Core](https://dotnet.microsoft.com/) command line tools, [MSBuild](https://github.com/Microsoft/msbuild) or IDEs such as [VSCode](https://code.visualstudio.com/), [VisualStudio](https://www.visualstudio.com/), or [Rider](https://www.jetbrains.com/rider/).

### Usage ###


Here's a brief example for using the *DragonDice* library:


```.fsharp
#r "Murphy.DragonDice"
open System
open Murphy.DragonDice
open Murphy.DragonDice.UnitSystem

let chr = Character(Name = "Joe Sixpack", Race = "Human")
chr.Abilities <- EnumMap [
  Ability.Dexterity,      17
  Ability.Constitution,   12
  Ability.Intelligence,   20
  Ability.Charisma,       16
]
chr.Proficiencies <- chr.Proficiencies.With [
  Skill.Acrobatics,        1
  Skill.SleightOfHand,     1
  Skill.Arcana,            1
  Skill.Perception,        1
]
chr.AddLevel(Profession.Fighter)
chr.AddLevel(Profession.Sorcerer, count = 4)

let chk = chr.GetCheck(Ability.Dexterity, Difficulty.Easy)
Check.estimate chk
|> printfn "estimate -> %A"

let rng = Random()
Check.simulate rng chk
|> printfn "simulate -> %A"
```

### License ###

Copyright ⓒ 2019-2020 by Thomas C. Chust.

Licensed under the [Apache License, Version 2.0](LICENSE.txt) (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.