Metadata-Version: 2.1
Name: pyroll20
Version: 0.1.9
Summary: A light, Roll20 syntax compatible, python dice roller
Home-page: https://github.com/NoPantsCrash/pydice
Author: george
Author-email: abtziangiorgos@gmail.com
License: GNU GENERAL PUBLIC LICENSE v3
Description: # PyRoll20
        <p align="center">
        
        An easy to use, Roll20 syntax compatible,python dice roller. 
        </p>
        
        ### Installing
        ```bash
        pip3 install pyroll20
        ```
        
        ### Usage Example
        
        ```python
        from pyroll20.pyroll20 import roll
        
        print(roll(user_input="2d20"))
        
        >> [12,8]
        ```
        or with a modifier
        ```python
        from pyroll20.pyroll20 import roll
        
        print(roll(user_input="2d20+5"))
        
        >> 23 
        ```
        
        ### Modifiers
           **'h'** # Highest Rolls - **5d20h3** returns the 3 highest rolls from the five d20 that were rolled.<br/>
           **'l'** # Lowest Rolls - **5d20l3** returns the 3 lowest rolls from the five d20 that were rolled.<br/>
           **'+'**  # Adds to sum - **5d20+3** adds 3 to the sum of the five d20 that were rolled, always returns a single integer.<br/>**'-'**  # Subtracts from sum - **5d20-3** subtracts 3 from the sum of the five d20 that were rolled, always returns a single integer.<br/>
           **'.-'**  # Subtracts from each individual roll - **5d20.-3** subtracts 3 from each of the five d20 that were rolled.<br/>
           **'.+'**  # Adds to each individual roll - **5d20.+3** adds 3 to each of the five d20 that were rolled.<br/>
           **'t'**  # Sum of all rolls - **5d20t** returns the sum of the five d20 that were rolled.<br/>
           **'e'**  # "Exploding dice - **5d20e** if any of the five rolls goes critical, it gets re-rolled and added to the individual roll. <br/>
        <br/>
        
        
        ## Notes
        If sides are provided but no roll number, the roll number defaults to 1, for example **d20** is a valid input.<br/>
        
        
        
        ## License
        This project is licensed under the GNU GENERAL PUBLIC LICENSE v3.<br/>
        
        ### TODO
        Advantage and disadvantage[Not working]
        Wrap it in some sort of gui for a standalone app.[Maybe]
        
        
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
