backups/Fantasy-Map-Generator
1
0
Fork 0
mirror of https://github.com/Azgaar/Fantasy-Map-Generator.git synced 2025-12-18 10:01:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated User Interface (markdown)

Azgaar 2024-10-13 21:11:45 +02:00
parent 63b63889cc
commit 1f7ddfef90
1 changed files with 3 additions and 107 deletions
Download patch file Download diff file Expand all files Collapse all files

110
User-Interface.md

@ -14,16 +14,10 @@ For example, the paint brush button appears in many windows, and in all of them
## General controls ## General controls
These elements appear in many places in the UI, for example in the various windows. These elements appear in many places in the UI, for example in the various windows.
### Windows ### Windows
Such as the various editors. Such as the various editors.
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/7fe536df-7bfb-43dc-b002-5814aea2f105)
</details>
### Legends ### Legends
A panel that displays a description of a certain element. A panel that displays a description of a certain element.
@ -31,23 +25,9 @@ This is a non-closeable window. Instead, it closes automatically when the mouse
For example, when going over a regiment, it will be displayed for example: For example, when going over a regiment, it will be displayed for example:
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/fcf2e709-5955-44f2-879e-3ac96c85edfa)
</details>
### Tables ### Tables
Such as the tables that appear in the overview windows. Such as the tables that appear in the overview windows.
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/afdca957-9415-4aa8-a9ac-6b09c680f0f2)
</details>
#### Features #### Features
##### Sorting ##### Sorting
If the element has a numerical value, it will be possible to sort in ascending or descending order. If the element has a numerical value, it will be possible to sort in ascending or descending order.
@ -121,56 +101,22 @@ Using the mouse by Double click,
Using the keyboard by Pressing + (plus) and - (minus), or press numbers (from 0-9, The higher the number, the higher its zoom level). Using the keyboard by Pressing + (plus) and - (minus), or press numbers (from 0-9, The higher the number, the higher its zoom level).
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/569fee0c-24b2-4dd5-96d1-83524c929cb1)
</details>
There is also support for touch screen and mouse pad. There is also support for touch screen and mouse pad.
## Moving on the map ## Moving on the map
By dragging the mouse, or by the navigation keys (right, left, up and down). By dragging the mouse, or by the navigation keys (right, left, up and down).
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/8fb29957-6b8f-417c-b151-ac6618aa0315)
</details>
# Menu # Menu
<details> FMG menu contain 5 tabs: Layers, Style, Option, Tools, About.
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/9b804378-8431-478f-9413-1fd63ed5d50c) Any of the tabs contain the Lower Menu Section.
</details>
fmg menu contain 5 tabs:
[Layers](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/2.3.3.1-(Layers-Tab)-Layers-preset),
[Style](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/2.3.4.1-(Style-Tab)-General),
Option,
Tools,
About.
Any of the tabs contain the [Lower Menu Section](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/2.3.2-(Menu)-Lower-Section).
## Increasing the menu size ## Increasing the menu size
Increase by shortcut keys ctrl & +, and decrease by ctrl & -. Increase by shortcut keys ctrl & +, and decrease by ctrl & -.
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/275163ca-adc9-4380-9397-1b04b4caad2d)
</details>
## Tabs shortcuts ## Tabs shortcuts
### Layers Tabs shortcuts ### Layers Tabs shortcuts
@ -185,13 +131,6 @@ For example, if you click on the rivers layer with ctrl pressed, you will naviga
The buttons on the Lower Menu Section is in any of the menu tabs. The buttons on the Lower Menu Section is in any of the menu tabs.
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/c4c92fd5-dfac-4af1-993d-710edca61dd2)
</details>
## New Map ## New Map
Generates a new map (according to the settings in the Options tab). Generates a new map (according to the settings in the Options tab).
@ -202,13 +141,6 @@ The map size depends on the screen size, as fmg tries to fill the entire screen.
Export the map to a certain format. Export the map to a certain format.
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/e4aa1803-8e3b-4fdd-a629-83e83115701f)
</details>
### Download image ### Download image
There are several buttons for downloading images in different formats (svg, png, jpeg). There are several buttons for downloading images in different formats (svg, png, jpeg).
@ -217,13 +149,6 @@ Note: Generator uses pop-up window to download files. Please ensure your browser
There is also a buttons to download a zip of several tiles (in a separate png file) of the map. After click the tile button, a new window will pop up, allowing the user to select number of Columns and Rows. There is also a buttons to download a zip of several tiles (in a separate png file) of the map. After click the tile button, a new window will pop up, allowing the user to select number of Columns and Rows.
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/06fde902-a87d-4b5d-87a3-dd7cd6ff4fad)
</details>
### Export to GeoJSON ### Export to GeoJSON
There are several buttons for downloading some data in GeoJSON formats (data can be cells, routes, rivers, markers. There are several buttons for downloading some data in GeoJSON formats (data can be cells, routes, rivers, markers.
@ -236,13 +161,6 @@ There are several buttons for downloading some data in JSON formats.
Saving a file in .map format, which contains the current state of the map, so that we can load it in the future using the load button. Saving a file in .map format, which contains the current state of the map, so that we can load it in the future using the load button.
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/a5135da8-9bb9-416f-a568-d52b7ae4557a)
</details>
### Save options ### Save options
#### Machine #### Machine
@ -263,13 +181,6 @@ Loading a previously saved map.
The buttons correspond to those of the save window. The buttons correspond to those of the save window.
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/64294832-7c9f-46c6-9c67-f65e4466936f)
</details>
## Reset Zoom ## Reset Zoom
Reset zoom to its initial position. Reset zoom to its initial position.
@ -383,23 +294,8 @@ If equal to 0, the color of the element will (mostly) be the color of what is be
### Shift by axes ### Shift by axes
![image](https://github.com/user-attachments/assets/e15a2e67-e9b0-4778-a2ef-11911d69b982)
Allows you to shift the layer on the x-axis and the y-axis. Allows you to shift the layer on the x-axis and the y-axis.
For example, for texture styling, if we choose this:
70, 10
The map will look like this:
<details>
<summary>Show Image</summary>
![image](https://github.com/user-attachments/assets/52c8cf26-4677-4505-b578-7f58e7b035d6)
You see that the texture layer moves to the right by 50 units, and moves down by 70 units.
</details>
### Filter ### Filter
![image](https://github.com/user-attachments/assets/9ae43d89-f729-4ef2-b554-653d295afd5a) ![image](https://github.com/user-attachments/assets/9ae43d89-f729-4ef2-b554-653d295afd5a)