@randsum/fifth 0.11.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -13
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -60,29 +60,19 @@ meetOrBeat(15, rollArg) // Returns true if roll meets or exceeds DC 15
|
|
|
60
60
|
|
|
61
61
|
## API Reference
|
|
62
62
|
|
|
63
|
-
### `
|
|
63
|
+
### `d20Roll`
|
|
64
64
|
|
|
65
65
|
Makes a d20 roll following 5th Edition rules.
|
|
66
66
|
|
|
67
67
|
```typescript
|
|
68
|
-
const result =
|
|
68
|
+
const result = d20Roll({
|
|
69
69
|
modifier: 5, // the result of your bonuses after all bonuses are applied
|
|
70
70
|
rollingWith: "Advantage" // Optional
|
|
71
71
|
})
|
|
72
72
|
// Returns a roll result with total and details
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
Checks if a roll meets or exceeds a Difficulty Class (DC).
|
|
78
|
-
|
|
79
|
-
```typescript
|
|
80
|
-
const success = meetOrBeat(15, {
|
|
81
|
-
modifier: 5,
|
|
82
|
-
rollingWith: "Advantage"
|
|
83
|
-
})
|
|
84
|
-
// Returns true if roll + modifier meets or exceeds 15
|
|
85
|
-
```
|
|
75
|
+
We also export the `roll` and `meetOrBeat` functions from `@randsum/roller` for your convenience.
|
|
86
76
|
|
|
87
77
|
## Related Packages
|
|
88
78
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@randsum/fifth",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.12.0",
|
|
4
4
|
"description": "A flexible, type-safe dice roller for building 5E-compatible applications",
|
|
5
5
|
"private": false,
|
|
6
6
|
"author": {
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"sideEffects": false,
|
|
29
29
|
"type": "module",
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@randsum/roller": "~0.
|
|
31
|
+
"@randsum/roller": "~0.12.0"
|
|
32
32
|
},
|
|
33
33
|
"exports": {
|
|
34
34
|
".": {
|