diff --git a/Dice/README.md b/Dice/README.md new file mode 100644 index 0000000..a6d6cdf --- /dev/null +++ b/Dice/README.md @@ -0,0 +1,28 @@ +# Unturf Dice Plugin + +Provides a /roll command for UnturfDiscordBot to roll N dice with D sides (e.g., 2d6). + +## Install (editable) + +```bash +pip install -e ./dice +``` + +## Entry point + +- Group: `unturf_discord.plugins` +- Name: `dice` +- Target: `dice:DicePlugin` + +## Configuration + +Add to `data/plugin_config.json`: + +```json +{ + "dice": { + "enabled": true, + "settings": {"max_dice": 100, "max_sides": 1000} + } +} +```