Merge pull request #2 from firefly-zero/stats

Add add_progress and add_score

Author: orsinium

Taskfile.yml

@@ -12,3 +12,12 @@ tasks:
     cmds:
       - task: install-doxygen
       - doxygen Doxyfile
+
+  release:
+    desc: publish release
+    cmds:
+      - test {{.CLI_ARGS}}
+      - git tag {{.CLI_ARGS}}
+      - git push
+      - git push --tags
+      - gh release create --generate-notes {{.CLI_ARGS}}

examples/image-c/main.c

@@ -9,10 +9,8 @@ BOOT void boot()
     // You could also use `get_file_size` to detect the file size
     // in runtime but that requires using an allocator.
     const size_t fileSize = 97;
-    Buffer buf;
     char head[fileSize];
-    buf.head = head;
-    buf.size = fileSize;
+    Buffer buf = {.head = head, .size = fileSize};
     image = load_file("img", buf);
 }
 

src/firefly.c

@@ -283,9 +283,9 @@ uintptr_t get_random()
 Buffer get_name(Buffer buf)
 {
     int32_t size = _ffb_get_name((int)buf.head, buf.size);
-    File name;
-    name.size = size;
-    name.head = buf.head;
+    File name = {
+        .size = size,
+        .head = buf.head};
     return name;
 }
 
@@ -301,6 +301,48 @@ void quit()
     _ffb_quit();
 }
 
+// -- STATS -- //
+
+/// @brief Add the given value to the progress for the badge.
+///
+/// @details May be negative if you want to decrease the progress.
+/// If zero, does not change the progress.
+///
+/// If the Peer is COMBINED, the progress is added to every peer
+/// and the returned value is the lowest progress.
+Progress add_progress(Peer p, Badge b, int16_t v)
+{
+    uint32_t r = _ffb_add_progress(p, b, v);
+    Progress progress = {
+        .done = r >> 16,
+        .goal = r};
+    return progress;
+}
+
+/// @brief Get the progress of earning the badge.
+Progress get_progress(Peer p, Badge b)
+{
+    return add_progress(p, b, 0);
+}
+
+/// @brief Add the given score to the board.
+///
+/// @details May be negative if you want the lower scores
+/// to rank higher. Zero value is not added to the board.
+///
+/// If the Peer is COMBINED, the score is added for every peer
+/// and the returned value is the lowest of their best scores.
+Score add_score(Peer p, Board b, Score v)
+{
+    return _ffb_add_score(p, b, v);
+}
+
+/// @brief Get the personal best of the player.
+Score get_score(Peer p, Board b)
+{
+    return add_score(p, b, 0);
+}
+
 // -- AUDIO -- //
 
 /// @brief Add sine AudioNode as a child node for the given node.

src/firefly.h

@@ -16,6 +16,9 @@
 /// @brief Mark a "render_line" callback function.
 #define RENDER_LINE __attribute__((export_name("render_line")))
 
+/// @brief Mark a "cheat" callback function.
+#define CHEAT __attribute__((export_name("cheat")))
+
 /// @brief Screen width.
 #define WIDTH 240
 /// @brief Screen height.
@@ -222,7 +225,20 @@ typedef struct Peers Peers;
 typedef int32_t Peer;
 
 /// @brief A peer ID representing all peers at once.
-#define COMBINED = 0xFF
+const Peer COMBINED = 0xFF;
+
+// -- STATS -- //
+
+typedef uint32_t Badge;
+typedef uint32_t Board;
+typedef int32_t Score;
+
+struct Progress
+{
+    uint16_t done;
+    uint16_t goal;
+};
+typedef struct Progress Progress;
 
 // -- AUDIO -- //
 
@@ -237,6 +253,9 @@ struct AudioNode
 };
 typedef struct AudioNode AudioNode;
 
+/// @brief The root audio node. Its child nodes are mixed and played on the device output.
+const AudioNode OUT = {.id = 0};
+
 /// @brief A parameter of an audio node that can be modulated.
 enum ModParam
 {
@@ -368,6 +387,11 @@ Buffer get_name(Buffer buf);
 void restart();
 void quit();
 
+Progress add_progress(Peer p, Badge b, int16_t v);
+Progress get_progress(Peer p, Badge b);
+Score add_score(Peer p, Badge b, Score v);
+Score get_score(Peer p, Badge b);
+
 AudioNode add_sine(AudioNode parent, float freq, float phase);
 AudioNode add_square(AudioNode parent, float freq, float phase);
 AudioNode add_sawtooth(AudioNode parent, float freq, float phase);