diceRolls

package module

v0.0.0-...-6938628 Latest Latest Go to latest Published: Aug 4, 2022 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Simple dice rolling library.

The main entrypoint to the library is the diceRolls.Parse function:

func Parser(expression string) (Result, error)

Result has to methods:

Result.Value() int - evaluate parsed expression and roll dices. Dice are rolled on each call.
Result.Description(detailed bool) string - return string representation of expression. If detailed == true it will include dice results in square brackets.

This section is empty.

This section is empty.

This section is empty.

type Result interface {
	Value() int
	Description(bool) string
}

func Parser(expression string) (Result, error)

func RollDiceNotation(notation string) (Result, error)

func RollSimpleDice(n, k int) (Result, error)

RollSimpleDice rolls k-side dice n times and return sum of result If times is negative returns error If sides is negative returns error

Path	Synopsis
cmd