mirror of
https://github.com/webbukkit/dynmap.git
synced 2024-11-24 11:15:21 +01:00
mikeprimm
GitHub
commit
f4f7afb2ba
55
.github/workflows/gibberish.txt
vendored
Normal file
55
.github/workflows/gibberish.txt
vendored
Normal file
@ -0,0 +1,55 @@
|
||||
Subreddit
|
||||
blockscanner
|
||||
dynmap
|
||||
Dynmap's
|
||||
APIs
|
||||
APL
|
||||
Bukket
|
||||
Dynmap
|
||||
Dynmap's
|
||||
DynmapCore
|
||||
DynmapCoreAPI
|
||||
JRuby
|
||||
MacOS
|
||||
Minecraft
|
||||
PRs
|
||||
PaperMC
|
||||
WorldGuard
|
||||
www
|
||||
corresponiding
|
||||
depdendencies
|
||||
reflow
|
||||
runtime
|
||||
theose
|
||||
DynampCore
|
||||
DynmapCore
|
||||
DynmapCoreAPI
|
||||
Reddit
|
||||
api
|
||||
Bukkit
|
||||
mikeprimm
|
||||
michaelprimm
|
||||
repo
|
||||
https
|
||||
Fi
|
||||
Ki
|
||||
Patreon
|
||||
fi
|
||||
ko
|
||||
patreon
|
||||
README
|
||||
Gradle
|
||||
Curseforge
|
||||
SpigotMC
|
||||
PaperMC
|
||||
backends
|
||||
Minecraft
|
||||
WorldGuard
|
||||
reflow
|
||||
PRs
|
||||
JRuby
|
||||
Primm
|
||||
reddit
|
||||
subreddit
|
||||
gg
|
||||
pqBpw
|
||||
14
.github/workflows/spellcheck.yaml
vendored
Normal file
14
.github/workflows/spellcheck.yaml
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
name: Checking for spelling errors
|
||||
|
||||
on:
|
||||
push:
|
||||
|
||||
jobs:
|
||||
spellcheck:
|
||||
name: rojopolis/spellcheck
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: actions/checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: rojopolis/spellcheck - actually doing something
|
||||
uses: rojopolis/spellcheck-github-actions@0.9.1
|
||||
25
.spellcheck.yaml
Normal file
25
.spellcheck.yaml
Normal file
@ -0,0 +1,25 @@
|
||||
spellchecker: aspell
|
||||
matrix:
|
||||
- name: Markdown
|
||||
aspell:
|
||||
lang: en
|
||||
dictionary:
|
||||
wordlists:
|
||||
- .github/workflows/gibberish.txt
|
||||
encoding: utf-8
|
||||
pipeline:
|
||||
- pyspelling.filters.markdown:
|
||||
markdown_extensions:
|
||||
- markdown.extensions.extra:
|
||||
- pyspelling.filters.html:
|
||||
comments: true
|
||||
attributes:
|
||||
- title
|
||||
- alt
|
||||
ignores:
|
||||
- ':matches(code, pre)'
|
||||
- 'code'
|
||||
- 'pre'
|
||||
sources:
|
||||
- '**/*.md'
|
||||
default_encoding: utf-8
|
||||
@ -49,7 +49,7 @@ not yet (or no longer) supported by the Dynmap team. If the Dynmap team comes t
|
||||
cease distribution of the unofficial version, unless otherwise authorized to continue doing so. Further:
|
||||
- The team distributing the modified version must cite the origin of the Dynmap code, but must also clearly indicate that the version is NOT supported by
|
||||
nor endorsed by the Dynmap team, and that ALL support should be directed through the team providing the modified version.
|
||||
- Any modified version CANNOT be monitized or otherwise charged for, under any circumstances, nor can redistribution of it be limited or restricted.
|
||||
- Any modified version CANNOT be monetized or otherwise charged for, under any circumstances, nor can redistribution of it be limited or restricted.
|
||||
- The modified code must continue to be Apache Public License v2, with no additional conditions or restrictions, including full public availability of the
|
||||
modified source code.
|
||||
- Any code from Dynmap used in such versions should be built from an appropriate fork, as DynampCore and other components (other than DynmapCoreAPI and
|
||||
@ -57,8 +57,8 @@ cease distribution of the unofficial version, unless otherwise authorized to con
|
||||
least, removed). The modified version should NOT refer to the Dynmap Discord nor to /r/Dynmap on Reddit for support. in any case.
|
||||
- Any bugs or issues opened in conjunction with the use of the modified version on this repository will be closed without comment.
|
||||
|
||||
Additions of new funtion, including new platform support, in this official Dynmap code base MUST be fully contained within the PRs submitted to this
|
||||
repository. Further, it is always exptected than any updates will be built and tested across all relevant platforms - meaning anh chances to shared code
|
||||
Additions of new functions, including new platform support, in this official Dynmap code base MUST be fully contained within the PRs submitted to this
|
||||
repository. Further, it is always expected than any updates will be built and tested across all relevant platforms - meaning any chances to shared code
|
||||
components (DynmapCore, DynmapCoreAPI) MUST be successfully built and tested on ALL supported platforms (Forge, Spigot, etc). Changes which break
|
||||
supported platforms will be rejected.
|
||||
|
||||
|
||||
50
README.md
50
README.md
@ -1,6 +1,14 @@
|
||||
# Dynmap™ - dynamic web maps for Minecraft servers
|
||||
|
||||
## How to build
|
||||
# Jump around the README
|
||||
* [How to build](#how-to-build)
|
||||
* [What platforms are supported?](#what-platforms-are-supported)
|
||||
* [Data Storage](#data-storage)
|
||||
* [Contributing to Dynmap's Code](#contributing-to-dynmaps-code)
|
||||
* [Porting, Supporting Other Platforms, Customized Dynmap Builds](#porting-supporting-other-platforms-customized-dynmap-builds)
|
||||
* [Where to go for questions and discussions](#where-to-go-for-questions-and-discussions)
|
||||
* [Where to go to make donations](#where-to-go-to-make-donations)
|
||||
# How to build
|
||||
Dynmap 3.x+ uses Gradle for building support for all platforms, with all resulting artifacts produced in the /targets directory
|
||||
|
||||
To build, run:
|
||||
@ -12,21 +20,25 @@ Or (on Windows):
|
||||
gradlew.bat clean build install
|
||||
|
||||
# What platforms are supported?
|
||||
The following target platforms are supported:
|
||||
- Spigot/PaperMC - via the Dynmap-<version>-spigot.jar plugin (supports MC v1.11.2 through v1.16.4)
|
||||
- Forge v1.11.2 - via Dynmap-<version>-forge-1.11.2.jar mod
|
||||
- Forge v1.12.2 - via Dynmap-<version>-forge-1.12.2.jar mod
|
||||
- Forge v1.13.2 - via Dynmap-<version>-forge-1.13.2.jar mod
|
||||
- Forge v1.14.4 - via Dynmap-<version>-forge-1.14.4.jar mod
|
||||
- Forge v1.15.2 - via Dynmap-<version>-forge-1.15.2.jar mod
|
||||
- Forge v1.16.1 - via Dynmap-<version>-forge-1.16.1.jar mod
|
||||
- Forge v1.16.2 - via Dynmap-<version>-forge-1.16.2.jar mod
|
||||
- Forge v1.16.3 - via Dynmap-<version>-forge-1.16.3.jar mod
|
||||
- Forge v1.16.4 - via Dynmap-<version>-forge-1.16.4.jar mod
|
||||
- Fabric v1.15.2 - via Dynmap-<version>-fabric-1.15.2.jar mod
|
||||
- Fabric v1.16.1 - via Dynmap-<version>-fabric-1.16.1.jar mod
|
||||
- Fabric v1.16.2 - via Dynmap-<version>-fabric-1.16.2.jar mod
|
||||
- Fabric v1.16.4 - via Dynmap-<version>-fabric-1.16.4.jar mod
|
||||
The following target platforms are supported, and you can find them at the links supplied:
|
||||
|
||||
| Server type | Version | Dynmap JAR | Where? |
|
||||
| ------------ | ------- | ---------- | ------ |
|
||||
| Spigot/PaperMC | 1.16.5 | `Dynmap-3.1-beta-6-spigot.jar` | [SpigotMC](https://www.spigotmc.org/resources/dynmap.274/) |
|
||||
| Spigot/PaperMC | ≤1.16.4 | `Dynmap-<version>-spigot.jar` | [GitHub Releases](https://github.com/webbukkit/dynmap/releases) |
|
||||
| Forge | 1.11.2 | `Dynmap-<version>-forge-1.11.2.jar` | [GitHub Releases](https://github.com/webbukkit/dynmap/releases) |
|
||||
| Forge | 1.12.2 | `Dynmap-<version>-forge-1.12.2.jar` | [GitHub Releases](https://github.com/webbukkit/dynmap/releases) |
|
||||
| Forge | 1.13.2 | `Dynmap-<version>-forge-1.13.2.jar` | [GitHub Releases](https://github.com/webbukkit/dynmap/releases) |
|
||||
| Forge | 1.14.4 | `Dynmap-<version>-forge-1.14.4.jar` | [GitHub Releases](https://github.com/webbukkit/dynmap/releases) |
|
||||
| Forge | 1.15.2 | `Dynmap-<version>-forge-1.15.2.jar` | [GitHub Releases](https://github.com/webbukkit/dynmap/releases) |
|
||||
| Forge | 1.16.1 | `Dynmap-<version>-forge-1.16.1.jar` | [GitHub Releases](https://github.com/webbukkit/dynmap/releases) |
|
||||
| Forge | 1.16.2 | `Dynmap-<version>-forge-1.16.2.jar` | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/dynmapforge) |
|
||||
| Forge | 1.16.3 | `Dynmap-<version>-forge-1.16.3.jar` | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/dynmapforge) |
|
||||
| Forge | 1.16.4 | `Dynmap-<version>-forge-1.16.4.jar` | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/dynmapforge) |
|
||||
| Fabric | 1.15.2 | `Dynmap-<version>-fabric-1.15.2.jar` | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/dynmapforge) |
|
||||
| Fabric | 1.16.1 | `Dynmap-<version>-fabric-1.16.1.jar` | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/dynmapforge) |
|
||||
| Fabric | 1.16.2 | `Dynmap-<version>-fabric-1.16.2.jar` | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/dynmapforge) |
|
||||
| Fabric | 1.16.4 |`Dynmap-<version>-fabric-1.16.4.jar` | [Curseforge](https://www.curseforge.com/minecraft/mc-mods/dynmapforge) |
|
||||
|
||||
# Data Storage
|
||||
Dynmap supports the following storage backends:
|
||||
@ -81,7 +93,7 @@ not yet (or no longer) supported by the Dynmap team. If the Dynmap team comes t
|
||||
cease distribution of the unofficial version, unless otherwise authorized to continue doing so. Further:
|
||||
- The team distributing the modified version must cite the origin of the Dynmap code, but must also clearly indicate that the version is NOT supported by
|
||||
nor endorsed by the Dynmap team, and that ALL support should be directed through the team providing the modified version.
|
||||
- Any modified version CANNOT be monitized or otherwise charged for, under any circumstances, nor can redistribution of it be limited or restricted.
|
||||
- Any modified version CANNOT be monetized or otherwise charged for, under any circumstances, nor can redistribution of it be limited or restricted.
|
||||
- The modified code must continue to be Apache Public License v2, with no additional conditions or restrictions, including full public availability of the
|
||||
modified source code.
|
||||
- Any code from Dynmap used in such versions should be built from an appropriate fork, as DynmapCore and other components (other than DynmapCoreAPI and
|
||||
@ -89,8 +101,8 @@ cease distribution of the unofficial version, unless otherwise authorized to con
|
||||
least, removed). The modified version should NOT refer to the Dynmap Discord nor to /r/Dynmap on Reddit for support. in any case.
|
||||
- Any bugs or issues opened in conjunction with the use of the modified version on this repository will be closed without comment.
|
||||
|
||||
Additions of new funtion, including new platform support, in this official Dynmap code base MUST be fully contained within the PRs submitted to this
|
||||
repository. Further, it is always exptected than any updates will be built and tested across all relevant platforms - meaning anh chances to shared code
|
||||
Additions of new functions, including new platform support, in this official Dynmap code base MUST be fully contained within the PRs submitted to this
|
||||
repository. Further, it is always expected than any updates will be built and tested across all relevant platforms - meaning any chances to shared code
|
||||
components (DynmapCore, DynmapCoreAPI) MUST be successfully built and tested on ALL supported platforms (Forge, Spigot, etc). Changes which break
|
||||
supported platforms will be rejected.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user