Web Interface: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 4: Line 4:


==Web interface for Tygron Engine projects==
==Web interface for Tygron Engine projects==
Besides the regular [[user interface]] provided by the [[Tygron Engine]], there is also web interface available for the participants in a [[session]]. This interface can be reached by using most modern web browsers. It is completely composed of HTML, CSS, and javascript, functioning like a common web page. The CSS file can be changed, and HTML and javascript can be injected into the interface via the [[editor]]. This allows the web interface to be fully customized in both function and appearence.
Besides the regular [[user interface]] provided by the [[Tygron Engine]], there is also web interface available for the participants in a [[session]]. This interface can be reached by using most modern web browsers. It is completely composed of HTML, CSS, and javascript, functioning like a common web page. The CSS file can be changed, and HTML and javascript can be injected into the interface via the [[editor]]. This allows the web interface to be fully customized in both function and appearance.


===Limitations===
===Limitations===
Line 10: Line 10:


==Web interface structure==
==Web interface structure==
The web interface consists of many parts, most of which can be configured to suit many styles and use-cases.


===Map===
===Map===

Revision as of 12:26, 10 August 2017

This article is a stub.

Web interface

Web interface for Tygron Engine projects

Besides the regular user interface provided by the Tygron Engine, there is also web interface available for the participants in a session. This interface can be reached by using most modern web browsers. It is completely composed of HTML, CSS, and javascript, functioning like a common web page. The CSS file can be changed, and HTML and javascript can be injected into the interface via the editor. This allows the web interface to be fully customized in both function and appearance.

Limitations

The web interface does not function as a perfect replacement for the regular, 3D user interface. Contrary to the regular user interface, the 3D world is displayed in 2D. It's not possible to draw selections in the 2D map, which means that users will be unable to take conventional actions such as placing constructions or purchasing land. Visuals, such as cinematics, special effects, weather effects, and visible traffic are not yet available for the 2D map. The web interface also remains available while a (multi-user) session is paused.

Web interface structure

The web interface consists of many parts, most of which can be configured to suit many styles and use-cases.

Map

The map of the web interface is the most important part of the web interface. The map is only displayed in 2D, rather than 3D in the regular client. Despite this, it can still be referred to as the 3D World for most purposes. It is possible to move around across the map by clicking and dragging. It's also posible to zoom in and out by using the scrollwheel.

By default, the map will display the satellite map, which is also seen in the 3D interface. Overlayed on top are the polygons indicating the locations of water, roads, and constructions such as buildings.

Session Interface

The session interface is, in principle, the same as the regular user interface. The top bar can be found at the top of the screen, and the map panel on the right of the screen. However, there is no action menu available.

When a popup appears in the world, for example because of a stakeholder taking an action, or a panel being/becoming visible, the popup will be visible in the 2D map as well, and can be interacted with. Clicking the popup will open the related popup with the same contents and options are would be available in the 3D interface. Attention is not explicitly drawn to any popups in the web interface.

Custom HTML

It is possible to add custom content to the web interface as well. A panel can be selected to inject directly into the web interface, in a separate <div> element with both class and id set to "custom". If the content is HTML, and it contains <script> elements with javascript, the javascript is executed as the content is loaded.

Frontpage

Assets

CSS

Images

Authentication

This article describes a technical aspect, and is mainly for advanced users.


URLs

Webtokens