From WebDisplays
Revision as of 08:57, 13 February 2018 by Montoyo (talk | contribs)
Jump to: navigation, search

The screen block is used to build web screens. To configure it (i.e. change rights, rotation, resolution, etc...), use the Screen Configurator item.



The item on the bottom line is a Backlight.

How to build

The screen block alone is useless. In order to build a working screen, you need to place screen blocks in a plane configuration (width x height x 1 multiblock structure). The minimum size is 2x2 (this can't be changed), and the default maximum size is 16x16 (this can be changed in the configuration file). Once the structure is built, simply right-click on the side where you want the screen to be with an empty hand. Horizontal screens are supported since WebDisplays 1.12.2.

A valid screen structure

Interacting with the screen

Changing the URL

To change the screen URL, sneak and right-click (again, with an empty hand) the screen.

The GUI used to change the URL

If you forget the protocol, WebDisplays will automatically add "http://" at the beginning of your URL. The "YT" button is used to turn regular YouTube URLs to embed (full-screen) YouTube URLs. It will unlock if a YouTube URL is detected. Clicking it while holding shift will add the auto-play argument to the URL so that the embedded movie starts immediately once the page is loaded.

Please note that some videos (like music videos) do not allow embedding, so this doesn't always work.


There are two ways to click on the screen. The first one consists in right-clicking the screen with an empty hand. The second requires the Laser Sensor upgrade and the Laser Pointer item. How to use them is described in detail on their respective pages.

All these methods will perform left-clicks on the web browser. Currently, there is no way to right-click.


You can type using the Keyboard peripheral. After placing it, use the Linking Tool to bind it to the screen, and then right-click on the keyboard to start typing. To exit the keyboard, press Escape.

Permissions & ownership

Since WebDisplays 1.12.2, every screen has an owner. Depending on the screen's configuration, players (except the owner of course) have restricted access to that screen. The only way to change the screen owner is by either breaking the screen and re-creating it, or by using the Ownership Thief item (which is only available via the /give command).

The owner does not only have all rights on his screen, but is also responsible for sending some JavaScript queries to the server. Thus, if he is disconnected or outside the screen view range, some JavaScript functionalities will be unavailable (for instance, all JS queries provided by the Redstone Output Port will be ineffective).

Multiplayer synchronization

In Multiplayer, screens ARE NOT synchronized. Every player has a separate web browser instance, and may not see web pages the same way you do. Most of the time web pages do not change depending on who is watching it, thus giving an illusion of synchronization. A good example of desync is the YouTube homepage, which suggests videos based on your video history (among other things). So if a player clicks on a video on the YouTube homepage, everyone will see a different video depending on what YouTube suggested.


WebDisplays screens feature two extension mechanisms: peripherals and upgrades.


Peripherals are blocks which can be linked to screens using the Linking Tool. Currently, WebDisplays features 5 peripherals:


Upgrades are items that provides additionnal features to the screen. Simply right-click on the screen with an upgrade in hand to install it. To remove an upgrade, you'll have to use a Screen Configurator. Right now, WebDisplays offers 4 upgrades:

Special URLs

Player pages

Because of the new features allowing JavaScript to interact with redstone, players can upload small web pages to the server, making them available to other players. This is done using the Server block. This functionality can be disabled through the configuration file.

These pages can be accesses through special URLs that look like this: wd://player-uuid/page.html

Internal pages

WebDisplays comes with 3 internal pages:

  • mod://webdisplays/main.html The default homepage
  • mod://webdisplays/io.html Is a page that demoes the Redstone Input Port and the Redstone Output Port capabilities
  • mod://webdisplays/blacklisted.html Is displayed if a blacklisted page shows up


Web pages may interact with screens using MCEF queries. These can be invoked using the following code:

window.mcefQuery({request: "WebDisplays_{QueryName}",
	persistent: true,
	onSuccess: function(response) {},
	onFailure: function(errCode, errMsg) {}

Some queries require parameters to work. Parameters are passed in the query name between parenthesis. For instance, the GetRedstoneAt requires x and y parameters, so the request name should look like this: WebDisplays_GetRedstoneAt(0, 0). Please note that the query names are case insensitive.

WebDisplays will return data in the JSON format through the success callback.

You can also use the wdlib.js file, which is completely free and features easy-to-use functions to interact with WebDisplays.


This is a list of queries which do not require any extension to work:

Query name Arguments Return value Comment
GetSize None {"x": int, "y": int}
GetUpgrades None {"upgrades":[string]}
IsOwner None {"isOwner":bool} Returns true if the client is the screen owner
GetRotation None {"rotation":int} Multiply by 90 to get the and in degrees
GetSide None {"side":int} 0 to 5 (inclusive), B-T-N-S-W-E order


This is a list of functions called by WebDisplays

  • webdisplaysUpgradesChanged() will be called when an upgrade is installed or removed from the screen

Domain blacklist

You can black-list some domain names through the WebDisplays configuration file. Be aware that this system is subdomain-sensitive, so if you blacklist, will still be accessible.