Skip to content

Commit d3dbe19

Browse files
novabytenovabyte
committed
Initial public commit.
0 parents  commit d3dbe19

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+12575
-0
lines changed

‎.editorconfig

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# See format at editorconfig.org
2+
root = true
3+
4+
[*]
5+
end_of_line = lf
6+
insert_final_newline = true

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.idea/
2+
.DS_Store

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
Hiro
2+
===
3+
4+
> The server interface for the Hiro game framework.
5+
6+
[Hiro](https://heroiclabs.com/hiro/) is a client and server framework built on top of [Nakama server](https://heroiclabs.com/nakama/) to rapidly build high performance, flexible, and composable gameplay systems like Achievements, Energies, Event Leaderboards, and much more.
7+
8+
The code is divided into a Go package of interfaces and a C# DLL which is packaged with utilities (such as UnityPurchasing, Unity Mobile Notifications, etc) for Unity Engine.
9+
10+
This repository maintains the public interfaces which make it easy to use the library from inside a Nakama game server project to extend and build additional gameplay systems.
11+
12+
To learn more about Hiro and integrate it into your Unity game project, have a look at these resources:
13+
14+
- [heroiclabs.com/hiro](https://heroiclabs.com/hiro/)
15+
- [heroiclabs.com/docs/hiro](https://heroiclabs.com/docs/hiro/)
16+
17+
Reach out to [Heroic Labs](mailto:[email protected]) for more information about how to license Hiro as a developer or as part of a game studio.
18+
19+
### Setup
20+
21+
1. Set up the Go toolchain.
22+
2. Set up your [Nakama project with Go](https://heroiclabs.com/docs/nakama/server-framework/go-runtime/#initialize-the-project).
23+
3. Add Hiro to your project as a dependency:
24+
25+
```shell
26+
go get "github.com/heroiclabs/hiro@latest"
27+
```
28+
29+
4. Sign up to the [Heroic Cloud](https://cloud.heroiclabs.com) and contact us to obtain licenses to Hiro.
30+
5. Download and unzip the package. Add "hiro.bin" to your codebase.
31+
6. Follow the [usage](#usage) instructions for how to get started.
32+
33+
### Usage
34+
35+
The game framework initializes and returns the configured gameplay systems with `Init`:
36+
37+
```go
38+
func InitModule(ctx context.Context, logger runtime.Logger, db *sql.DB, nk runtime.NakamaModule, initializer runtime.Initializer) error {
39+
systems, err := hiro.Init(ctx, logger, nk, initializer, "hiro.bin",
40+
hiro.WithEconomySystem("economy.json", true),
41+
hiro.WithEnergySystem("energy.json", true),
42+
hiro.WithInventorySystem("inventory.json", true))
43+
if err != nil {
44+
return err
45+
}
46+
47+
// systems.GetEnergySystem().Get(...)
48+
// ...
49+
50+
return nil
51+
}
52+
```
53+
54+
For examples on how to write data definitions for the gameplay systems have a look at the [documentation](https://heroiclabs.com/docs/hiro/).
55+
56+
### License
57+
58+
This codebase is licensed under the [Apache-2 License](https://github.com/heroiclabs/hiro/blob/master/LICENSE).

‎achievements.go

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
// Copyright 2023 Heroic Labs & Contributors
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package hiro
16+
17+
import (
18+
"context"
19+
"github.com/heroiclabs/nakama-common/runtime"
20+
)
21+
22+
// AchievementsConfig is the data definition for the TutorialsSystem type.
23+
type AchievementsConfig struct {
24+
Achievements map[string]*AchievementsConfigAchievement `json:"achievements"`
25+
}
26+
27+
type AchievementsConfigAchievement struct {
28+
AutoClaim bool `json:"auto_claim"`
29+
AutoClaimTotal bool `json:"auto_claim_total"`
30+
AutoReset bool `json:"auto_reset"`
31+
Category string `json:"category"`
32+
Count int64 `json:"count"`
33+
Description string `json:"description"`
34+
ResetCronexpr string `json:"reset_cronexpr"`
35+
DurationSec int64 `json:"duration_sec"`
36+
MaxCount int64 `json:"max_count"`
37+
Name string `json:"name"`
38+
PreconditionIDs []string `json:"precondition_ids"`
39+
Reward *EconomyConfigReward `json:"reward"`
40+
TotalReward *EconomyConfigReward `json:"total_reward"`
41+
SubAchievements map[string]*AchievementsConfigSubAchievement `json:"sub_achievements"`
42+
AdditionalProperties map[string]string `json:"additional_properties"`
43+
}
44+
45+
type AchievementsConfigSubAchievement struct {
46+
AutoClaim bool `json:"auto_claim"`
47+
AutoReset bool `json:"auto_reset"`
48+
Category string `json:"category"`
49+
Count int64 `json:"count"`
50+
Description string `json:"description"`
51+
ResetCronexpr string `json:"reset_cronexpr"`
52+
DurationSec int64 `json:"duration_sec"`
53+
MaxCount int64 `json:"max_count"`
54+
Name string `json:"name"`
55+
PreconditionIDs []string `json:"precondition_ids"`
56+
Reward *EconomyConfigReward `json:"reward"`
57+
AdditionalProperties map[string]string `json:"additional_properties"`
58+
}
59+
60+
// An AchievementsSystem is a gameplay system which represents one-off, repeat, preconditioned, and sub-achievements.
61+
type AchievementsSystem interface {
62+
System
63+
64+
// ClaimAchievements when one or more achievements whose progress has completed by their IDs.
65+
ClaimAchievements(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string, achievementIDs []string, claimTotal bool) (map[string]*Achievement, map[string]*Achievement, error)
66+
67+
// GetAchievements returns all achievements available to the user and progress on them.
68+
GetAchievements(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string) (map[string]*Achievement, map[string]*Achievement, error)
69+
70+
// UpdateAchievements updates progress on one or more achievements by the same amount.
71+
UpdateAchievements(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string, achievementIDs []string, amount int64) (map[string]*Achievement, map[string]*Achievement, error)
72+
73+
// SetOnAchievementReward sets a custom reward function which will run after an achievement's reward is rolled.
74+
SetOnAchievementReward(fn OnReward[*AchievementsConfigAchievement])
75+
76+
// SetOnSubAchievementReward sets a custom reward function which will run after a sub-achievement's reward is
77+
// rolled.
78+
SetOnSubAchievementReward(fn OnReward[*AchievementsConfigSubAchievement])
79+
80+
// SetOnAchievementTotalReward sets a custom reward function which will run after an achievement's total reward is
81+
// rolled.
82+
SetOnAchievementTotalReward(fn OnReward[*AchievementsConfigAchievement])
83+
}

0 commit comments

Comments
 (0)