Skip to content

FlyWithLua-based user interface to control the "Enhanced Cloudscapes" plugin for X-Plane 11

Notifications You must be signed in to change notification settings

rkkpmptk/Enhanced-Cloudscapes-Controller-for-X-Plane

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Enhanced Cloudscapes Controller

FlyWithLua-based user interface to control the "Enhanced Cloudscapes" plugin for X-Plane 11. Offers real-time editing and persistence for plugin datarefs.

 

Table of Contents

  1. Requirements
  2. Installation
  3. Uninstallation
  4. First Start
  5. User Interface
    1. Cloud Controller window
    2. User Interface settings
  6. Known Issues
  7. License

 

1 - Requirements

  Back to table of contents

2 - Installation

Copy the "Scripts" and "Modules" folders into "X-Plane 11/Resources/plugins/FlyWithLua/"

  Back to table of contents

3 - Uninstallation

  • Delete EnhCloudsController.lua from "X-Plane 11/Resources/plugins/FlyWithLua/Scripts"
  • Delete "EnhCloudsController" from "X-Plane 11/Resources/plugins/FlyWithLua/Modules"

  Back to table of contents

4 - First start

Enhanced Clouds Controller must be started manually until the "Autosave" option in the "UI Settings" window has been enabled.
After that, the visibility status of the window will be remembered and applied during each script start (or reload).

Start ECC...

  1. ...from X-Plane's "Plugins" menu with "Enhanced Cloudscapes" --> "Open Controller Window" or "FlyWithLua" --> "FlyWithLua Macros" --> "Enchanced Cloudscapes Controller: Toggle Window"
  2. ...by assigning a keyboard shortcut for "Enhanced Cloudscapes Controller/Window/Toggle Window" in X-Plane's keyboard settings window:

  Back to table of contents

5 - User Interface

General hints:
- After having typed a value into any text/number input box, click anywhere in the Controller's window to leave it, otherwise it will keep focus, eating up all keyboard inputs (see "Known Issues" section below).
- Undesired values in text/number input boxes that were just entered can be discarded by pressing the "ESC" key.
- Window size is saved when the "Autosave" option is activated in the "ECC UI Settings" window

###5.1 - Cloud Controller window

5.1.1 - Navigation - The arrow buttons flip from parameter group to parameter group. The group assignment for each parameter chan be changed in its advanced settings

5.1.2 - Value manipulation - Use the slider or float (decimal) number input elements to change a parameter's value. Input value range is limited though. - "Reset" will reset the parameter to the default value, which is obtained from each dataref at script start (also see "Known Issues" section below). - If you need more input options, check the "Advanced Settings" checkbox at the botton of each page

5.1.3 - Advanced settings - Advanced options uniformly apply to all values of a parameter array - The displayed parameter title is stated in a text input box and can therefore be edited - "Switch Display To [Numerical/Percentage]" toggles between a numerical (float) and percentage format for the parameter's value - "Lower/Upper Raw Value Limit" can be used to narrow or broaden the available range for input values. Will also affect values displayed as a percentage. The "Reset" button resets each limiter value to the one defined in the LUA file. Use with caution, may break the plugin. - "Display Precision" accepts integer (i.e. whole number) inputs and controls the decimals displayed in the control elements for the parameter. Will auto-reset to "1" (percentage) and "6" (numerical) when the "Switch Display To [Numerical/Percentage]" button is pressed. - "Display In Group" controls the group assignment for the parameter and accepts integer (whole number) values. Can be used to move the parameter to any present or new group and offers a way to reorder the groups to one's liking. Applying changes requires pressing the "Apply" button.

5.1.4 - Loading/Saving - The "Load/Save Preset" buttons control file input/output and write the current parameter values to disk - If "Autoload" has been enabled in the "ECC UI Settings" menu, values are automatically loaded upon script start.

5.1.5 - Preset file location - The path to the preset file is:
"FlyWithLua/Modules/EnhCloudsController/EC_Preset.cfg" .
Altering this requires editing the script source and is therefore not recommended.

Back to table of contents

5.2 - User Interface Settings

5.2.1 - Navigation - The menu can be accessed with the "ECC UI Settings" button. - The "Back" button leads back to the start screen.

5.2.2 - Notification settings - "Notification display time" accepts integer (i.e. whole number) values and controls the time in seconds, for which notifications in the notification area below the main window content is displayed

5.2.3 - Window hotkey control - "[Enable/Disable] Window Toggling by Hotkey" toggles the hotkey activation mode for the main window, independent of which key was set for this in X-Plane's keyboard settings - The "Keyboard Key Code" field accepts integer (whole number) values and determines the key that will toggle the ECC window's visibility. The default keycode is 85, i.e. "u". - A key (combination) to toggle the Window may always be set in X-Plane's keyboard settings ("Enhanced Cloudscapes Controller" section).

5.2.4 - Autosave/Autoload - "[Enable/Disable] Autosave" saves all Controller window settings immediately to file when activated, including window size and position and will then autosave when another setting has been changed. Does not affect the plugin parameters! - "[Enable/Disable] Autoload" autoloads all Controller window settings and the cloud preset upon script start (when starting an X-Plane session).
This option may also be toggled from the "Plugins" --> "Enhanced Cloudscapes" --> "Autoload Settings" menu item.

5.2.5 - Manual UI settings file management - The "Save UI Settings", "Load UI Settings" and "Delete UI Settings" buttons are self-explanatory and only affect the Controller settings file, not the cloud preset

5.2.6 - UI settings file location - The path to the settings file is:
"FlyWithLua/Modules/EnhCloudsController/UI_Prefs.cfg"
Altering this requires editing the script source and is therefore not recommended.

  Back to table of contents

6 - Known issues

  • Altering a plugin parameter and reloading the Lua script will set that parameter as default.
    Workaround: Restart X-Plane so that the plugin will be reset
  • Input boxes will not let go of focus upon pressing "Enter".
    This is an Imgui limitation.
  • The main "Enhanced Cloudscapes" menu item in the "Plugins" menu will not be removed if you reload all Lua script files in FlyWithLua.

  Back to table of contents

7 - License

Enhanced Cloudscapes Controller is licensed under the European Union Public License v1.2 (see EUPL-1.2-license.txt). Compatible licenses (e.g. GPLv3) are listed in the section "Appendix" in the license file.

About

FlyWithLua-based user interface to control the "Enhanced Cloudscapes" plugin for X-Plane 11

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Lua 100.0%