|
|
| (82 intermediate revisions by 7 users not shown) |
| Line 1: |
Line 1: |
| {{learned|what the interface is|how the tygron engine interface is implemented|how to use the interface in various parts of the engine}} | | The [[{{software|client}}]] is an application that allows users to log in and interact with the {{software}}. It can be used to: |
| | * [[New Project Wizard|Create new projects]]; |
| | * [[editor|Edit existing projects]]; |
| | * Explore [[scenario]]s using [[session|test-run sessions]]; |
| | * Host [[session|single and multi-stakeholder sessions]]; |
| | * [[Account management|Manage your {{software}} account]]. |
|
| |
|
| ==Interface==
| | The [[{{software|client}}]] provides distinct user interfaces for these various actions: |
| An interface is an intermediary by which two systems, such as a human and a machine, communicate. An interface serves as a means to retrieve and provide information in a way the other system is capable of providing or understanding.
| | ; Login screens |
| | : ''The login screen and various validation screens. These are shown before you have logged in and shortly after to check if the user can connect with the {{software}} and properly run the {{software|client}}.'' |
| | ; [[Administration]]: |
| | : ''To manage your [[project]]s and [[Account Management|account]] and optionally [[domain]], you can use the administration interface.'' |
| | ; [[Viewer]] |
| | : ''The interface relevant to [[Stakeholder]]s in a the project [[session]]. This interface is rendered on top of the [[3D Visualization]], and provides a user with all the options and information relevant to their role as stakeholder. This is the most complex interface.'' |
| | ;[[Editor]] |
| | : ''The interface used to [[editor|edit]] a [[project]]. It is structured around the [[Viewer]] and also rendered on top of the [[3D Visualization]].'' |
|
| |
|
| ==How interfaces are implemented in the Tygron Engine== | | ===Viewer=== |
| Each part of the Tygron Engine which can be accessed, can be accessed by using a GUI (graphical user interface). This means that options are provided by listing them in the form of texts or icons, and you can select these options using your cursor. Because the Tygron Engine encompasses several different functions, the Tygron Engine also uses different interfaces to allow you to interact with it.
| | [[File:Interface_game_general.jpg|thumb|800px|center|The [[Viewer ]]interface.]]<br clear=both> |
| | The [[Viewer]] is the interface relevant to [[Stakeholder]] during a session. It is rendered on top of the [[3D Visualization]]. Near the edges of the screen you can find the most prominent parts of the interface; the [[Top bar]], the [[Action menu panel]], the [[Navigation panel]]. These are available to provide information to the user, provide means to the user to gather more information, and to interact with the [[Session|project session]]. |
| | Other panels, such as [[Popup panel|popup]], [[Indicator panel|indicator]] and [[budget panel]]s are accessible through these panels or by interacting with objects, such as [[popup]]s, in the [[3D Visualization]]. |
|
| |
|
| ==Types of interface==
| | {{viewer nav}} |
| There are 5 different types of interface which may be available as you use the Tygron Engine.
| |
| ; Main menu
| |
| : ''The login screen and initial menu. In the main menu, you can select which functionality of the Tygron Engine you wish to use (whether you wish to [[design|edit a game]], [[deploy|play a game]] or [[distribute|manage your games and accounts]].''
| |
| ; Management
| |
| : ''The management screens. To manage your games and accounts, you can use the management screens. In these screens, you will be able to use simple lists and buttons to indicate what you wish to do.''
| |
| ; Game
| |
| : ''The interface during the game. This interface is overlaid over the [[3D World]], and provides a player with all the options and information relevant to their stakeholder. This is the most complex interface.''
| |
| ; Multiplayer
| |
| : ''The [[multiplayer]] administration application. This is a simple interface used to control multiplayer sessions. All options are organized in tabs.''
| |
| ;Editor
| |
| : ''The interface used to [[editor|edit]] a game. Part of the interface includes a panel with a view of the 3D World with the game interface. The editor interface is structured around the 3D World panel.''
| |
|
| |
|
| ==How to use the interfaces== | | ===Editor=== |
| | | [[File:Q1-2016-EditorPanel.jpg|thumb|850px|center|The Tygron Editor. The Ribbon at the top of the screen, the Left Panel on the left side of the screen, the User Main Interface in the center of the screen, the Right Panel on the right side of the screen, and the Bottom Panel at the bottom of the screen.]]<br clear=both> |
| Although each interface follows standard practices for software interfaces, it can sometimes be a bit daunting when an interface changes. This is why descriptions for the interfaces are available.
| | The [[Editor|Editor interface]] is synonymous with the editor. It is the interface which allows you to change projects as desired. The editor interface consists of the Editor Menu bar, the Editing area and the [[3D Visualization]], which is itself the user interface. The editor allows access to editor panels which allow various components of a project to be added, changed, and removed, such as [[stakeholders]], [[indicators]] and [[building]]s. |
| | | {{Template:Editor ui nav}} |
| ===Main menu===
| |
| The main menu Is the first visible interface. It is first seen when starting the Tygron Engine in the form of a login screen. When you have logged in successfully, the main menu will appear on the left of the screen. Each option has a clickable icon, and is located in a descriptive section with a title at the top. When an icon is clicked, you progress further into the menu. When your options have clearly indicated what you wish to do, you will proceed into a different part of the editor. For example, you can follow the steps below to start the editor, and enter a different part of the Tygron Engine with a different interface: | |
| | |
| {{editor steps|title=start the editor to create a new game|Go to {{url}}.|If presented with a log in screen, enter a valid username and password, and log in.|Under the heading "Editor", select "Start Editor".|Select "New Project".}}
| |
|
| |
|
| ===Management===
| | {{article end |
| The management interface is used for the screens where you are able to manage your games and accounts. They can be found under the option "Options" in the main menu. They are screens comprised of lists of that which you wish to manage, and several input fields for their properties. By using the buttons and input fields, you can change the properties of users and games.
| | |seealso= |
| | | }} |
| ===Game===
| | [[Category:Interface]] |
| [[File:Interface_game_general.jpg|400px|right|The game interface.]]
| |
| The game interface is the most complex interface in the Tygron Engine. During the game, the 3D World is largest visible element on the screen. Near the edges of the screen you can find the most prominent parts of the interface. These are used to provide information to the player, provide means to the player to gather more information, and to interact with the 3D world.<br clear=all>
| |
| | |
| ====Top bar====
| |
| [[File:Interface_game_topbar_small.jpg|400px|right|The top bar, which provided information the stakeholders and indicators.]]
| |
| The top bar is the large element at the top of the interface. Displayed, in order from left to right, are the Tygron logo, the [[stakeholder]] name, the time, the display mode, and the [[indicators]]. When the Tygron logo is pressed, the credits of the game are displayed. The stakeholder name indicates which role the player has selected, and thus which party the represent in the game. They can click the name of the stakeholder to view descriptions of other stakeholders. The time indicates how long the game has been running so far. The display mode allows you to switch between seeing the 3D world as it currently is and how it was at the start of the game.
| |
| | |
| The right section of the top bar is entirely filled with indicators. Starting with the [[Budget (Indicator)|budget indicator]] and ending with the [[Progress (Indicator)|progress indicator]]. Each indicator shows the current amount of progress made on that indicator towards the goal set for it. By hovering over the indicators, you can see the full name of the indicator, the current score on the indicator, and the importance of this indicator for your total score.
| |
| | |
| ====Category panel====
| |
| [[File:Interface_game_category_panel_small.jpg|400px|right|The category panel, which contains a stakeholder's actions.]]
| |
| The category panel is the list of icons on the left hand side of the screen. This panel contains the [[actions]] you are able to take during the game. By clicking on one of the icons, you open the action panel. In the action panel you can select a specific action.
| |
| | |
| If it's a measure without a spatial element, you will simple be able to "apply" or "cancel" the action. If it's an action with configurable settings (such as the amount of floors for a building), an element will be provided to allow you to select a proper value.
| |
| | |
| If you need to indicate in the 3D World where to take the action, you can use the cursor to "draw" a selection on the game area. This is done by pointing the cursor at the game area, holding down the left mouse button, and releasing the mousebutton. {{:Drawing_validity}}<!--transclusion, because this part is shared with brush-->
| |
| | |
| ====Minimap====
| |
| [[File:Interface_game_minimap.jpg|400px|right|The minimap, which allows a user to see the entire map at a glance, activate overlays an locate notifications.]] | |
| The minimap is the nearly square panel on the right hand side of the screen. It is a small representation of the game area. The cyan rectangle on the minimap indicates where you are currently looking it. The text at the top is the name of the zone you are looking at.
| |
| | |
| The most important function of the minimap is to allow you to traverse the game area quickly. When you click anywhere on the minimap, you are immediately brought to the location on which you clicked. When you or another player take an action which requires your attention, an exclamation mark will appear on the minimap. Clicking on an exclamation mark will not only immediately move you to the area in question, but also open up the [[popup]] at that location.
| |
| | |
| Located at the bottom of the minimap are buttons which allow you to switch [[overlay]]. By switching to a different overlay, the 3D World is colored differently to provide you with additional information.
| |
| | |
| You can also use the minimap to signal a location to other players. By clicking on the ping button at the top right of the minimap, the minimap of all other players will show your location. You can use this to indicate to another player a specific location in the game area.
| |
| | |
| ====Minor interface elements====
| |
| Next to the major interface elements described above, there are also a number of smaller elements in the interface. These will appear and disappear depending on your interaction with the game.
| |
| | |
| =====Legend=====
| |
| When drawing in the 3D World, or using an overlay other than the default overlay, a legend will be displayed at the bottom of the screen. Drawing in the world or activating an overlay will cause part or all of the world to be colored. The legend serves as a reference for which colors correspond to what information. For example, when viewing the [[Ownership (Overlay)|ownership overlay]], the legend will display which stakeholder is displayed with which color. When viewing the [[Livability (Overlay|livability overlay]], it provides a reminder of which colors indicate the most and least desirable values.
| |
| | |
| =====Hover panel=====
| |
| When you hold the cursor still over any part of the game area, the hover panel will appear. The hover panel will display information about the area your cursor is pointing at, based on which overlay is currently active. By default, it displays the owner of an area, along with the [[behavior|type of terrain]] and [[constructions|construction]] located there. When, for example, the zoning overlay is active, it displays how much of each permitted [[function|type of construction]] is located in the indicated zone.
| |
| | |
| =====Popups=====
| |
| Popups are an important part of the interface, that are not immediately visible to the player. Instead, they appear whenever an action is taken, and input is required from the player concerning that action. This includes actions which the player takes themselves, but popups more often appear when other players take actions which the player in question must respond to. They also appear in the minimap in the form of exclamation marks.
| |
| | |
| ===Multiplayer===
| |
| | |
| ===Editor===
| |
| : ''Main article:[[Editor]].
| |
