Once you have your amulet up and running, you might be interested in making your own mods, which I highly encourage! Note that I won't be accepting many direct contributions, so instead I recommend that you just make your modifications locally or fork the primary repo. Either way, here are a few notes that might help you.
I've added several sets of images in the src/bonus directory that you can use to create new modes for the Amulet. See the README file there for example code.
I've also added some other splash screen images you can use in the src/bonus/splashscreen_images directory.
Note that the /data directory, as it stands, will completely fill the 1MB of flash memory set aside for the LittleFS file system. If you're going to add your own modes, you're probably going to need to delete one of the current modes. (I actually wanted to add several other modes, but ran out of room.) I'd delete either cards or tarot, as these use up the most space.
The most likely customization would be to add a new mode. Again, if you want to use images, you're almost surely going to need to make some room first (see above). If you search the code for one of the existing modes, like coinFlipOutcomes, you'll see examples of how to do this and find all the places where you'll need to make changes.
To create a new mode:
- Enumerate the possible outcomes and number them from 1 to whatever, not skipping any numbers.
- Find or create images for possible outcome. The images should be basic JPEG format with a resolution of 240x240.
- Add a new Outcomes map in src/amulet/outcomes.cpp. You want to map each numbered outcome with an image file. (Note that the text fields aren't used.)
- Add an
externreference to this map in src/amulet/outcomes.h. - Update the list of modes in src/amulet/statemachine.cpp.
I run through an example in the src/bonus/modes directory.
Change the value of the variable MAX_POOL_SIZE in src/amulet/entropypool.h to increase or decrease the size of the pool. If you significantly increase it, you might want to also reduce the delay time near the gathering_entrop() call in src/amulet/amulet.ino main loop.
If you want the LEDs (dragon eyes and arrow gems) to do different things, look at the cycle() and sparkle() methods in src/amulet/ledstrip.cpp for examples. You can either modify these directly or add your own. (If you add your own, you'll need to modify the header file, too, of course - and then call these methods from within the code somewhere. I recommend calling the methods from the main loop.