Plugin channels/World downloader - Revision history

imported>Pokechu22: Update to 1.13

2018-09-03T19:15:20Z

Update to 1.13

← Older revision		Revision as of 19:15, 3 September 2018
Line 2:		Line 2:

	Implemented in-mod [https://github.com/Pokechu22/WorldDownloader/blob/v4/src/wdl/WDLPluginChannels.java here]. A bukkit implementation is available [https://github.com/Pokechu22/WorldDownloader-Serverside-Companion here].		Implemented in-mod [https://github.com/Pokechu22/WorldDownloader/blob/v4/src/wdl/WDLPluginChannels.java here]. A bukkit implementation is available [https://github.com/Pokechu22/WorldDownloader-Serverside-Companion here].

			Regarding channel names: 1.13 has necessitated namespacing the channels, i.e. <code>wdl:init</code>, <code>wdl:control</code>, <code>wdl:request</code> instead of <code>WDL\|INIT</code>, <code>WDL\|CONTROL</code>, <code>WDL\|REQUEST</code>. Support for both channel names has been backported to 1.12, and it will automatically select whichever channels are supported. If targetting older MC versions, make sure to listen and respond on both sets of channels.

	== A note before implementing these channels ==		== A note before implementing these channels ==
Line 52:		Line 54:
	\|}		\|}

	== <code>~~WDL\|INIT~~</code> ==		== <code>wdl:init</code> ==

	<code>~~WDL\|INIT~~</code> is sent to show that World Downloader is ready to receive new permissions. Don't send permissions until this is received - it may still be saving from another part of the map or another sever where it has permission, and revoking permission in the middle of (allowed) saving is a Bad Thing™.		<code>wdl:init</code> is sent to show that World Downloader is ready to receive new permissions. Don't send permissions until this is received - it may still be saving from another part of the map or another sever where it has permission, and revoking permission in the middle of (allowed) saving is a Bad Thing™.

	{\| class="wikitable"		{\| class="wikitable"
Line 63:		Line 65:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="1" \| <code>~~WDL\|INIT~~</code>		\| rowspan="1" \| <code>wdl:init</code>
	\| rowspan="1" \| Server		\| rowspan="1" \| Server
	\| Content		\| Content
Line 84:		Line 86:
	:Contains information about the state of this system; will include information about when the channels change. Currently <code style="white-space: pre-wrap">The plugin message system will be changing shortly. Please stay tuned.</code>.		:Contains information about the state of this system; will include information about when the channels change. Currently <code style="white-space: pre-wrap">The plugin message system will be changing shortly. Please stay tuned.</code>.

	== <code>~~WDL\|CONTROL~~</code> ==		== <code>wdl:control</code> ==

	This channel is sent from the server to the client to specify various permissions. It uses a 4-byte integer at the start to indicate a section. There is no required order, but it is conventional to put them in numerical order.		This channel is sent from the server to the client to specify various permissions. It uses a 4-byte integer at the start to indicate a section. There is no required order, but it is conventional to put them in numerical order.
Line 103:		Line 105:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="2" \| <code>~~WDL\|CONTROL~~</code>		\| rowspan="2" \| <code>wdl:control</code>
	\| rowspan="2" \| Client		\| rowspan="2" \| Client
	\| Discriminator		\| Discriminator
Line 125:		Line 127:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="7" \| <code>~~WDL\|CONTROL~~</code>		\| rowspan="7" \| <code>wdl:control</code>
	\| rowspan="7" \| Client		\| rowspan="7" \| Client
	\| Discriminator		\| Discriminator
Line 169:		Line 171:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="4" \| <code>~~WDL\|CONTROL~~</code>		\| rowspan="4" \| <code>wdl:control</code>
	\| rowspan="4" \| Client		\| rowspan="4" \| Client
	\| colspan="2" \| Discriminator		\| colspan="2" \| Discriminator
Line 201:		Line 203:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="3" \| <code>~~WDL\|CONTROL~~</code>		\| rowspan="3" \| <code>wdl:control</code>
	\| rowspan="3" \| Client		\| rowspan="3" \| Client
	\| Discriminator		\| Discriminator
Line 227:		Line 229:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="5" \| <code>~~WDL\|CONTROL~~</code>		\| rowspan="5" \| <code>wdl:control</code>
	\| rowspan="5" \| Client		\| rowspan="5" \| Client
	\| colspan="2" \| Discriminator		\| colspan="2" \| Discriminator
Line 263:		Line 265:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="6" \| <code>~~WDL\|CONTROL~~</code>		\| rowspan="6" \| <code>wdl:control</code>
	\| rowspan="6" \| Client		\| rowspan="6" \| Client
	\| colspan="2" \| Discriminator		\| colspan="2" \| Discriminator
Line 303:		Line 305:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="4" \| <code>~~WDL\|CONTROL~~</code>		\| rowspan="4" \| <code>wdl:control</code>
	\| rowspan="4" \| Client		\| rowspan="4" \| Client
	\| Discriminator		\| Discriminator
Line 335:		Line 337:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="5" \| <code>~~WDL\|CONTROL~~</code>		\| rowspan="5" \| <code>wdl:control</code>
	\| rowspan="5" \| Client		\| rowspan="5" \| Client
	\| Discriminator		\| Discriminator
Line 358:		Line 360:
	\|}		\|}

	== <code>~~WDL\|REQUEST~~</code> ==		== <code>wdl:request</code> ==

	Used for permission requests. Sent from the client to the server. On the server, a moderator/admin/whoever can approve or deny the request, and then other messages ([[#WDL.7CCONTROL\|<code>~~WDL\|CONTROL~~</code>]]) are sent to grant such permissions.		Used for permission requests. Sent from the client to the server. On the server, a moderator/admin/whoever can approve or deny the request, and then other messages ([[#WDL.7CCONTROL\|<code>wdl:control</code>]]) are sent to grant such permissions.

	{\| class="wikitable"		{\| class="wikitable"
Line 369:		Line 371:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="6" \| <code>~~WDL\|REQUEST~~</code>		\| rowspan="6" \| <code>wdl:request</code>
	\| rowspan="6" \| Server		\| rowspan="6" \| Server
	\| colspan="2" \| Request message		\| colspan="2" \| Request message

imported>Pokechu22: /* WDL|INIT */ Preserve spaces

2017-11-11T23:23:21Z

WDL|INIT: Preserve spaces

← Older revision		Revision as of 23:23, 11 November 2017
Line 82:		Line 82:
	:A link to this documentation.		:A link to this documentation.
	;<code>X-UpdateNote</code>		;<code>X-UpdateNote</code>
	:Contains information about the state of this system; will include information about when the channels change. Currently <code>The plugin message system will be changing shortly. Please stay tuned.</code>.		:Contains information about the state of this system; will include information about when the channels change. Currently <code style="white-space: pre-wrap">The plugin message system will be changing shortly. Please stay tuned.</code>.

	== <code>WDL\|CONTROL</code> ==		== <code>WDL\|CONTROL</code> ==

imported>Pokechu22: /* WDL|INIT */ Detail JSON blob as it exists currently.

2017-11-11T22:46:00Z

WDL|INIT: Detail JSON blob as it exists currently.

@@ Line 70: / Line 70: @@
   |}
-Content is not present on very old versions of the mod.  In all versions where it is present, content is a UTF-8 string.  In older versions, it is a simple version number; in newer versions, it is a JSON blob that contains some information including the version.  The exact specification for the JSON blob has not been finalized.
+Content is not present on very old versions of the mod.  In all versions where it is present, content is a UTF-8 string.  In older versions, it is a simple version number; in newer versions, it is a JSON blob that contains some information including the version; if it starts with a <code>{</code> then it MUST be a valid JSON blob.  The exact specification for the JSON blob has not been finalized, but it currently contains the following information fields:
 == <code>WDL|CONTROL</code> ==

imported>Pokechu22: Much-needed clarifications that I've been meaning to make for a while.

2017-03-18T00:20:43Z

Much-needed clarifications that I've been meaning to make for a while.

← Older revision		Revision as of 00:20, 18 March 2017
Line 1:		Line 1:
	Documentation of the [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/2520465 World Downloader mod]'s plugin channel configuration system.		Documentation of the [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/2520465 World Downloader mod]'s plugin channel configuration system.

	Implemented in-mod [https://github.com/Pokechu22/WorldDownloader/blob/~~master~~/src/wdl/WDLPluginChannels.java here]. A bukkit implementation is available [https://github.com/Pokechu22/WorldDownloader-Serverside-Companion here].		Implemented in-mod [https://github.com/Pokechu22/WorldDownloader/blob/v4/src/wdl/WDLPluginChannels.java here]. A bukkit implementation is available [https://github.com/Pokechu22/WorldDownloader-Serverside-Companion here].

	== ~~Note~~ ==		== A note before implementing these channels ==

	All types here are as specified by Java's [http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html <code>DataOutputStream</code>] and can be read using a [http://docs.oracle.com/javase/7/docs/api/java/io/DataInputStream.html <code>DataInputStream</code>], unless otherwise noted.		Please do ''not'' misuse these channels, and please ''do'' implement the full collection (including permission requests). They only make sense when used completely.

			These channels have been designed in a very deliberate way, so that players should not need to circumvent the system for valid uses of the mod (and yes, there ''are'' valid uses (perhaps the majority are, even)... otherwise, these channels wouldn't exist!). Implementing only a subset and neglecting permission requests means that players need to go through other channels, of which you don't have control over. Implementing permission requests allows you to set specific ''policies'' for use of the mod, something that isn't possible any other way.

			These channels act as a guideline that governs how you wish the mod to be used on your server. Obviously, it can't be a hard rule (that's very much technically impossible), so choose something granular and practical.

			== Data types ==

			All types here are as specified by Java's [http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html <code>DataOutputStream</code>] and can be read using a [http://docs.oracle.com/javase/7/docs/api/java/io/DataInputStream.html <code>DataInputStream</code>], unless otherwise noted. They do '''not''' use the [[Data types\|standard protocol data types]]. Additionally, the format is not directly compatible with some standard channel implementations - if you use forge or sponge's default indexed codecs, things won't work right (those use 1 byte; this uses 4 bytes).


Line 57:		Line 65:
	\| rowspan="1" \| <code>WDL\|INIT</code>		\| rowspan="1" \| <code>WDL\|INIT</code>
	\| rowspan="1" \| Server		\| rowspan="1" \| Server
	\| ~~Mod version~~		\| Content
	\| ~~UTF8 string~~		\| Byte array
	\| This is a byte array that takes up the entire length of the packet - there is no length prefixed to it.		\| This is a byte array that takes up the entire length of the packet - there is no length prefixed to it.
	\|}		\|}

	~~In some earlier~~ versions of the mod ~~there~~ is no version ~~info sent~~, ~~and~~ the ~~packet length is 0~~.		Content is not present on very old versions of the mod. In all versions where it is present, content is a UTF-8 string. In older versions, it is a simple version number; in newer versions, it is a JSON blob that contains some information including the version. The exact specification for the JSON blob has not been finalized.

	== <code>WDL\|CONTROL</code> ==		== <code>WDL\|CONTROL</code> ==

imported>Pokechu22: Remove warning; link to example implementation.

2016-04-15T15:13:51Z

Remove warning; link to example implementation.

← Older revision		Revision as of 15:13, 15 April 2016
Line 1:		Line 1:
	~~{{Box\|~~
	~~BORDER = #FFCC00\|~~
	~~BACKGROUND = #FFFF00\|~~
	~~WIDTH = 100%\|~~
	~~ICON = \|~~
	~~HEADING = Work in progress! \|~~
	~~CONTENT =~~
	~~This page is a work in progress, and may be missing information.~~
	}}

	Documentation of the [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/2520465 World Downloader mod]'s plugin channel configuration system.		Documentation of the [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/2520465 World Downloader mod]'s plugin channel configuration system.

	~~See~~ [https://github.com/Pokechu22/WorldDownloader/blob/master/src/wdl/WDLPluginChannels.java here].		Implemented in-mod [https://github.com/Pokechu22/WorldDownloader/blob/master/src/wdl/WDLPluginChannels.java here]. A bukkit implementation is available [https://github.com/Pokechu22/WorldDownloader-Serverside-Companion here].

	== Note ==		== Note ==

imported>Pokechu22: Pokechu22 moved page User:Pokechu22/World downloader to Plugin channels/World downloader: Move to mainspace

2016-04-09T21:00:05Z

Pokechu22 moved page User:Pokechu22/World downloader to Plugin channels/World downloader: Move to mainspace

← Older revision	Revision as of 21:00, 9 April 2016
(No difference)

imported>Pokechu22: /* Set chunk overrides by tag */ Fix discriminator number

2016-02-03T14:44:00Z

Set chunk overrides by tag: Fix discriminator number

← Older revision		Revision as of 14:44, 3 February 2016
Line 329:		Line 329:
	\| Discriminator		\| Discriminator
	\| Integer		\| Integer
	\| Set to 6 to indicate this packet.		\| Set to 7 to indicate this packet.
	\|-		\|-
	\| Group		\| Group

imported>Pokechu22: /* WDL|INIT */ Rewrite and add channel.

2016-02-02T18:49:39Z

WDL|INIT: Rewrite and add channel.

← Older revision		Revision as of 18:49, 2 February 2016
Line 56:		Line 56:
	== <code>WDL\|INIT</code> ==		== <code>WDL\|INIT</code> ==

	<code>WDL\|INIT</code> is sent to show that World Downloader is ready to receive new permissions. Don't send permissions until this is received - it may still be saving from another part of the map or another sever where it has permission, and revoking permission in the middle is a Bad Thing™.		<code>WDL\|INIT</code> is sent to show that World Downloader is ready to receive new permissions. Don't send permissions until this is received - it may still be saving from another part of the map or another sever where it has permission, and revoking permission in the middle of (allowed) saving is a Bad Thing™.

	{\| class="wikitable"		{\| class="wikitable"
			! Channel
	! Bound To		! Bound To
	! Field Name		! Field Name
Line 64:		Line 65:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="2" \| Server		\| rowspan="1" \| <code>WDL\|INIT</code>
			\| rowspan="1" \| Server
	\| Mod version		\| Mod version
	\| UTF8 string		\| UTF8 string
	\| This is a byte array; the ~~remainder~~ of the packet ~~is this value (~~there is no length ~~specified). In some older versions of the mod, this is not present and the length of the packet is 0~~.		\| This is a byte array that takes up the entire length of the packet - there is no length prefixed to it.
	\|}		\|}

			In some earlier versions of the mod there is no version info sent, and the packet length is 0.

	== <code>WDL\|CONTROL</code> ==		== <code>WDL\|CONTROL</code> ==

imported>Pokechu22: /* WDL|CONTROL */ "Remove chunk overrides by tag" and "Set chunk overrides by tag" are on WDL|CONTROL, not WDL|REQUEST

2016-02-02T18:45:04Z

WDL|CONTROL: "Remove chunk overrides by tag" and "Set chunk overrides by tag" are on WDL|CONTROL, not WDL|REQUEST

← Older revision		Revision as of 18:45, 2 February 2016
Line 289:		Line 289:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="4" \| <code>WDL\|~~REQUEST~~</code>		\| rowspan="4" \| <code>WDL\|CONTROL</code>
	\| rowspan="4" \| Client		\| rowspan="4" \| Client
	\| Discriminator		\| Discriminator
Line 321:		Line 321:
	! Notes		! Notes
	\|-		\|-
	\| rowspan="5" \| <code>WDL\|~~REQUEST~~</code>		\| rowspan="5" \| <code>WDL\|CONTROL</code>
	\| rowspan="5" \| Client		\| rowspan="5" \| Client
	\| Discriminator		\| Discriminator

imported>Pokechu22: /* WDL|REQUEST */ Fix bullet points

2016-02-01T18:01:54Z

WDL|REQUEST: Fix bullet points

← Older revision		Revision as of 18:01, 1 February 2016
Line 387:		Line 387:
	Valid fields and their values:		Valid fields and their values:

	* <code>downloadInGeneral</code>: Whether or not chunks downloading in all terrain is allowed. <code>true</code> if so, <code>false</code> otherwise.		* <code>downloadInGeneral</code>: Whether or not chunks downloading in all terrain is allowed. <code>true</code> if so, <code>false</code> otherwise.
	* <code>cacheChunks</code>: Whether chunks can be cached as the player moves about the world. <code>true</code> if so, <code>false</code> otherwise.		* <code>cacheChunks</code>: Whether chunks can be cached as the player moves about the world. <code>true</code> if so, <code>false</code> otherwise.
	* <code>saveRadius</code>: Distance from the player chunks can be saved (in a square). If -1, all distance is allowed. Only applies when <code>cacheChunks</code> is not true; if that is true this is ignored and thus in most cases that should be done (since a value of -1 still only allows saving what can be seen). The value is an integer as a string, potentially negative.		* <code>saveRadius</code>: Distance from the player chunks can be saved (in a square). If -1, all distance is allowed. Only applies when <code>cacheChunks</code> is not true; if that is true this is ignored and thus in most cases that should be done (since a value of -1 still only allows saving what can be seen). The value is an integer as a string, potentially negative.
	* <code>saveEntities</code>: Whether or not entities can be saved. <code>true</code> if so, <code>false</code> otherwise.		* <code>saveEntities</code>: Whether or not entities can be saved. <code>true</code> if so, <code>false</code> otherwise.
	* <code>saveTileEntities</code>: Whether tile entities can be saved as the player moves about the world. <code>true</code> if so, <code>false</code> otherwise.		* <code>saveTileEntities</code>: Whether tile entities can be saved as the player moves about the world. <code>true</code> if so, <code>false</code> otherwise.
	* <code>saveContainers</code>: Whether chests and other tile entities that require manual interaction can be saved as the player moves about the world. Requires <code>saveTileEntities</code> to also be true. <code>true</code> if so, <code>false</code> otherwise.		* <code>saveContainers</code>: Whether chests and other tile entities that require manual interaction can be saved as the player moves about the world. Requires <code>saveTileEntities</code> to also be true. <code>true</code> if so, <code>false</code> otherwise.
	* <code>getEntityRanges</code>: Whether entity ranges should be sent to the player. <code>true</code> if so, <code>false</code> otherwise, but if your server doesn't change entity ranges from the vanilla defaults this doesn't need to be sent.		* <code>getEntityRanges</code>: Whether entity ranges should be sent to the player. <code>true</code> if so, <code>false</code> otherwise, but if your server doesn't change entity ranges from the vanilla defaults this doesn't need to be sent.

	Not all fields need to be set. No field should be specified more than once in a packet. If the field isn't set but was sent on a previous packet, the field should still be unset - clear the last request before adding in the new one (however, if a request was accepted, the requested permissions should '''not''' be cleared). A packet without any requests should clear the current request list.		Not all fields need to be set. No field should be specified more than once in a packet. If the field isn't set but was sent on a previous packet, the field should still be unset - clear the last request before adding in the new one (however, if a request was accepted, the requested permissions should '''not''' be cleared). A packet without any requests should clear the current request list.