From 36cd2cc46705b46be4362c4bfad8ee285c034137 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 15:38:56 +0100 Subject: [PATCH 01/15] Use https where possible --- source/about/glossary.rst | 4 ++-- source/about/history.rst | 2 +- source/contributing/versioning.rst | 2 +- source/plugin/blocks/concepts.rst | 2 +- source/plugin/internals/mcp-setup.rst | 4 ++-- source/plugin/project/maven.rst | 2 +- .../plugin/text/representations/formatting-code-legacy.rst | 2 +- source/plugin/text/representations/json.rst | 4 ++-- source/plugin/text/text.rst | 2 +- .../getting-started/configuration/server-properties.rst | 6 +++--- source/server/getting-started/configuration/sponge-conf.rst | 2 +- .../server/getting-started/implementations/spongeforge.rst | 4 ++-- source/server/getting-started/migrating.rst | 2 +- source/server/management/bans.rst | 2 +- source/server/management/permissions.rst | 4 ++-- source/server/spongineer/bugreport.rst | 2 +- source/server/spongineer/commands.rst | 2 +- 17 files changed, 24 insertions(+), 24 deletions(-) diff --git a/source/about/glossary.rst b/source/about/glossary.rst index 3ffe37fdb08f..0f01d479fe71 100644 --- a/source/about/glossary.rst +++ b/source/about/glossary.rst @@ -29,7 +29,7 @@ FLARD It is green, edible, and explosive. Leave it alone and it will leave you alone. Forge A long-standing Minecraft modding API, with its own installer. Forge enables mods in single player, LAN, and on - dedicated servers. http://www.minecraftforge.net/wiki/ + dedicated servers. https://mcforge.readthedocs.io/en/latest/ GitHub A free public web-based system for sharing code and creating projects. https://github.com/ Implementation @@ -78,7 +78,7 @@ Sponge Forums regularly. https://forums.spongepowered.org/ Sponge Foundation The financial side of the project, a separate entity that accepts, manages and distributes donations. - http://spongefoundation.org/ + https://spongefoundation.org/ SpongeVanilla An implementation of Sponge API that runs on Vanilla Minecraft (and not Forge). Spongie diff --git a/source/about/history.rst b/source/about/history.rst index 4d96a0818d62..5ba7b6610d52 100644 --- a/source/about/history.rst +++ b/source/about/history.rst @@ -60,7 +60,7 @@ The History of Spongie ---------------------- Spongie first appeared in #Sponge on Esper.NET around September 2014. She was created and posted by -`DragonsPainter `__. Strad, another user, felt that Spongie would look better with +`DragonsPainter `__. Strad, another user, felt that Spongie would look better with a moogle-like antenna, a Forge furnace instead of a Cauldron and replaced the Spigot with Spout. An anonymous user then removed all labels and introduced her as the icon and background logo for the Sponge reddit section. diff --git a/source/contributing/versioning.rst b/source/contributing/versioning.rst index 9c13a27d4447..15c15bc26e48 100644 --- a/source/contributing/versioning.rst +++ b/source/contributing/versioning.rst @@ -2,7 +2,7 @@ Versioning System and Repository Branch Layout ============================================== -With the release for beta we've moved the SpongeAPI versioning to semantic versioning (see http://semver.org/). +With the release for beta we've moved the SpongeAPI versioning to semantic versioning (see https://semver.org/). This change means that every time that we make a release we have to increment the version according to the rules of semver. diff --git a/source/plugin/blocks/concepts.rst b/source/plugin/blocks/concepts.rst index 813dfccd263f..46e5f9e0c344 100644 --- a/source/plugin/blocks/concepts.rst +++ b/source/plugin/blocks/concepts.rst @@ -57,7 +57,7 @@ additional way that *some* blocks have data: tile entities. Tile entities themselves are Java objects (like a `Chest` class). Normally, Minecraft code would access data in a tile entity by getting its instance and then calling it methods or fields, like a regular object (``world.getTileEntity(position).getInventory()``). When tile entities need to be written to the save file, they are -stored in the `NBT format `_. +stored in the `NBT format `_. .. tip:: diff --git a/source/plugin/internals/mcp-setup.rst b/source/plugin/internals/mcp-setup.rst index b80e201ecfd5..876904fbba4f 100644 --- a/source/plugin/internals/mcp-setup.rst +++ b/source/plugin/internals/mcp-setup.rst @@ -42,7 +42,7 @@ Vanilla Workspace repositories { maven { name = 'forge' - url = 'http://files.minecraftforge.net/maven' + url = 'https://files.minecraftforge.net/maven' } } @@ -70,7 +70,7 @@ Forge Workspace repositories { maven { name = 'forge' - url = 'http://files.minecraftforge.net/maven' + url = 'https://files.minecraftforge.net/maven' } } diff --git a/source/plugin/project/maven.rst b/source/plugin/project/maven.rst index 31d07b0c4e20..1a7295de1e3b 100644 --- a/source/plugin/project/maven.rst +++ b/source/plugin/project/maven.rst @@ -57,7 +57,7 @@ required properties, but optional properties must be specified on the command li .. code-block:: bash - $ mvn archetype:generate -DarchetypeArtifactId=sponge-plugin-archetype -DarchetypeGroupId=org.spongepowered -DarchetypeRepository=http://repo.spongepowered.org/maven -DarchetypeVersion=1.2 -DgithubProject=waylon531/spongeparty + $ mvn archetype:generate -DarchetypeArtifactId=sponge-plugin-archetype -DarchetypeGroupId=org.spongepowered -DarchetypeRepository=https://repo.spongepowered.org/maven -DarchetypeVersion=1.2 -DgithubProject=waylon531/spongeparty The first four arguments specify where maven will find the archetype and which version to use. The ``-DgithubProject=waylon531/spongeparty`` parameter is an optional property for the generated project and can be left diff --git a/source/plugin/text/representations/formatting-code-legacy.rst b/source/plugin/text/representations/formatting-code-legacy.rst index 396016062f66..8bea9f6ac97e 100644 --- a/source/plugin/text/representations/formatting-code-legacy.rst +++ b/source/plugin/text/representations/formatting-code-legacy.rst @@ -12,7 +12,7 @@ Text can be represented by using a special character indicating a formatting *of indicating the specific formatting to be used. In the SpongeAPI, there are two different characters that are supported by default: the ampersand (&) and the section character (§). -Both formatting schemes use the codes found at the `Minecraft Wiki `_. +Both formatting schemes use the codes found at the `Minecraft Wiki `_. It is important to note that the Minecraft Wiki only displays the use of the section character (§), but the same codes work with the ampersand (&) as well. diff --git a/source/plugin/text/representations/json.rst b/source/plugin/text/representations/json.rst index f2e0ab809d61..ab80b3916b33 100644 --- a/source/plugin/text/representations/json.rst +++ b/source/plugin/text/representations/json.rst @@ -2,9 +2,9 @@ JSON Format =========== -JSON is `JavaScript Object Notation `_, a "light-weight data-interchange format" that is "easy +JSON is `JavaScript Object Notation `_, a "light-weight data-interchange format" that is "easy for humans to read and write" and "for machines to parse and generate". The -`Minecraft Wiki `_ details the structure of text represented +`Minecraft Wiki `_ details the structure of text represented in JSON. For example, the text "Hello World!", formatted with the color red and an underline would have the following representation diff --git a/source/plugin/text/text.rst b/source/plugin/text/text.rst index 61d0dabed4f9..eb8e99aa30d9 100644 --- a/source/plugin/text/text.rst +++ b/source/plugin/text/text.rst @@ -139,7 +139,7 @@ useful when creating minigame plugins, but have a broad range of applications. .. tip:: - Read this `Minecraft wiki article `__ for help understanding + Read this `Minecraft wiki article `__ for help understanding what target selectors are in Minecraft, and how to use them. To use selectors in text, you must use the :javadoc:`Selector.Builder` interface. This is illustrated in the example diff --git a/source/server/getting-started/configuration/server-properties.rst b/source/server/getting-started/configuration/server-properties.rst index ec41214c3052..a29752b5a7a4 100644 --- a/source/server/getting-started/configuration/server-properties.rst +++ b/source/server/getting-started/configuration/server-properties.rst @@ -54,7 +54,7 @@ Here is the default server.properties file of an unmodified Minecraft 1.8.1 serv Property Explanation ---------------------- -Credit goes to the editors at the `Minecraft Wiki `__ for the explanations. +Credit goes to the editors at the `Minecraft Wiki `__ for the explanations. **Boolean** properties have only two valid values: *true* and *false*. **Integer** properties must be whole numbers. Where a range is specified, the number must be in that range. @@ -134,9 +134,9 @@ Credit goes to the editors at the `Minecraft Wiki `__ | +| | | | `Superflat `__ | | | | | and | -| | | | `Customized `__ | +| | | | `Customized `__| | | | | on the Minecraft Wiki (external links) for possible | | | | | settings and examples. | +-------------------------------+-------------+-------------+------------------------------------------------------------+ diff --git a/source/server/getting-started/configuration/sponge-conf.rst b/source/server/getting-started/configuration/sponge-conf.rst index 740557f5f77a..b48ed43c4369 100644 --- a/source/server/getting-started/configuration/sponge-conf.rst +++ b/source/server/getting-started/configuration/sponge-conf.rst @@ -243,7 +243,7 @@ This config was generated using SpongeForge build 2360 (with Forge 2282), Sponge # # If you need help with the configuration or have any questions related to Sponge, # # join us at the IRC or drop by our forums and leave a post. # - # # IRC: #sponge @ irc.esper.net ( http://webchat.esper.net/?channel=sponge ) + # # IRC: #sponge @ irc.esper.net ( https://webchat.esper.net/?channel=sponge ) # # Forums: https://forums.spongepowered.org/ # diff --git a/source/server/getting-started/implementations/spongeforge.rst b/source/server/getting-started/implementations/spongeforge.rst index 06bfd0d6a455..bd72e15ea95a 100644 --- a/source/server/getting-started/implementations/spongeforge.rst +++ b/source/server/getting-started/implementations/spongeforge.rst @@ -92,7 +92,7 @@ Dedicated Servers Installing Forge via Commandline -------------------------------- -1. Visit the `Minecraft Forge website `_ and click "Show all downloads" to view the full +1. Visit the `Minecraft Forge website `_ and click "Show all downloads" to view the full set of available options. Identify the version matching the one listed :doc:`in the filename of the SpongeForge download `, and hover over the (i) next to "Installer" to get the direct download link. #. Use your favorite download method to download the jar to its destination. @@ -105,7 +105,7 @@ Installing Forge via Commandline Installing Forge via GUI ------------------------ -1. Download the Minecraft Forge installer from the `Minecraft Forge website `_ for the version +1. Download the Minecraft Forge installer from the `Minecraft Forge website `_ for the version matching the one listed in the filename of the SpongeForge download. See above for the naming scheme of SpongeForge and Forge. #. Run the provided Forge installer, select "Install Server", choose an empty folder to place the server's files, diff --git a/source/server/getting-started/migrating.rst b/source/server/getting-started/migrating.rst index 75471f296c16..f6361169ba1e 100644 --- a/source/server/getting-started/migrating.rst +++ b/source/server/getting-started/migrating.rst @@ -196,7 +196,7 @@ Migrating to SpongeForge ------------------------ You must first ensure you are running a version of Forge that is compatible with the version of SpongeForge your plan to -use. You may find recommended builds of Forge at `Forge Downloads `_. If you are using +use. You may find recommended builds of Forge at `Forge Downloads `_. If you are using any other mods, they must also be updated. When you are ready to install SpongeForge, you may proceed with the following steps: diff --git a/source/server/management/bans.rst b/source/server/management/bans.rst index e57cc4621c4f..e6e36a7a169c 100644 --- a/source/server/management/bans.rst +++ b/source/server/management/bans.rst @@ -16,4 +16,4 @@ list of banned IP addresses is available using the command ``/banlist ips`` A ban can be reversed using the command ``/pardon `` or ``/pardon `` -More information on Bans can be found at the `Minecraft Wiki `_. +More information on Bans can be found at the `Minecraft Wiki `_. diff --git a/source/server/management/permissions.rst b/source/server/management/permissions.rst index 103da24b0454..46fa06b7be72 100644 --- a/source/server/management/permissions.rst +++ b/source/server/management/permissions.rst @@ -11,14 +11,14 @@ Operator Level ============== Minecraft comes with a simple way to give permissions: by setting users as operator (or "op" for short). General -information on op status can be found at http://minecraft.gamepedia.com/Op +information on op status can be found at https://minecraft.gamepedia.com/Op The abilities of op permission may be adjusted by altering the ``op-permission-level`` setting in the :doc:`../../server/getting-started/configuration/server-properties` file. A list of native Minecraft server commands available to players with op can be found at the `Minecraft Wiki -`_. +`_. .. warning:: diff --git a/source/server/spongineer/bugreport.rst b/source/server/spongineer/bugreport.rst index 3b9b044bdd02..3fd790ccc645 100644 --- a/source/server/spongineer/bugreport.rst +++ b/source/server/spongineer/bugreport.rst @@ -15,7 +15,7 @@ Whenever you report a bug, please include the following: * any other mods or plugins installed including their versions * your :doc:`logs` - * please use a service like `GitHubs gist `_ or `pastebin `_ to provide + * please use a service like `GitHubs gist `_ or `pastebin `_ to provide logs, *don't* paste them into the post directly * your crash report (optional, not necessarily created) diff --git a/source/server/spongineer/commands.rst b/source/server/spongineer/commands.rst index dede4bacc57a..e9e801b2835f 100644 --- a/source/server/spongineer/commands.rst +++ b/source/server/spongineer/commands.rst @@ -198,5 +198,5 @@ Command Description Permission | -A full list of vanilla commands can be found at: http://minecraft.gamepedia.com/Commands#List_of_commands. Permissions +A full list of vanilla commands can be found at: https://minecraft.gamepedia.com/Commands#List_of_commands. Permissions for vanilla Minecraft commands on a Sponge server are of the structure ``minecraft.command.``. From 3fef9a5ac1f36ac4af6c20683605145d40f2f1f3 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 15:44:01 +0100 Subject: [PATCH 02/15] Revert because "Duplicate explicit target name"!? --- source/server/getting-started/implementations/spongeforge.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/server/getting-started/implementations/spongeforge.rst b/source/server/getting-started/implementations/spongeforge.rst index bd72e15ea95a..06bfd0d6a455 100644 --- a/source/server/getting-started/implementations/spongeforge.rst +++ b/source/server/getting-started/implementations/spongeforge.rst @@ -92,7 +92,7 @@ Dedicated Servers Installing Forge via Commandline -------------------------------- -1. Visit the `Minecraft Forge website `_ and click "Show all downloads" to view the full +1. Visit the `Minecraft Forge website `_ and click "Show all downloads" to view the full set of available options. Identify the version matching the one listed :doc:`in the filename of the SpongeForge download `, and hover over the (i) next to "Installer" to get the direct download link. #. Use your favorite download method to download the jar to its destination. @@ -105,7 +105,7 @@ Installing Forge via Commandline Installing Forge via GUI ------------------------ -1. Download the Minecraft Forge installer from the `Minecraft Forge website `_ for the version +1. Download the Minecraft Forge installer from the `Minecraft Forge website `_ for the version matching the one listed in the filename of the SpongeForge download. See above for the naming scheme of SpongeForge and Forge. #. Run the provided Forge installer, select "Install Server", choose an empty folder to place the server's files, From 06f6f62e89d1f86d10a8b5eee2408d760bd42ce5 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 15:47:20 +0100 Subject: [PATCH 03/15] Remove no longer needed link --- source/about/glossary.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/about/glossary.rst b/source/about/glossary.rst index 0f01d479fe71..b08e0fc56f44 100644 --- a/source/about/glossary.rst +++ b/source/about/glossary.rst @@ -78,7 +78,6 @@ Sponge Forums regularly. https://forums.spongepowered.org/ Sponge Foundation The financial side of the project, a separate entity that accepts, manages and distributes donations. - https://spongefoundation.org/ SpongeVanilla An implementation of Sponge API that runs on Vanilla Minecraft (and not Forge). Spongie From 420a9dd8264aaf82d3a14683e0b35a869d60a9c9 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 15:50:29 +0100 Subject: [PATCH 04/15] Fix missed https --- .../server/getting-started/implementations/spongeforge.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/server/getting-started/implementations/spongeforge.rst b/source/server/getting-started/implementations/spongeforge.rst index 06bfd0d6a455..f40540ad53a0 100644 --- a/source/server/getting-started/implementations/spongeforge.rst +++ b/source/server/getting-started/implementations/spongeforge.rst @@ -68,7 +68,7 @@ Installing SpongeForge Single Player / In-Game LAN Servers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Download the Minecraft Forge installer from the `Minecraft Forge website `_. Make +1. Download the Minecraft Forge installer from the `Minecraft Forge website `_. Make sure to use **exactly the same build number** as shown above. #. Run the provided Forge installer. A new Forge profile will be created in the Minecraft launcher. #. Open the Minecraft launcher, and select the new Forge profile. @@ -92,7 +92,7 @@ Dedicated Servers Installing Forge via Commandline -------------------------------- -1. Visit the `Minecraft Forge website `_ and click "Show all downloads" to view the full +1. Visit the `Minecraft Forge website `_ and click "Show all downloads" to view the full set of available options. Identify the version matching the one listed :doc:`in the filename of the SpongeForge download `, and hover over the (i) next to "Installer" to get the direct download link. #. Use your favorite download method to download the jar to its destination. @@ -105,7 +105,7 @@ Installing Forge via Commandline Installing Forge via GUI ------------------------ -1. Download the Minecraft Forge installer from the `Minecraft Forge website `_ for the version +1. Download the Minecraft Forge installer from the `Minecraft Forge website `_ for the version matching the one listed in the filename of the SpongeForge download. See above for the naming scheme of SpongeForge and Forge. #. Run the provided Forge installer, select "Install Server", choose an empty folder to place the server's files, From 481c945a3a37476fb476316ccf01b0a5dc9fec6e Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 15:59:22 +0100 Subject: [PATCH 05/15] Skip redirect to http://configurate.aoeu.xyz/apidocs/ --- source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/conf.py b/source/conf.py index af079b2d4bed..594cef56f90b 100644 --- a/source/conf.py +++ b/source/conf.py @@ -91,7 +91,7 @@ javadoc_links = { 'https://jd.spongepowered.org/%s/' % release: ['org.spongepowered.api'], - 'http://zml2008.github.io/configurate/apidocs/': ['ninja.leaping.configurate'], + 'http://configurate.aoeu.xyz/apidocs/': ['ninja.leaping.configurate'], 'https://docs.oracle.com/javase/8/docs/api/': ['java'], 'https://google.github.io/guava/releases/17.0/api/docs/': ['com.google.common'] } From 565b8e8ed917513ea19d8c4f616b963113099996 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 16:09:19 +0100 Subject: [PATCH 06/15] Link to SpongeGradle project --- source/plugin/plugin-meta.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/plugin/plugin-meta.rst b/source/plugin/plugin-meta.rst index 662c8cd9b96f..93d91e56fbac 100644 --- a/source/plugin/plugin-meta.rst +++ b/source/plugin/plugin-meta.rst @@ -88,7 +88,7 @@ If you're not using a build system you need to manually enable annotation proces Build system integration ------------------------ -If you're using Gradle, `SpongeGradle `_ will provide additional integration for Gradle and +If you're using Gradle, `SpongeGradle `_ will provide additional integration for Gradle and plugin metadata. For example, it will automatically include the project version defined in the Gradle build script in your plugin metadata. See :doc:`project/gradle` for details. From 596e8c29b5550b98bbd22f5ae931d701bcee6780 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 17:29:47 +0100 Subject: [PATCH 07/15] Fix more broken links --- source/plugin/data/custom/datamanipulators.rst | 6 +++--- source/plugin/data/custom/serialization.rst | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/source/plugin/data/custom/datamanipulators.rst b/source/plugin/data/custom/datamanipulators.rst index 6caa1a545ebe..1aa98c48d02e 100644 --- a/source/plugin/data/custom/datamanipulators.rst +++ b/source/plugin/data/custom/datamanipulators.rst @@ -22,9 +22,9 @@ Custom DataManipulators org.spongepowered.api.data.value.mutable.MapValue org.spongepowered.api.data.value.mutable.BoundedComparableValue org.spongepowered.api.data.value.ValueContainer - org.spongepowered.api.inventory.ItemStack + org.spongepowered.api.item.inventory.ItemStack org.spongepowered.api.util.TypeTokens - java.util.Comparable + java.lang.Comparable java.util.Comparator com.google.common.reflect.TypeToken @@ -37,7 +37,7 @@ You'll want to define an API method for each "unit" your data, such as a ``Strin a custom type like ``Home``. These units will be wrapped in a :javadoc:`Value`, which will allow it to be accessed with :javadoc:`Key`\ s. There are various extensions of ``Value`` depending on which object will be represented, such as :javadoc:`MapValue` which provides the standard map operations, or :javadoc:`BoundedComparableValue` which can set -limits on the upper and lower bound of an :javadoc:`Comparable` objects like integers. +limits on the upper and lower bound of a :javadoc:`Comparable` objects like integers. Now, pick which of the :javadoc:`AbstractData` types you'll extend from. While you could implement from scratch, these abstract types remove a *lot* of the work that needs to be done implementing the required methods. A full list can be diff --git a/source/plugin/data/custom/serialization.rst b/source/plugin/data/custom/serialization.rst index c4fe494dab96..ae3bb61c9582 100644 --- a/source/plugin/data/custom/serialization.rst +++ b/source/plugin/data/custom/serialization.rst @@ -5,15 +5,15 @@ Serializing Custom Data .. javadoc-import:: org.spongepowered.api.data.DataHolder org.spongepowered.api.data.DataQuery + org.spongepowered.api.data.DataSerializable org.spongepowered.api.data.manipulator.DataManipulator + org.spongepowered.api.data.manipulator.DataManipulatorBuilder org.spongepowered.api.data.persistence.AbstractDataBuilder org.spongepowered.api.data.persistence.DataBuilder org.spongepowered.api.data.persistence.DataContentUpdater org.spongepowered.api.data.persistence.DataManipulator - org.spongepowered.api.data.persistence.DataManipulatorBuilder org.spongepowered.api.data.persistence.DataTranslator org.spongepowered.api.data.persistence.DataTranslators - org.spongepowered.api.data.serialization.DataSerializable Without a method for serializing and deserializing, your data will not persist across restarts. Sponge has a few different ways to serialize/deserialize data based on the type of data: From 8e84c10b304ab554024902977d90dcfb77d67115 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 18:14:18 +0100 Subject: [PATCH 08/15] Skip redirection + fix broken links --- source/contributing/implementation/codestyle.rst | 2 +- source/index.rst | 10 +++++----- source/plugin/buildsystem.rst | 2 +- source/plugin/workspace/idea.rst | 2 +- source/preparing/ide.rst | 2 +- source/preparing/text.rst | 2 +- .../getting-started/implementations/spongeforge.rst | 2 +- .../getting-started/implementations/spongevanilla.rst | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/source/contributing/implementation/codestyle.rst b/source/contributing/implementation/codestyle.rst index fa3fc18d1179..9472e912540e 100644 --- a/source/contributing/implementation/codestyle.rst +++ b/source/contributing/implementation/codestyle.rst @@ -68,7 +68,7 @@ Code Conventions ``null`` in the API * Method parameters accepting ``null`` must be annotated with ``@Nullable`` (from javax.*), all methods and parameters are ``@Nonnull`` by default. -* Use `Google Preconditions `_ for null- and +* Use `Google Preconditions `_ for null- and argument checking. The Gist diff --git a/source/index.rst b/source/index.rst index 8f84b760b93c..c51e5b03fdf7 100644 --- a/source/index.rst +++ b/source/index.rst @@ -9,7 +9,7 @@ Welcome to SpongeDocs, the official documentation for the open-source `Sponge `_. +`here `_. Not sure what you're looking for? Try our :doc:`about/index` section, which contains a short :doc:`about/introduction`, our :doc:`about/faq` and an article about :doc:`about/structure`. @@ -29,7 +29,7 @@ or visit their repositories on GitHub: .. note:: Sponge development is ongoing. Beta and Experimental builds of both SpongeForge and SpongeVanilla are currently - available for `download `_. + available for `download `_. Contents ======== @@ -121,13 +121,13 @@ Links :maxdepth: 2 :titlesonly: -- `Sponge Homepage `_ +- `Sponge Homepage `_ - `Sponge Forums `_ - `Sponge Discord `_ -- `Sponge Downloads `_ +- `Sponge Downloads `_ - `SpongeAPI Issue Tracker `_ - `SpongeAPI Javadocs `_ - `Sponge Twitter `_ -- `Sponge Subreddit `_ +- `Sponge Subreddit `_ - `Sponge GitHub `_ - `Sponge Patreon Donation Page `_ diff --git a/source/plugin/buildsystem.rst b/source/plugin/buildsystem.rst index 8ad4dcebf145..ab3d5d65a63a 100644 --- a/source/plugin/buildsystem.rst +++ b/source/plugin/buildsystem.rst @@ -70,4 +70,4 @@ your plugin. Continue at :doc:`plugin-identifier` for choosing an identifier for .. _`Maven Users Centre`: https://maven.apache.org/users/index.html .. _`Maven in 5 Minutes`: https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html .. _`Maven Getting Started Guide`: https://maven.apache.org/guides/getting-started/index.html -.. _`SpongeAPI Download Page`: https://repo.spongepowered.org/maven/org/spongepowered/spongeapi/ +.. _`SpongeAPI Download Page`: https://www.spongepowered.org/downloads/spongeapi/ diff --git a/source/plugin/workspace/idea.rst b/source/plugin/workspace/idea.rst index 0dbd4169c342..4d32fbd3f1a3 100644 --- a/source/plugin/workspace/idea.rst +++ b/source/plugin/workspace/idea.rst @@ -81,4 +81,4 @@ Git Integration JetBrains offers documentation on Git integration: -https://www.jetbrains.com/idea/help/using-git-integration.html +https://www.jetbrains.com/help/idea/using-git-integration.html diff --git a/source/preparing/ide.rst b/source/preparing/ide.rst index 91aaab542ffb..fcb48ade7aba 100644 --- a/source/preparing/ide.rst +++ b/source/preparing/ide.rst @@ -15,7 +15,7 @@ Which one should I choose? Every IDE has its pros and cons, and there is no single best IDE for Sponge development. The IDE you choose to use is largely a matter of personal preference. That being said, it is worth mentioning that `IntelliJ IDEA Community Edition -`__ is fairly popular amongst a majority of the core Sponge team. +`__ is fairly popular amongst a majority of the core Sponge team. Downloads ========= diff --git a/source/preparing/text.rst b/source/preparing/text.rst index ee24c1c9f4d7..d21e8b7ce8ae 100644 --- a/source/preparing/text.rst +++ b/source/preparing/text.rst @@ -2,7 +2,7 @@ Installing a Text Editor ======================== -Articles on SpongeDocs are saved as text files in the `reStructuredText `_ markup +Articles on SpongeDocs are saved as text files in the `reStructuredText `_ markup language. Although your operating system's default text editor is likely sufficient for editing these files, installing a different text editor may prove to be useful. diff --git a/source/server/getting-started/implementations/spongeforge.rst b/source/server/getting-started/implementations/spongeforge.rst index f40540ad53a0..76365094bafe 100644 --- a/source/server/getting-started/implementations/spongeforge.rst +++ b/source/server/getting-started/implementations/spongeforge.rst @@ -10,7 +10,7 @@ Users who do not want to use Minecraft Forge can consider :doc:`SpongeVanilla `_. +Grab your copy of `Sponge Forge here `_. Reading the Download Filename ============================= diff --git a/source/server/getting-started/implementations/spongevanilla.rst b/source/server/getting-started/implementations/spongevanilla.rst index 8c2d965466cd..cfd3b0fd3000 100644 --- a/source/server/getting-started/implementations/spongevanilla.rst +++ b/source/server/getting-started/implementations/spongevanilla.rst @@ -17,7 +17,7 @@ do not want to run a Forge server. Originally started as an independent project Download ======== -Grab your copy of `Sponge Vanilla here `_. +Grab your copy of `Sponge Vanilla here `_. Installing SpongeVanilla ======================== From a4f6c2a8cd04dda90a2158644fc26f5cb38a5ac7 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 23:35:13 +0100 Subject: [PATCH 09/15] Fix url --- source/server/management/bans.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/server/management/bans.rst b/source/server/management/bans.rst index e6e36a7a169c..604592db19c8 100644 --- a/source/server/management/bans.rst +++ b/source/server/management/bans.rst @@ -16,4 +16,4 @@ list of banned IP addresses is available using the command ``/banlist ips`` A ban can be reversed using the command ``/pardon `` or ``/pardon `` -More information on Bans can be found at the `Minecraft Wiki `_. +More information on Bans can be found at the `Minecraft Wiki `_. From 66ec1224386be892d7ce793dd6c060a051872c8f Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 23:50:29 +0100 Subject: [PATCH 10/15] Update bugreport.rst --- source/server/spongineer/bugreport.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/server/spongineer/bugreport.rst b/source/server/spongineer/bugreport.rst index 3fd790ccc645..676193f26111 100644 --- a/source/server/spongineer/bugreport.rst +++ b/source/server/spongineer/bugreport.rst @@ -15,8 +15,8 @@ Whenever you report a bug, please include the following: * any other mods or plugins installed including their versions * your :doc:`logs` - * please use a service like `GitHubs gist `_ or `pastebin `_ to provide - logs, *don't* paste them into the post directly +* please use a service like `GitHubs gist `_ to provide logs, *don't* paste them into the post +directly * your crash report (optional, not necessarily created) From d9d1aa1aa13654964f0101359d02c3d2408dbe1a Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 26 Nov 2017 23:55:57 +0100 Subject: [PATCH 11/15] Fix last commit's formatting --- source/server/spongineer/bugreport.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/server/spongineer/bugreport.rst b/source/server/spongineer/bugreport.rst index 676193f26111..6afc853f0e0d 100644 --- a/source/server/spongineer/bugreport.rst +++ b/source/server/spongineer/bugreport.rst @@ -15,8 +15,8 @@ Whenever you report a bug, please include the following: * any other mods or plugins installed including their versions * your :doc:`logs` -* please use a service like `GitHubs gist `_ to provide logs, *don't* paste them into the post -directly + * please use a service like `GitHubs gist `_ to provide logs, *don't* paste them into the + post directly * your crash report (optional, not necessarily created) From e9285fe3607c054317378b9675cd38aa7bbac28a Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Tue, 28 Nov 2017 21:32:28 +0100 Subject: [PATCH 12/15] Edit them out --- source/about/glossary.rst | 2 +- source/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/about/glossary.rst b/source/about/glossary.rst index b08e0fc56f44..4b7c637eb626 100644 --- a/source/about/glossary.rst +++ b/source/about/glossary.rst @@ -54,7 +54,7 @@ Ore The Official Sponge plugin hosting site, not ready yet. Use the Sponge Forums instead. Patreon A Service that allows for donations to projects and organizations. If you want to support Sponge, this is the place to - look at! `Sponge Patreon Donation Page `__ + look at! `Sponge Patreon Donation Page `__ Plugin A Minecraft mod that extends and changes Minecraft via the SpongeAPI, usable only on Sponge servers. Project Leaders diff --git a/source/index.rst b/source/index.rst index c51e5b03fdf7..8e35e8fd5aa7 100644 --- a/source/index.rst +++ b/source/index.rst @@ -130,4 +130,4 @@ Links - `Sponge Twitter `_ - `Sponge Subreddit `_ - `Sponge GitHub `_ -- `Sponge Patreon Donation Page `_ +- `Sponge Patreon Donation Page `_ From c8d8756d418cab642065da6d6f45208ce6d9c8f7 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Tue, 28 Nov 2017 21:50:44 +0100 Subject: [PATCH 13/15] Replaced by mixins --- source/about/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/about/glossary.rst b/source/about/glossary.rst index 4b7c637eb626..b689d2084ee2 100644 --- a/source/about/glossary.rst +++ b/source/about/glossary.rst @@ -19,7 +19,7 @@ Contributor Someone who contributes code to the SpongePowered projects. Coremod A Forge mod that is loaded before any Mojang classes are loaded. The purpose of a CoreMod is to patch actual Minecraft - code. http://www.minecraftforge.net/wiki/Core_Mod + code. Replaced by mods/plugins using Mixins. Crowdin A web-based translation system for documentation. SpongeDocs uses it to provide translated Docs in many languages. https://crowdin.com/project/sponge-docs From 11239d58aa217395d2c2fc998614c73a5cdb47fd Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Wed, 29 Nov 2017 21:16:03 +0100 Subject: [PATCH 14/15] Replace occurrences of BoundedComparableValue + SpongeEventFactory --- source/plugin/data/custom/datamanipulators.rst | 13 +++++++------ source/plugin/event/listeners.rst | 8 ++++---- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/source/plugin/data/custom/datamanipulators.rst b/source/plugin/data/custom/datamanipulators.rst index 1aa98c48d02e..d396a732071a 100644 --- a/source/plugin/data/custom/datamanipulators.rst +++ b/source/plugin/data/custom/datamanipulators.rst @@ -3,7 +3,6 @@ Custom DataManipulators ======================= .. javadoc-import:: - org.spongepowered.api.event.game.state.GameInitializationEvent org.spongepowered.api.data.DataManager org.spongepowered.api.data.DataRegistration org.spongepowered.api.data.DataSerializable @@ -18,10 +17,11 @@ Custom DataManipulators org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleData org.spongepowered.api.data.manipulator.mutable.tileentity.FurnaceData org.spongepowered.api.data.value.ValueFactory - org.spongepowered.api.data.value.mutable.Value + org.spongepowered.api.data.value.mutable.BoundedValue org.spongepowered.api.data.value.mutable.MapValue - org.spongepowered.api.data.value.mutable.BoundedComparableValue + org.spongepowered.api.data.value.mutable.Value org.spongepowered.api.data.value.ValueContainer + org.spongepowered.api.event.game.state.GameInitializationEvent org.spongepowered.api.item.inventory.ItemStack org.spongepowered.api.util.TypeTokens java.lang.Comparable @@ -35,9 +35,10 @@ create a separate API for your custom data. Generally speaking it's best to sepa You'll want to define an API method for each "unit" your data, such as a ``String``, ``int``, :javadoc:`ItemStack` or a custom type like ``Home``. These units will be wrapped in a :javadoc:`Value`, which will allow it to be accessed -with :javadoc:`Key`\ s. There are various extensions of ``Value`` depending on which object will be represented, such -as :javadoc:`MapValue` which provides the standard map operations, or :javadoc:`BoundedComparableValue` which can set -limits on the upper and lower bound of a :javadoc:`Comparable` objects like integers. +with :javadoc:`Key`\s. There are various extensions of ``Value`` depending on which object will be represented, such +as :javadoc:`MapValue` which provides the standard map operations, or :javadoc:`BoundedValue` which can set +limits on the upper and lower bound of the value (like integers). The bounds of the values are verified using a +:javadoc:`Comparator`. Now, pick which of the :javadoc:`AbstractData` types you'll extend from. While you could implement from scratch, these abstract types remove a *lot* of the work that needs to be done implementing the required methods. A full list can be diff --git a/source/plugin/event/listeners.rst b/source/plugin/event/listeners.rst index 3e5ae33bc52b..8caf42710570 100644 --- a/source/plugin/event/listeners.rst +++ b/source/plugin/event/listeners.rst @@ -7,7 +7,6 @@ Event Listeners org.spongepowered.api.event.EventManager org.spongepowered.api.event.Listener org.spongepowered.api.event.Order - org.spongepowered.api.event.SpongeEventFactory org.spongepowered.api.event.block.ChangeBlockEvent org.spongepowered.api.event.block.ChangeBlockEvent.Break org.spongepowered.api.event.cause.Cause @@ -69,7 +68,7 @@ the class containing the event listeners. Dynamically Registering Event Listeners -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Some plugins (such as scripting plugins) may wish to dynamically register an event listener. In that case the event listener is not a method annotated with ``@Listener``, but rather a class implementing the ``EventListener`` interface. @@ -131,7 +130,7 @@ event listeners, including those registered with ``@Listener`` annotations. .. _about_listener: About @Listener -~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~ The ``@Listener`` annotation has a few configurable fields: @@ -181,7 +180,8 @@ The method returns ``true`` if the event was cancelled, ``false`` if not. Firing Sponge Events ~~~~~~~~~~~~~~~~~~~~ -It is possible to generate instances of built-in events with the static :javadoc:`SpongeEventFactory`. The events +It is possible to generate instances of built-in events with the static ``SpongeEventFactory``. This class is +automatically generated so there are no Javadocs. Use your IDE's autocompletion to list the existing methods. The events created by the ``SpongeEventFactory`` are then passed to :javadoc:`EventManager#post(Event)`. Example: Firing LightningEvent From 24173d1df6e26fecdd1e9f82a26c2238e28ba8ea Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Thu, 30 Nov 2017 19:11:40 +0100 Subject: [PATCH 15/15] Brutalising the definition --- source/about/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/about/glossary.rst b/source/about/glossary.rst index b689d2084ee2..ff7f9027d70c 100644 --- a/source/about/glossary.rst +++ b/source/about/glossary.rst @@ -18,8 +18,8 @@ API Contributor Someone who contributes code to the SpongePowered projects. Coremod - A Forge mod that is loaded before any Mojang classes are loaded. The purpose of a CoreMod is to patch actual Minecraft - code. Replaced by mods/plugins using Mixins. + A CoreMod is a Forge mod that loads before Mojang classes are loaded, allowing it to modify native Minecraft code via + Access Transformers, ASM class modification, or other Java bytecode manipulation. Crowdin A web-based translation system for documentation. SpongeDocs uses it to provide translated Docs in many languages. https://crowdin.com/project/sponge-docs