New dice-rolling app: InfiniDice! #1326

yusufmte · 2022-09-12T14:51:48Z

InfiniDice is a dice-rolling applet where you can roll random numbers from d2 to d99. The functionality is:

Set the number of "sides" of the dice
Roll to randomly generate a result number in the interval from 1 to the number of sides

It starts at d2 (ie coinflip), and when you first open the app, a roll is made, so you get a "free" coinflip. Then you can change the number of sides and use it as a d6, d20, etc. The color of the result alternates with each roll (so that you can be sure it was actually rolled even when the result is the same).

Tested on PineTime hardware with InfiniTime 1.10.0, and found to be in good working order. See video:

infinidice.mp4

I often find myself looking for dice and think this could come in handy for tabletop players :) Any testing, feedback, or suggestions on optimization would be appreciated!

joseph58tech · 2022-09-13T03:25:36Z

I believe this has been implemented before, check #565

minacode · 2022-09-13T10:49:09Z

I like the simple interface and think they solve different problems. Maybe we could have both apps in a world where we are able to choose which apps we want.

NeroBurner

lovely app ❤️

src/displayapp/screens/Dice.h

FintasticMan · 2022-09-13T17:32:41Z

One feature that I think is quite nice to have in a dice app, is being able to specify a number of dice, rather than just always rolling one die. I don't think that for this you would need to show the results of all the dice individually, just the final result.

For the rest I think this app looks good! 👍

minacode · 2022-09-13T19:09:04Z

#565 is doing exactly that already.

FintasticMan · 2022-09-13T19:42:12Z

You're right, it does do that. But it hasn't been updated in quite a while, and so doesn't merge nicely with some of the changes in InfiniTime. The author of that PR also doesn't seem to be very active, so it's uncertain as to whether it will be updated.

minacode · 2022-09-13T20:58:20Z

This problem is fundamental for InfiniTime. We need to fix the app problem.
Shameless plug: #1296

yusufmte · 2022-09-13T21:14:49Z

Thank you @NeroBurner kindly for your improvements on the code ❤️ Thank you everyone for your comments and feedback as well.

@FintasticMan :

One feature that I think is quite nice to have in a dice app, is being able to specify a number of dice, rather than just always rolling one die.

I definitely appreciate your sentiment, rolling multiples is a frequently needed and useful function of dice! 👍 However I tend to agree with @minacode , there's a value to keeping the interface simple and intuitive, and #565 already implements multi-roll in a lovely way. But I might be thinking about ways to implement that smoothly without crowding the UI too much.

yusufmte · 2022-09-15T18:51:20Z

Implemented rolling multiple dice in 52e4af5

(Thanks for the suggestion @FintasticMan ! 👍)

The number of dice can range from 1-9 (default 1), and the sides can range from d2-d99 (default d2). The individual rolls are shown as well. Here's the new look:

As before, any feedback or further suggestions are much appreciated. I'll try to keep it up to date with the official develop branch in the meantime. Thanks everyone :)

yusufmte · 2024-01-10T23:35:33Z

Rebased to 1.14! (Very excited about the customizable user app selection implemented in this version of Infinitime.)

I also want to bump this PR in general. It has been ready for a long time, and continuing to work great in 1.14. The shake-to-roll function implemented by @Poohl has been working super well also. This has probably been my most frequently used of the PineTime user apps, and have used it in a few different circles with very good success. Sometimes I have taken the PineTime off the band and passed it around during a tabletop game for players to roll. There have been numerous other PRs for dice apps in the past, so there is definitely interest in such an app from the PineTime community.

I know there are a lot of PRs to review and a lot of more important work to do for Infinitime in general -- all on a volunteer basis, which I recognize and greatly appreciate! However, can the maintainers weigh in on the plans for this at some point? @JF002 Are there plans to add it to the 1.15 milestone? Thanks! :)

FintasticMan

I really like this app! A couple of concerns: do we really need the C++ random generator, is it that much better than C's rand? Could you try using rand with the bias elimination implemented in #881, and see what the difference in flash usage is? If the difference isn't too big, or if you think that rand really isn't good enough, I'd be very happy to use the better C++ generator.

