Add new gameplay system to provide player rewards based on win streaks. (#63)

Author: zyro

Diff for: base.go

@@ -98,6 +98,7 @@ type Hiro interface {
 	GetProgressionSystem() ProgressionSystem
 	GetIncentivesSystem() IncentivesSystem
 	GetAuctionsSystem() AuctionsSystem
+	GetStreaksSystem() StreaksSystem
 }
 
 // The SystemType identifies each of the gameplay systems.
@@ -119,6 +120,7 @@ const (
 	SystemTypeProgression
 	SystemTypeIncentives
 	SystemTypeAuctions
+	SystemTypeStreaks
 )
 
 // Init initializes a Hiro type with the configurations provided.
@@ -345,6 +347,15 @@ func WithAuctionsSystem(configFile string, register bool) SystemConfig {
 	}
 }
 
+// WithStreaksSystem configures a StreaksSystem type and optionally registers its RPCs with the game server.
+func WithStreaksSystem(configFile string, register bool) SystemConfig {
+	return &systemConfig{
+		systemType: SystemTypeStreaks,
+		configFile: configFile,
+		register:   register,
+	}
+}
+
 // UnregisterRpc clears the implementation of one or more RPCs registered in Nakama by Hiro gameplay systems with a
 // no-op version (http response 404). This is useful to remove individual RPCs which you do not want to be callable by
 // game clients:

Diff for: definitions/17-Hiro-Streaks.json

@@ -0,0 +1,54 @@
+{
+  "streaks": {
+    "wins": {
+      "name": "Consecutive Wins",
+      "description": "Number of consecutive wins, without any losses.",
+      "count": 0,
+      "max_count": 9,
+      "max_count_current_reset": 3,
+      "idle_count_decay_reset": 9,
+      "reset_cronexpr": "0 0 * * *",
+      "rewards": [
+        {
+          "count_min": 3,
+          "count_max": 3,
+          "reward": {
+            "guaranteed": {
+              "currencies": {
+                "coins": {
+                  "min": 10
+                }
+              }
+            }
+          }
+        },
+        {
+          "count_min": 6,
+          "count_max": 6,
+          "reward": {
+            "guaranteed": {
+              "currencies": {
+                "coins": {
+                  "min": 30
+                }
+              }
+            }
+          }
+        },
+        {
+          "count_min": 9,
+          "count_max": 9,
+          "reward": {
+            "guaranteed": {
+              "currencies": {
+                "coins": {
+                  "min": 100
+                }
+              }
+            }
+          }
+        }
+      ]
+    }
+  }
+}

Diff for: event_leaderboards.go

@@ -87,4 +87,4 @@ type EventLeaderboardsSystem interface {
 	DebugRandomScores(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, eventLeaderboardID string, scoreMin, scoreMax, subscoreMin, subscoreMax int64, operator *int) (eventLeaderboard *EventLeaderboard, err error)
 }
 
-type OnEventLeaderboardCohortSelection func(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, storageIndex string, eventID string, config *EventLeaderboardsConfigLeaderboard, userID string, tier int, matchmakerProperties map[string]interface{}) (cohortID string, cohortUserIDs []string, err error)
+type OnEventLeaderboardCohortSelection func(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, storageIndex string, eventID string, config *EventLeaderboardsConfigLeaderboard, userID string, tier int, matchmakerProperties map[string]interface{}) (cohortID string, cohortUserIDs []string, forceNewCohort bool, err error)