From b1b2c4950e2c5c0645aafc9e08e2d3a9893d2a90 Mon Sep 17 00:00:00 2001 From: Sulkta Date: Sun, 28 Jun 2026 13:51:43 -0700 Subject: [PATCH] docs: rewrite README for public release + add Apache-2.0 LICENSE --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 125 ++++++++++++++++++--------------- 2 files changed, 270 insertions(+), 56 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..b09cd785 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index a12da4e8..854189d9 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,90 @@ -# Dynmap — NeoForge 1.21.1 Port +# Dynmap — NeoForge 1.21.1 -Port of [Dynmap](https://github.com/webbukkit/dynmap) to **NeoForge 21.1.219 / Minecraft 1.21.1**. +A [NeoForge](https://neoforged.net/) port of [Dynmap](https://github.com/webbukkit/dynmap), +the dynamic web-map mod for Minecraft servers. Dynmap renders your worlds as a live, +Google-Maps-style view that anyone can open in a browser — no Minecraft client required — +with real-time player positions, markers, and multiple render perspectives. -This standalone build is used for deployment on an ATM10 server. The goal is to eventually submit this as a PR back to the upstream `webbukkit/dynmap` repository. +This branch targets **NeoForge 21.1.219 / Minecraft 1.21.1**. It is a fork of upstream +Dynmap's `neoforge` module, updated for the 1.21.1 API. It has been run on both vanilla +NeoForge and large modpacks (e.g. All the Mods 10, ~445 mods). -- **Upstream:** https://github.com/webbukkit/dynmap (branch: `neoforge`) -- **Fork (for PR):** https://github.com/your-fork/dynmap -- **Git host (this repo):** `Sulkta/dynmap-neoforge`, branch `neoforge-1.21.1` +## Features ---- +- Live, browser-based map of every loaded world — served by a built-in web server (default port `8123`). +- Multiple render styles (top-down flat, isometric "HD" perspective, cave/biome maps). +- Real-time player tracking, chat balloons, and a marker/area API for other mods and plugins. +- Flat-file or SQL (MySQL / MariaDB / PostgreSQL / SQLite) tile storage. +- Self-contained: `DynmapCore` is bundled into the mod jar, so there are no extra runtime dependencies. + +## Requirements + +- A NeoForge **1.21.1** (21.1.x) server. +- **JDK 21** to build from source. ## Building -Requires Java 21 and Docker (build container: `dynmap-build`). +The build uses the Gradle wrapper, so no local Gradle install is needed: ```bash -# Inside build container -cd /workspace -./gradlew shadowJar --no-daemon +./gradlew shadowJar ``` -Output: `build/libs/Dynmap-neoforge-1.21.1-3.7-SNAPSHOT-Dev-all.jar` +The output fat jar is written to: -### Memory notes -- Gradle daemon heap: capped at `-Xmx2g` (see `gradle.properties`) -- forked javac: capped at `-Xmx3g` (see `build.gradle`) -- Without these caps, JVM defaults to 25% of host RAM — causes OOM on high-RAM hosts - ---- - -## Changes from upstream `neoforge-1.20.6` - -See [CHANGES.md](./CHANGES.md) for the full changelog. - ---- - -## Test status - -| Environment | Result | -|---|---| -| Vanilla NeoForge 1.21.1 (clean server) | ✅ Passes | -| ATM10 5.5 (445 mods, NeoForge 21.1.219) | ✅ Passes | - ---- - -## Deployment - -Copy the fat jar into the server's `mods/` directory. Remove any old `Dynmap*.jar` first. - -```bash -docker cp build/libs/Dynmap-neoforge-1.21.1-3.7-SNAPSHOT-Dev-all.jar :/data/mods/ +``` +build/libs/Dynmap-neoforge-1.21.1-3.7-SNAPSHOT-Dev-all.jar ``` -> **Note:** Always remove old jars before copying a new one. The container data volume may retain old versions. +`shadowJar` bundles `DynmapCore` into the jar; build the plain `jar` task only if you are +supplying `DynmapCore` separately. ---- +## Installing -## Containers (internal, self-hosted) +1. Stop your server. +2. Remove any existing `Dynmap*.jar` from the server's `mods/` directory. +3. Copy the freshly built fat jar into `mods/`. +4. Start the server. On first run Dynmap creates its config under + `/dynmap/` and begins rendering. -| Container | Purpose | Ports | -|---|---|---| -| `dynmap-build` | Gradle build environment | — | -| `vanilla-test` | Vanilla NeoForge 1.21.1 test server | 25566 (MC), 8124 (web) | -| `modpack-test` | ATM10 5.5 test server, 445 mods | — | -| `production` (prod) | **Production ATM10 — DO NOT TOUCH** | — | +## Using the map ---- +Once the server is up, open the web map in any browser: -## PR Plan +``` +http://:8123/ +``` -Once ATM10 testing is confirmed: -1. Mirror all changes to upstream tree (`upstream/neoforge-1.21.1/`) -2. Push to `your-fork/dynmap` fork on GitHub -3. Open PR: `your-fork/dynmap:neoforge-1.21.1` → `webbukkit/dynmap:neoforge` +The bind address and port are configurable in `dynmap/configuration.txt` +(`webserver-bindaddress`, `webserver-port`). See the +[upstream Dynmap documentation](https://github.com/webbukkit/dynmap/wiki) for the full +set of configuration, render, and storage options — they apply unchanged to this port. -PR description draft is in [DYNMAP.md](https://github.com/your-fork/dynmap). +## Compatibility notes + +This port includes fixes specific to running under 1.21.1 and large modpacks — most +notably a work-around for a block-state cache deadlock that can occur with ModernFix + +FerriteCore during world load. The full, dated list of changes relative to the upstream +`neoforge-1.20.6` baseline is in [CHANGES.md](./CHANGES.md). + +## Relationship to upstream + +This is a community fork that exists to track the NeoForge 1.21.1 target ahead of an +upstream release. The long-term goal is to fold these changes back into +[webbukkit/dynmap](https://github.com/webbukkit/dynmap). If you want the canonical, +multi-platform Dynmap (Spigot/Paper, Forge, Fabric, and older NeoForge versions), use +upstream. + +## Contributing + +Issues and pull requests are welcome. To keep merges back to upstream clean, please: + +- Match the surrounding code style; avoid cosmetic-only refactors in functional PRs. +- Build and run a server with your change before submitting (`./gradlew shadowJar`, then load the jar). +- Describe what you changed and why, and note the Minecraft / NeoForge versions you tested against. + +## License + +Licensed under the Apache License 2.0 — see [LICENSE](./LICENSE). Dynmap is a trademark of +its respective owners; this fork is not affiliated with or endorsed by the upstream +maintainers.