AdvancedDiceAndCoins 1.1.5

AdvancedDiceAndCoins

Proudly* presenting my first package, designed for simulating all kinds of dice rolls. My friends and family have told me it’s great! Give it a roll! (sorry) Your feedback is welcome. (appreciate gentle ones)

Usage/Examples

using AdvancedDiceAndCoins;

//Roll class
//Easiest way to imitate a Roll:
int attack = Roll.D20; //D4, D6, D8, D10, D12, D100 supported as well
int attackAgainstProne = Roll.D20WithAdvantage;  //Roll.D20WithDisadvantage supported

//Roll for stats  -> character creation
//Rolling 6 times with 4D6, drop the lowest, and adding the 3 remainig. Return a List with 6 numbers. Range from 3-18
List<int> abilityScores = Roll.ForStats;


//Dice class - How to initialize - IMPORTANT only 1 dice... 
//So for 2D6 => create 2 dice or use DiceSet, or create a D6 and use RollOfMany() method. 
//LastRoll is 0, until first Roll();

Dice swordDamage = new("D8+2"); //D8 + 2
Dice maceDamage = new(6); //D6
Dice player1Attack = new(20, 8); // numberOfSides, modifier => D20 + 8
Dice daggerOfMinimumTwoDamage = new(2, 6, 0); //smallestNumber, largestNumber, modifier
//valid strings: new("d6"), new("d12 + 3"), new("D20-2") etc.

//Dice class - How to use it? 
int orcHP = 20;
orcHP -= swordDamage.Roll();

//available methods: Roll(), RollOfAdvantage(), RollOfDisadvantage(), RollOfMany(), 
//stat methods: GetAvarage(), GetMode(), GetMedian()
//properties: LastRoll => you can check the result of last Roll() or RollOfAdvantage()...

//Dice class - RollOfMany()
int maceDamageThreeTimes = maceDamage.RollOfMany(3); // Rolls: 4 + 3 + 2 return 9, 
                                                     // but IMPORTANT LastRoll will be 2!

//Dice class - ToString()
Console.WriteLine(swordDamage); //=> D8 + 2

//Misc
Dice a = new(6);
Dice b = new(6);
a.Roll();
b.Roll();
int resultAdd = a + b;  //a.LastRoll + b.LastRoll
int resultSub = a - b;  //a.LastRoll - b.LastRoll
int resultMult = a * b;  //a.LastRoll * b.LastRoll
float resultDiv = a / b;  //a.LastRoll / b.LastRoll
if (a < b)  //a.LastRoll < b.LastRoll 
{
   Console.WriteLine("*: should be more modest");
}
if (a == b) //a.LastRoll == b.LastRoll
{
   a.Roll();
}

//Dice class Equals => if smallest number, largest number, modifiers are equals! 
//D6 != D6 + 2; D8 + 7 == D8 + 7;

//Dice stats
//includes: 
//all Roll(), if parameter createStat is true. (default param)
//RollOfAdvantage() & RollOfDisadvantage() only best / worst roll count. 
//RollOfMany() all counts. 
//RollOfLowest() / RollOfHighest() only selected count.

Dice diceForStats = new("d6");
diceForStats.RollOfMany(100);
Console.WriteLine(diceForStats.GetAvarage());  //Avarage of 100 rolls (D6)
Console.WriteLine(diceForStats.GetMedian());   //Median of 100 rolls (D6)
Console.WriteLine(diceForStats.GetMode());     //Mode of 100 rolls (D6)



//DiceSet class the purpose of the class to contain more (even mixed) dice 
//and able to roll them at once
//How to initialize
DiceSet diceSet = new();
diceSet.Add(swordDamage);
diceSet.Add(maceDamage); //=> diceSet is now: D8 + 2 + D6;

DiceSet redDragonBreath = new("18D6");
//valid strings: new("6d6"), new("4d12 + 3"), new("2D20-2") etc. 
//if modifier provided eg. 3D6+5 => D6, D6, D6+5 will be created. 

Dice smokeDamage = new(4);
redDragonBreath.Add(smokeDamage) // it is now 18D6 + D4 (just in case)


//How to use
int playerHP = 20;
playerHP -= redDragonBreath.Roll();
int swordPlusMaceDamage = diceSet.Roll(); //=> Roll with D8+2+D6;

//available method: Roll(), Clear()
//properties: LastRoll where the result of last Roll() is stored, by default it's 0.


//You can add DiceSets
DiceSet whiteDragonBreath = new("12D8");
DiceSet notYourLuckyDay = redDragonBreath + whiteDragonBreath; 
//new DiceSet with 18D6 + 12D8 + D4 (almost forgot the smokedamage)


//You can check your DiceSet
Console.WriteLine(notYourLuckyDay); //=> D6, D6, D6 ... D8, D8, D8, ... D4   

//You can Clear() a DiceSet removing all Dice from it. Important! LastRoll remains unchanged.


//Coin class
Coin coin = new();
coin.Flip(); // returns with a string Heads or Tails (same as Flip())
coin.Toss(); // returns with a string Heads or Tails (same as Toss())
Console.WriteLine(coin.NumberOfTails);

//properties: NumberOfTails, NumberOfHeads ... for statistical purposes.

Console.WriteLine(coin); // Shows statistic

//CoinAdvanced class
//It's a Coin but you can name the 2 choices.
CoinAdvanced shallWeTrustHer = new("We can trust her", "She is lying"); //choiceA, choiceB
shallWeTrustHer.Flip();
shallWeTrustHer.Toss();
Console.WriteLine(shallWeTrustHer); // Shows statistic
Console.WriteLine(shallWeTrustHer.Decision()); 
//Outcomes => We can trust her / She is lying / No idea (in case of a tie)

//methods: Flip(), Toss(), Decision()
//properties: ChoiceA, ChoiceB, CountChoiceA, CountChoiceB


//LeftOrRight / TrueOrFalse Class

Console.WriteLine(LeftOrRight.Decide()) //=> returns Left / Right 
Console.WriteLine(TrueOrFalse.Decide()) //=> returns bool true / false 

Roadmap

Collecting and evaluating DiceSet statistics. (avarage, mode, median)

Authors

• @Kapeller Zoltán

Feedback

If you have any feedback, please reach out at ifigazsisp@gmail.com

License

MIT License

Copyright (c) 2024, Zoltán Kapeller

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.