Difference between revisions of "Widget Configuration"

From Zero-K
Jump to navigation Jump to search
(Created page with "This is a page of some relatively simple modifications that can be made using widgets. = Changing teamcolor = To set custom teamcolors [https://github.com/ZeroK-RTS/Zero-K/fi...")
 
 
(16 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
This is a page of some relatively simple modifications that can be made using widgets.
+
This page is intended to answer frequently asked questions about configuration.
  
−
= Changing teamcolor =
+
==Frequently Asked Questions==
−
To set custom teamcolors [https://github.com/ZeroK-RTS/Zero-K/files/1963835/LocalColors.zip|download and unzip this file] in <code>Zero-K\LuaUI\Configs</code> such that the filepath <code>Zero-K\LuaUI\Configs\LocalColors.lua</code> exists. Edit LocalColors.lua with any text editor to configure your color as well as that of neutral units, allies and enemies.
+
 
 +
===Repositioning the UI Panels===
 +
# Start a battle.
 +
# Open the ingame menu by pressing the Menu button in the top right or pressing Escape or F10.
 +
# Disable 'Simple Settings' by unticking the checkbox in the the bottom right of the ingame menu.
 +
# Navigate to 'Settings/HUD Panels'.
 +
# Untick 'Stay up to date' and 'Reset on screen resolution change'.
 +
# Select the UI Preset 'None'.
 +
# Close the ingame menu.
 +
# Press Ctrl+F11 to enter tweak mode.
 +
# Use the transparent green boxes that appear to drag and resize the interface.
 +
# Press Escape to leave tweak mode.
 +
 
 +
If the UI Preset is not set to 'None' then the main parts of the UI will reset their positions next time the game is launched. Note that by setting 'None' you have become responsible for fixing your own UI if things break it, such as screen resolution changes.
 +
 
 +
=== Adding or removing music ===
 +
Create the folder <code>Zero-K/sounds/music</code> with the five subfolders <code>war</code>, <code>peace</code>, <code>briefing</code>, <code>victory</code> and <code>defeat</code>. Put your music files in the appropriate folders. The only supported format is <code>.ogg</code>.
 +
 
 +
To use your music, untick simple settings through the ingame menu and toggle <code>Settings/Audio/Use Included Tracks</code> then type <code>/luaui reload</code> in the game chat. There is also an option to not play any of the music included with the game.
 +
 
 +
=== Changing team color ===
 +
To set custom team colors [[:File:LocalColors.zip|download and unzip this]] in <code>Zero-K\LuaUI\Configs</code> such that the filepath <code>Zero-K\LuaUI\Configs\LocalColors.lua</code> exists. Edit LocalColors.lua with any text editor to configure your color as well as those of neutral units, allies, and enemies.
  
 
[[File:colorSelection.png]]
 
[[File:colorSelection.png]]
  
 
The 'Custom' option should appear in the color selection menu that can be found in the top left corner of the ingame interface. Select it to use your custom colors. You can make changes to the colors during the game by editing the file and typing <code>/luaui reload</code> to apply the updates.
 
The 'Custom' option should appear in the color selection menu that can be found in the top left corner of the ingame interface. Select it to use your custom colors. You can make changes to the colors during the game by editing the file and typing <code>/luaui reload</code> to apply the updates.
 +
 +
==Using custom widgets==
 +
 +
You can find the Widget List ingame under Settings/Misc 'Widget List' with simple settings disabled. By default it is bound to Alt+F11, you can change the hotkey from here. The widget menu contains many active widgets important to the default UI. Your custom widgets should be at the top, in a group called User local, from which you can activate them.
 +
 +
The widgets in Zero-K can be found here: https://github.com/ZeroK-RTS/Zero-K/tree/master/LuaUI/Widgets
 +
 +
===Activate local widgets===
 +
 +
In the ingame menu untick simple settings, then go to Settings/Misc and tick 'Show Advanced Settings'. Then open 'Local Widget Config' tick the boxes and type '/luaui reload'. Place local widgets in <code>Zero-K\LuaUI\Widgets</code>.
 +
 +
[[File:Local Widget Config SS.JPG]]
 +
 +
{{Navbox manual}}
 +
[[Category:Development]]

Latest revision as of 02:08, 28 May 2022

This page is intended to answer frequently asked questions about configuration.

Frequently Asked Questions

Repositioning the UI Panels

  1. Start a battle.
  2. Open the ingame menu by pressing the Menu button in the top right or pressing Escape or F10.
  3. Disable 'Simple Settings' by unticking the checkbox in the the bottom right of the ingame menu.
  4. Navigate to 'Settings/HUD Panels'.
  5. Untick 'Stay up to date' and 'Reset on screen resolution change'.
  6. Select the UI Preset 'None'.
  7. Close the ingame menu.
  8. Press Ctrl+F11 to enter tweak mode.
  9. Use the transparent green boxes that appear to drag and resize the interface.
  10. Press Escape to leave tweak mode.

If the UI Preset is not set to 'None' then the main parts of the UI will reset their positions next time the game is launched. Note that by setting 'None' you have become responsible for fixing your own UI if things break it, such as screen resolution changes.

Adding or removing music

Create the folder Zero-K/sounds/music with the five subfolders war, peace, briefing, victory and defeat. Put your music files in the appropriate folders. The only supported format is .ogg.

To use your music, untick simple settings through the ingame menu and toggle Settings/Audio/Use Included Tracks then type /luaui reload in the game chat. There is also an option to not play any of the music included with the game.

Changing team color

To set custom team colors download and unzip this in Zero-K\LuaUI\Configs such that the filepath Zero-K\LuaUI\Configs\LocalColors.lua exists. Edit LocalColors.lua with any text editor to configure your color as well as those of neutral units, allies, and enemies.

ColorSelection.png

The 'Custom' option should appear in the color selection menu that can be found in the top left corner of the ingame interface. Select it to use your custom colors. You can make changes to the colors during the game by editing the file and typing /luaui reload to apply the updates.

Using custom widgets

You can find the Widget List ingame under Settings/Misc 'Widget List' with simple settings disabled. By default it is bound to Alt+F11, you can change the hotkey from here. The widget menu contains many active widgets important to the default UI. Your custom widgets should be at the top, in a group called User local, from which you can activate them.

The widgets in Zero-K can be found here: https://github.com/ZeroK-RTS/Zero-K/tree/master/LuaUI/Widgets

Activate local widgets

In the ingame menu untick simple settings, then go to Settings/Misc and tick 'Show Advanced Settings'. Then open 'Local Widget Config' tick the boxes and type '/luaui reload'. Place local widgets in Zero-K\LuaUI\Widgets.

Local Widget Config SS.JPG

Retrieved from "https://zero-k.info/mediawiki/index.php?title=Widget_Configuration&oldid=8437"