Another concern is how well the shaking works when lower to sleep is also enabled. Could you check if there are any issues there? (I'm also not a big fan of the hack of enabling shake to wake if it's disabled to get it to work, but I don't think that needs to be solved now)

Thank you so much for this app, it's very nice, and I apologise for how long it's taking.

src/displayapp/screens/Dice.cpp

src/displayapp/screens/Dice.h

src/displayapp/apps/CMakeLists.txt

src/displayapp/screens/Symbols.h

Co-authored-by: FintasticMan <[email protected]>

FintasticMan

Just a couple of things.

src/displayapp/screens/Dice.h

.gitignore

yusufmte · 2024-01-14T20:52:49Z

@FintasticMan thank you for your kind words & thoughtful feedback/review, I really appreciate it!! ❤️ No apology necessary, you folks have been doing amazing work with InfiniTime and I know you have a ton on your plate!

I really like this app! A couple of concerns: do we really need the C++ random generator, is it that much better than C's rand? Could you try using rand with the bias elimination implemented in #881, and see what the difference in flash usage is?

I noticed that rand() is used for RNG in other apps like Paddle and Twos, and so I did initially use it in earlier versions of the Dice. However, there are a few significant flaws with rand() (detailed below) that make it inferior to the C++11 <random> lib. I think that doesn't matter for the other apps mentioned, where the experience is fine as long as it generally feels random-- but for the Dice, since the whole point of the app is randomness, it feels important for the randomness to be very fair / high quality.

(1) According to official docs, rand() is considered deprecated for most needs as it does not guarantee quality of the randomness of the sequence produced. More details here:

There are no guarantees as to the quality of the random sequence produced. In the past, some implementations of rand() have had serious shortcomings in the randomness, distribution and period of the sequence produced (in one well-known example, the low-order bit simply alternated between 1 and 0 between calls). rand() is not recommended for serious random-number generation needs. It is recommended to use C++11's random number generation facilities to replace rand(). (since C++11)

(2) As you mentioned, there is the possibility of modulo bias with rand() % x (where is RAND_MAX is not divisible by x, then generating smaller numbers is more likely). With rand(), it's possible to correct for it with a few extra lines of code, but feels more elegant to instead use the intended standard library function, which picks integers uniformly distributed on a specified closed interval.

(3) The <random> library has the very neat std::seed_seq function used here, which mixes multiple sources of randomness together (as opposed to srand(), which takes in just 1 seed), and makes seeds that are distributed over the whole 32-bit range even when the inputs are close or poorly distributed. This is nice here particularly because the PineTime has a few possible sources of randomness that can work together in tandem; the dice app mixes the system tick count and the X/Y/Z components of the PineTime's sensitive motion controller (credit to @w4tsn #1199 for the motion controller idea!), making seed collision vanishingly unlikely.

Another concern is how well the shaking works when lower to sleep is also enabled. Could you check if there are any issues there? (I'm also not a big fan of the hack of enabling shake to wake if it's disabled to get it to work, but I don't think that needs to be solved now)

That's a great point; I am not sure as I haven't previously used lower to sleep on my own PineTime -- I will test this shortly and report back here soon!

FintasticMan · 2024-01-14T21:36:28Z

Thank you for the thorough explanation. I think it shows you've put a lot of thought into this and I agree that using rand() is not well-suited for this application. Let's stick with the C++ random classes you've already implemented then!

yusufmte · 2024-01-15T03:07:03Z

Another concern is how well the shaking works when lower to sleep is also enabled. Could you check if there are any issues there? (I'm also not a big fan of the hack of enabling shake to wake if it's disabled to get it to work, but I don't think that needs to be solved now)

Tested current version on PineTime hardware, it's working well! The lower-to-sleep & raise-to-wake continues to work inside & outside the Dice app when these are enabled, and the shake-to-roll works as well.

FintasticMan

Awesome! This looks good to me

yusufmte · 2024-01-15T06:49:39Z

Awesome, thanks again!!! Let me know if anything else needed prior to merge!

NeroBurner · 2024-01-23T08:47:57Z

@yusufmte thank you for your hard work and endurance!

We can finally say: Alea iacta est

yusufmte · 2024-01-23T17:17:27Z

@yusufmte thank you for your hard work and endurance!

We can finally say: Alea iacta est

Thank you friend, and many thanks to all who contributed and reviewed along the way! 🎉 Alea iacta est, indeed! :)

@w4tsn

Add new App `Dice.h` to randomly roll the dice(s). The number of dice can range from 1-9 (default 1), and the sides can range from d2-d99 (default d2). To have a haptic feedback we make Dice vibrate on roll. Regarding the use of C++ `<random>` library: There are known problems with `rand()` and `srand()` (see https://en.cppreference.com/w/cpp/numeric/random/rand) and the `<random>` library is preferred for this reason. The function used from `<random>` also avoids a very rare bias that would occur using `rand()` and modulo, when `RAND_MAX` is not a multiple of `d` and the initially generated number falls in the last "short" segment. This commit also updates the seed to derive entropy (via `seed_seq`) from a mix of the system tick count and the x,y,z components of the PineTime motion controller -- taking inspiration from and with credit to @w4tsn (InfiniTimeOrg#1199) Thanks for suggestions: * in Dice, when rolling 1d2, also show "HEADS" or "TAILS" -- suggestion by @medeyko * ui adjustments and result realignment -- suggestion by @Boteium --------- Co-authored-by: NeroBurner <[email protected]> Co-authored-by: Riku Isokoski <[email protected]> Co-authored-by: Paul Weiß <[email protected]> Co-authored-by: FintasticMan <[email protected]>

@w4tsn

Add new App `Dice.h` to randomly roll the dice(s). The number of dice can range from 1-9 (default 1), and the sides can range from d2-d99 (default d2). To have a haptic feedback we make Dice vibrate on roll. Regarding the use of C++ `<random>` library: There are known problems with `rand()` and `srand()` (see https://en.cppreference.com/w/cpp/numeric/random/rand) and the `<random>` library is preferred for this reason. The function used from `<random>` also avoids a very rare bias that would occur using `rand()` and modulo, when `RAND_MAX` is not a multiple of `d` and the initially generated number falls in the last "short" segment. This commit also updates the seed to derive entropy (via `seed_seq`) from a mix of the system tick count and the x,y,z components of the PineTime motion controller -- taking inspiration from and with credit to @w4tsn (InfiniTimeOrg#1199) Thanks for suggestions: * in Dice, when rolling 1d2, also show "HEADS" or "TAILS" -- suggestion by @medeyko * ui adjustments and result realignment -- suggestion by @Boteium --------- Co-authored-by: NeroBurner <[email protected]> Co-authored-by: Riku Isokoski <[email protected]> Co-authored-by: Paul Weiß <[email protected]> Co-authored-by: FintasticMan <[email protected]>

yusufmte and others added 9 commits September 11, 2022 00:05

initial commit for Dice.h and Dice.cpp

4cc6776

include Dice.h and Dice.cpp into compilation in CMakeLists.txt

b238d06

add "d" (0x64) to the range in jetbrains_mono_42 in fonts.json

6278008

add dice symbol

12a565a

add dice app to app launcher

b37781a

Merge branch 'InfiniTimeOrg:develop' into dice

172f20d

increase number of app screens to 3

1996113

modify dice seed to use epoch time

f00d779

Merge branch 'InfiniTimeOrg:develop' into dice

7c011d6

NeroBurner added the new app This thread is about a new app label Sep 13, 2022

NeroBurner requested changes Sep 13, 2022

View reviewed changes

src/displayapp/screens/Dice.h Outdated Show resolved Hide resolved

src/displayapp/screens/Dice.h Outdated Show resolved Hide resolved

src/displayapp/screens/Dice.h Outdated Show resolved Hide resolved

src/displayapp/screens/Dice.h Outdated Show resolved Hide resolved

yusufmte added 3 commits September 13, 2022 16:29

apply clang-format to Dice.h

b073b48

remove unnecessary stored reference to dateTime in Dice.h

1edfddd

remove unnecessary stored reference to dateTime in Dice.cpp

6c7d8c2

yusufmte added 3 commits September 13, 2022 17:00

use std::array to reduce unnecessary variables

3bd3d81

remove unnecessary member variable in Dice.h

21e5ec1

move NextColor() into private namespace of Dice

b1e522f

yusufmte added 4 commits September 14, 2022 16:48

modify seed to avoid overflow error

8ecfb49

fix unchanging seed

616413d

fix Dice seed to use system tick count

6d23a14

implement rolling multiple dice in Dice

52e4af5

yusufmte requested a review from NeroBurner September 15, 2022 18:55

yusufmte and others added 6 commits December 13, 2023 14:25

Merge branch 'main' into dice

b5c2057

updated for new optional user app interface, fixed bugs and formatting

ee8aaad

fix formatting

3e0e30f

Merge branch 'InfiniTimeOrg:main' into dice

f504a8b

Merge remote-tracking branch 'upstream/main' into dice

5a6cd44

add to user apps

e231b58

FintasticMan requested changes Jan 11, 2024

View reviewed changes

FintasticMan reviewed Jan 11, 2024

View reviewed changes

src/displayapp/screens/Symbols.h Outdated Show resolved Hide resolved

yusufmte and others added 5 commits January 13, 2024 21:49

remove unnecessary static declaration

1166939

Co-authored-by: FintasticMan <[email protected]>

remove unnecessary static declaration

945a099

Co-authored-by: FintasticMan <[email protected]>

removed vestigial chartLine symbol

3c4027a

replace preprocessor def with static constexpr value, and formatting fix

d4c6975

Merge branch 'main' into dice

446e49e

FintasticMan requested changes Jan 14, 2024

View reviewed changes

src/displayapp/screens/Dice.h Outdated Show resolved Hide resolved

.gitignore Outdated Show resolved Hide resolved

yusufmte and others added 3 commits January 14, 2024 22:07

Merge branch 'InfiniTimeOrg:main' into dice

e6cfd9e

remove unrelated .gitignore changes

8880acc

use camelCase for rollHysteresis constant

01b241b

FintasticMan approved these changes Jan 15, 2024

View reviewed changes

NeroBurner added this to the 1.15.0 milestone Jan 15, 2024

Merge branch 'InfiniTimeOrg:main' into dice

0c7a77a

NeroBurner merged commit a40168a into InfiniTimeOrg:main Jan 23, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New dice-rolling app: InfiniDice! #1326

New dice-rolling app: InfiniDice! #1326

yusufmte commented Sep 12, 2022

joseph58tech commented Sep 13, 2022

minacode commented Sep 13, 2022

NeroBurner left a comment

FintasticMan commented Sep 13, 2022

minacode commented Sep 13, 2022

FintasticMan commented Sep 13, 2022

minacode commented Sep 13, 2022

yusufmte commented Sep 13, 2022 •

edited

Loading

yusufmte commented Sep 15, 2022 •

edited

Loading

yusufmte commented Jan 10, 2024 •

edited

Loading

FintasticMan left a comment •

edited

Loading

FintasticMan left a comment

yusufmte commented Jan 14, 2024

FintasticMan commented Jan 14, 2024

yusufmte commented Jan 15, 2024

FintasticMan left a comment

yusufmte commented Jan 15, 2024

NeroBurner commented Jan 23, 2024

yusufmte commented Jan 23, 2024

New dice-rolling app: InfiniDice! #1326

New dice-rolling app: InfiniDice! #1326

Conversation

yusufmte commented Sep 12, 2022

joseph58tech commented Sep 13, 2022

minacode commented Sep 13, 2022

NeroBurner left a comment

Choose a reason for hiding this comment

FintasticMan commented Sep 13, 2022

minacode commented Sep 13, 2022

FintasticMan commented Sep 13, 2022

minacode commented Sep 13, 2022

yusufmte commented Sep 13, 2022 • edited Loading

yusufmte commented Sep 15, 2022 • edited Loading

yusufmte commented Jan 10, 2024 • edited Loading

FintasticMan left a comment • edited Loading

Choose a reason for hiding this comment

FintasticMan left a comment

Choose a reason for hiding this comment

yusufmte commented Jan 14, 2024

FintasticMan commented Jan 14, 2024

yusufmte commented Jan 15, 2024

FintasticMan left a comment

Choose a reason for hiding this comment

yusufmte commented Jan 15, 2024

NeroBurner commented Jan 23, 2024

yusufmte commented Jan 23, 2024

yusufmte commented Sep 13, 2022 •

edited

Loading

yusufmte commented Sep 15, 2022 •

edited

Loading

yusufmte commented Jan 10, 2024 •

edited

Loading

FintasticMan left a comment •

edited

Loading