@chikn-game-assets/runtime 0.1.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ATTRIBUTION.md +19 -0
- package/CHIKN-COMMUNITY-ASSET-NOTICE.md +20 -0
- package/COMMERCIAL_USE.md +9 -0
- package/LICENSE +201 -0
- package/README.md +46 -0
- package/catalog/asset-ids.json +1887 -0
- package/dist/index.d.ts +136 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +247 -0
- package/dist/index.js.map +1 -0
- package/package.json +16 -0
package/ATTRIBUTION.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Attribution and ownership boundaries
|
|
2
|
+
|
|
3
|
+
## Chikn community content
|
|
4
|
+
|
|
5
|
+
Official Chikn, Roostr and FarmLand visual assets remain owned by their respective rights holder and are hosted with permission for community non-commercial use under Chikn's existing community terms.
|
|
6
|
+
|
|
7
|
+
Recommended acknowledgement:
|
|
8
|
+
|
|
9
|
+
> Chikn, Roostr and FarmLand visual assets are owned by their respective rights holder and used under Chikn's non-commercial community permission.
|
|
10
|
+
|
|
11
|
+
When publishing a modified non-commercial project, identify that Chikn-origin assets were modified where reasonably practical. This is attribution guidance, not an additional licence condition created by this repository.
|
|
12
|
+
|
|
13
|
+
The repository does not grant commercial permission or claim ownership of protected visual content.
|
|
14
|
+
|
|
15
|
+
## Independently authored project material
|
|
16
|
+
|
|
17
|
+
Rig definitions, transforms, animation clips and timing, build tools, manifests, and other independently authored metadata are not Chikn property. They are separately licensed under Apache-2.0. The published `water_swim_ring_coq.png` is likewise Roost2D project artwork under Apache-2.0. The artwork displayed by a rig remains Chikn community content; the rig structure and animation data do not.
|
|
18
|
+
|
|
19
|
+
Unrelated project files such as `eggorithm.png` are listed under `excludedPaths` and do not enter published source or runtime artifacts.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Chikn Community Asset Notice
|
|
2
|
+
|
|
3
|
+
The Chikn, Roostr and FarmLand visual assets classified in
|
|
4
|
+
`manifests/rights-manifest.json` remain owned by their respective
|
|
5
|
+
rights holder.
|
|
6
|
+
|
|
7
|
+
Roost2D hosts and technically distributes these assets with permission
|
|
8
|
+
from the Chikn team for community non-commercial use under Chikn's
|
|
9
|
+
existing community terms.
|
|
10
|
+
|
|
11
|
+
This repository does not grant an independent licence, sublicense or
|
|
12
|
+
commercial permission for Chikn intellectual property.
|
|
13
|
+
|
|
14
|
+
Commercial use requires a separate agreement with the Chikn team.
|
|
15
|
+
|
|
16
|
+
The manifest contains per-file hashes only for technical integrity and
|
|
17
|
+
source-to-runtime traceability.
|
|
18
|
+
|
|
19
|
+
Files listed under `excludedPaths` are outside the Chikn community asset
|
|
20
|
+
distribution and receive no rights from this notice.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Commercial use
|
|
2
|
+
|
|
3
|
+
The official Chikn, Roostr and FarmLand visual assets classified as `CHIKN-COMMUNITY-NONCOMMERCIAL` are provided for community non-commercial use under the Chikn team's existing community permission.
|
|
4
|
+
|
|
5
|
+
This repository does not grant commercial permission.
|
|
6
|
+
|
|
7
|
+
Before commercially distributing, monetizing, advertising or using the protected visual assets in a commercial service, obtain a separate agreement directly from the Chikn team through its official community or business channels.
|
|
8
|
+
|
|
9
|
+
The commercial restriction does not apply to entries explicitly classified as Apache-2.0, including software, schemas, generic tooling, independently authored project metadata, and `water_swim_ring_coq.png`, when used without protected Chikn visual assets.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @chikn-game-assets/runtime
|
|
2
|
+
|
|
3
|
+
Apache-2.0 TypeScript helpers and a generated ID catalog for a separately hosted Chikn Game Assets release. This npm package contains no source images or atlas PNGs and does not grant rights to Chikn, Roostr, or FarmLand artwork.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npm install @chikn-game-assets/runtime
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { CHIKN_CONTENT_TERMS, loadChiknPack } from '@chikn-game-assets/runtime';
|
|
11
|
+
|
|
12
|
+
const pack = await loadChiknPack({
|
|
13
|
+
baseUrl: 'https://cdn.example/chikn/v1.0.0/',
|
|
14
|
+
profile: 'default',
|
|
15
|
+
});
|
|
16
|
+
const asset = pack.findAsset('chikn-flat/admiral');
|
|
17
|
+
console.log(CHIKN_CONTENT_TERMS.ownership);
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
`baseUrl` must point to the directory containing `runtime/manifest.json`; no production host is embedded. It roots both the manifest and the atlas pages. Use `@roost2d/assets` and `@roost2d/pixi` for cached integrity-checked loading and cropped Pixi textures — that remains the recommended integration.
|
|
21
|
+
|
|
22
|
+
## Loading verified bytes without Roost2D
|
|
23
|
+
|
|
24
|
+
`fetchAssetBytes` fetches a single atlas page and verifies its declared byte count and SHA-256 digest before returning it. It refuses variant paths that are absolute, traversing, percent-encoded, or off-origin, and aborts a response that overruns its declared size.
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import { createChiknAssetCache, fetchAssetBytes, loadChiknPack } from '@chikn-game-assets/runtime';
|
|
28
|
+
|
|
29
|
+
const pack = await loadChiknPack({
|
|
30
|
+
baseUrl: 'https://cdn.example/chikn/v1.0.0/',
|
|
31
|
+
// Optional: pin the manifest itself. Per-asset digests are only trustworthy if the manifest is.
|
|
32
|
+
expectedManifestSha256: '…',
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
const bytes = await fetchAssetBytes(pack, 'chikn-flat/admiral');
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Many logical IDs share one atlas page, so `fetchAssetBytes` is deliberately low-level and uncached — calling it per ID re-downloads the same bytes. For batches use `createChiknAssetCache(pack)`, which shares bytes only when the resolved URL, byte count, and integrity metadata all match, and exposes `unload(assetId)` and `clear()`.
|
|
39
|
+
|
|
40
|
+
If you pass a bare `manifestUrl` instead of `baseUrl`, the asset root is not inferred from it. Supply `assetBaseUrl` explicitly, or asset resolution throws.
|
|
41
|
+
|
|
42
|
+
Manifest entries marked `CHIKN-COMMUNITY-NONCOMMERCIAL` remain owned by the Chikn rights-holder; Roost2D hosts them with permission for community non-commercial use and grants no independent licence or sublicense. A manifest entry marked `Apache-2.0`, such as `farmland/water-swim-ring-coq`, is separately classified project artwork and is not Chikn property. Commercial use of protected Chikn entries still requires a separate Chikn agreement.
|
|
43
|
+
|
|
44
|
+
IDs such as `chikn-flat/admiral` and dotted rig names may be compatibility aliases rather than primary file IDs. Always call `findAsset` (or use a Roost2D manifest resolver) instead of translating an ID into a source path.
|
|
45
|
+
|
|
46
|
+
Read the [community asset notice](https://github.com/Roost2D/chikn-game-assets/blob/main/CHIKN-COMMUNITY-ASSET-NOTICE.md), [attribution guidance](https://github.com/Roost2D/chikn-game-assets/blob/main/ATTRIBUTION.md), [commercial-use boundary](https://github.com/Roost2D/chikn-game-assets/blob/main/COMMERCIAL_USE.md), and [complete integration guide](https://github.com/Roost2D/chikn-game-assets/blob/main/INTEGRATION.md).
|