You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-11Lines changed: 42 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,10 @@
2
2
3
3
> This project was created entirely by AI.
4
4
5
+
> **NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.**
6
+
>
7
+
> `Mahjong Soul` / `雀魂` is referenced only to describe compatible rules and visual style. MahjongPaper is not affiliated with or endorsed by Mahjong Soul or its rightsholders. All product names and trademarks belong to their respective owners.
8
+
5
9
Chinese documentation: [README.zh-CN.md](./README.zh-CN.md)
6
10
Chinese gameplay and operations wiki: [docs/wiki.zh-CN.md](./docs/wiki.zh-CN.md)
@@ -250,19 +254,46 @@ MahjongPaper currently uses CraftEngine for:
250
254
- tracked entity culling integration
251
255
- furniture interaction routing for table interaction
252
256
253
-
## Resource Assets
257
+
## Credits, Assets, and Upstream Projects
258
+
259
+
MahjongPaper is an independent rewrite/port and does not claim ownership of third-party code, artwork, recordings, names, or trademarks. The project-level MIT license applies only to material for which this repository's authors can grant that license; third-party components remain under their own licenses or terms.
|[MahjongCraft](https://github.com/doublemoon1119/MahjongCraft), by `doublemoon1119`| Original Fabric mod; primary gameplay/architecture inspiration and source of reused tile textures and base item models |[MIT](https://github.com/doublemoon1119/MahjongCraft/blob/main/LICENSE)|
266
+
|[MahjongPlay](https://github.com/7yunluo/MahjongPlay), by `7yunluo`| Paper-plugin implementation reference |[MIT](https://github.com/7yunluo/MahjongPlay/blob/main/LICENSE)|
267
+
|[mahjong-utils](https://github.com/ssttkkl/mahjong-utils), by `ssttkkl`| Direct runtime library for Riichi hand evaluation and scoring |[MIT](https://github.com/ssttkkl/mahjong-utils/blob/main/LICENSE)|
268
+
|[GB-Mahjong](https://github.com/zheng-fan/GB-Mahjong), by Zheng Fan | Vendored C++ source compiled into the bundled GB rules JNI library |[MIT; local copy](./native/gbmahjong/vendor/GB-Mahjong/LICENSE)|
269
+
|[Paper](https://github.com/PaperMC/Paper) / [Folia](https://github.com/PaperMC/Folia)| Supported server platforms and APIs; supplied separately by the server operator | Their respective upstream licenses |
270
+
|[CraftEngine](https://github.com/Xiao-MoMi/craft-engine)| Required external runtime plugin for custom items, furniture, interaction, culling, and resource delivery; not bundled |[GPL-3.0](https://github.com/Xiao-MoMi/craft-engine/blob/main/LICENSE)|
271
+
|[Adventure](https://github.com/PaperMC/adventure)| Text/component API supplied by Paper |[Apache-2.0](https://github.com/PaperMC/adventure/blob/main/5/license.txt)|
272
+
273
+
### Resource-pack artwork and sound
274
+
275
+
The assets in [resourcepack](./resourcepack) are packaged into the exported CraftEngine bundle. The authoritative per-file/source notice is [resourcepack/ATTRIBUTION.md](./resourcepack/ATTRIBUTION.md); keep that file with every redistributed bundle.
276
+
277
+
- Mahjong tile textures and base item models are reused from [MahjongCraft](https://github.com/doublemoon1119/MahjongCraft) under MIT. The related tile-art lineage also credits [mahjong_graphic](https://github.com/lietxia/mahjong_graphic) by `lietxia`, released under the M+ Fonts License; its documentation identifies partial lineage from [I.Mahjong](https://github.com/SyaoranHinata/I.Mahjong) and GL-MahjongTile.
278
+
- Tile/table sound recordings are adapted from Freesound uploads `329098`, `329099`, and `329100` by **Macif**, `197868` by **Millavsb**, and `745024` by **poenia**, each marked [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/). Direct source links and file mappings are in the attribution file.
279
+
- Riichi action voices use `chii_01.wav`, `pon_01.wav`, `kan_01.wav`, `ri-chi_01.wav`, and `ron_01.wav` from [Amitaro's Voice Material Studio](https://amitaro.net/voice/game_01/) under the studio's [custom terms](https://amitaro.net/voice/voice_rule/), not under MIT or CC0.
280
+
281
+
Required voice credit:
282
+
283
+
> Voice: Amitaro's Voice Material Studio (<https://amitaro.net/>)<br>
284
+
> 音声素材:あみたろの声素材工房 (<https://amitaro.net/>)
285
+
286
+
Redistribution of the Amitaro voice files is permitted only as part of a work such as this plugin/resource bundle, subject to the current Amitaro terms. Redistributors must preserve the credit and terms link/readme, must not offer the recordings as a standalone voice/sound pack, and should complete the required post-release usage report within the period stated by those terms. A Japanese report draft is maintained at [docs/amitaro-usage-report.ja.md](./docs/amitaro-usage-report.ja.md).
287
+
288
+
### Runtime libraries
289
+
290
+
The build declares the following direct runtime libraries; they are separate works and remain under their own licenses: [MariaDB Connector/J](https://github.com/mariadb-corporation/mariadb-connector-j) (LGPL-2.1), [MySQL Connector/J](https://github.com/mysql/mysql-connector-j) (GPL-2.0 with Oracle's additional permissions and Universal FOSS Exception), [H2](https://github.com/h2database/h2database) (MPL-2.0 or EPL-1.0), [HikariCP](https://github.com/brettwooldridge/HikariCP) (Apache-2.0), [Caffeine](https://github.com/ben-manes/caffeine) (Apache-2.0), [Kotlin](https://github.com/JetBrains/kotlin) (Apache-2.0), and [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization) (Apache-2.0). Paper's plugin loader resolves the Maven libraries listed in [MahjongPaperLoader.java](./src/main/java/top/ellan/mahjong/bootstrap/MahjongPaperLoader.java); [build.gradle.kts](./build.gradle.kts) is the authoritative direct dependency/version list.
254
291
255
-
The assets in [resourcepack](./resourcepack)are packaged and delivered through the exported CraftEngine bundle.
292
+
Platform-native releases also include the compiled GB-Mahjong JNI bridge. A Windows release may include `libwinpthread-1.dll` from [mingw-w64 winpthreads](https://github.com/mingw-w64/mingw-w64/tree/master/mingw-w64-libraries/winpthreads), under its upstream MIT/BSD-style notice. GCC runtime portions, when linked by the native build, are covered by GPL-3.0 plus the [GCC Runtime Library Exception 3.1](https://gcc.gnu.org/onlinedocs/libstdc++/manual/license.html).
Minecraft is a trademark of Microsoft. MahjongPaper is independently developed and is not an official Minecraft product, nor approved by or associated with Mojang or Microsoft. References to Mahjong Soul / 雀魂 describe rules or style only and do not imply affiliation, sponsorship, or endorsement. The names and marks of all upstream projects remain the property of their respective owners.
266
297
267
298
## Community
268
299
@@ -273,4 +304,4 @@ The assets in [resourcepack](./resourcepack) are packaged and delivered through
273
304
274
305
## License
275
306
276
-
This project is licensed under the [MIT License](./LICENSE).
307
+
Original MahjongPaper code and project-created assets are licensed under the [MIT License](./LICENSE), except where a file or the notices above identify different terms. Third-party notices and licenses must be retained when redistributing their material. This summary is provided for attribution and project hygiene; it is not legal advice and does not replace the governing license texts or service terms.
MahjongPaper's own code and project-created assets are licensed under the root [MIT License](./LICENSE). That license does not relicense third-party code, assets, recordings, names, or trademarks identified below.
4
+
5
+
## Material included in release artifacts
6
+
7
+
-**GB-Mahjong** by Zheng Fan is vendored and compiled into the GB rules JNI library under the MIT License. Copyright (c) 2019-2020 Zheng Fan `<i@fanzheng.org>`. The complete license is stored at `native/gbmahjong/vendor/GB-Mahjong/LICENSE` and packaged as `META-INF/licenses/GB-Mahjong-LICENSE.txt`.
8
+
- Mahjong tile textures and base item models are reused from **MahjongCraft** by `doublemoon1119` under the MIT License. Copyright (c) 2021 doublemoon1119. The complete notice is included in `resourcepack/ATTRIBUTION.md` and packaged as `META-INF/RESOURCEPACK_ATTRIBUTION.md`.
9
+
- Related tile-art provenance credits **mahjong_graphic** by `lietxia` and **I.Mahjong** by SyaoranHinata under the M+ Fonts License. Their documentation identifies GL-MahjongTile as earlier artwork/font lineage.
10
+
- Tile/table recordings are adapted from Freesound uploads `329098`, `329099`, and `329100` by **Macif**, `197868` by **Millavsb**, and `745024` by **poenia**, each marked CC0 1.0. File-level mappings and source URLs are in `resourcepack/ATTRIBUTION.md`.
11
+
- Riichi action voices are derived from `chii_01.wav`, `pon_01.wav`, `kan_01.wav`, `ri-chi_01.wav`, and `ron_01.wav` by **Amitaro's Voice Material Studio** under its custom terms, not MIT or CC0.
12
+
- Windows artifacts may include `libwinpthread-1.dll` from **mingw-w64 winpthreads**. Its MIT/BSD-style notice is packaged as `META-INF/licenses/winpthreads-COPYING.txt`.
13
+
- GCC runtime portions linked by the native build are licensed under GPL-3.0 with the GCC Runtime Library Exception 3.1: <https://gcc.gnu.org/onlinedocs/libstdc++/manual/license.html>.
14
+
15
+
Required Amitaro credit:
16
+
17
+
> Voice: Amitaro's Voice Material Studio (<https://amitaro.net/>)<br>
18
+
> 音声素材:あみたろの声素材工房 (<https://amitaro.net/>)
19
+
20
+
The Amitaro recordings may be redistributed only as part of a work such as this plugin/resource bundle and subject to the current terms at <https://amitaro.net/voice/voice_rule/>. Preserve the credit and terms link/readme, do not distribute the recordings as a standalone voice or sound pack, and complete any required post-release usage report.
21
+
22
+
## Separate platforms and runtime libraries
23
+
24
+
Paper, Folia, and CraftEngine are separate server components supplied by the server operator. Paper's plugin loader resolves mahjong-utils, MariaDB Connector/J, MySQL Connector/J, H2, HikariCP, Caffeine, Kotlin, and kotlinx.serialization as separate libraries under their respective upstream licenses. See the README and build files for links, versions, and license identifiers.
25
+
26
+
## Trademark and affiliation notice
27
+
28
+
**NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.** References to Mahjong Soul / 雀魂 describe rules or style only and do not imply affiliation, sponsorship, or endorsement. All names and trademarks belong to their respective owners.
0 commit comments