Skip to content

Commit ef92e72

Browse files
committed
DOCS(readme): Added new window config
1 parent e350aad commit ef92e72

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,24 +97,51 @@ There are 2 types of quick clip tables:
9797

9898
There are a few configuration options available for this script. All of these must be located in a configuration ini with the same name as the script (HeckR_ClipLog.ini)
9999

100-
As the extension suggests, the configuration file must be in `.ini` format \
101-
Every setting must be placed under the `settings` section
100+
As the extension suggests, the configuration file must be in `.ini` format
102101

103102
The existence of the configuration ini is semi-mandatory \
104103
While it is not necessary to configure anything for the script to be functional, the configuration file will be created on the script's startup if it does not exist
105104

106-
## Keys
105+
## Sections
106+
### `settings`
107107

108-
- **maxNumberOfClipFiles** \
108+
Contains general settings
109+
110+
- `maxNumberOfClipFiles` \
109111
*Description*: The maximum number of clip files to store in the history \
110112
*Format*: `Integer` \
111113
*Default*: `1000`
112114

113-
- **customQuickClipTables** \
115+
- `customQuickClipTables` \
114116
*Description*: A list of custom quick clip table names to be available \
115117
*Format*: A comma separated string \
116118
*Default*: \<empty string\>
117119

120+
### `creator_window`
121+
### `search_window`
122+
123+
Both sections have the same kind of settings
124+
125+
- `initialWidth` \
126+
*Description*: Window width in pixels \
127+
*Format*: `Integer` \
128+
*Default*: `500`
129+
130+
- `initialHeight` \
131+
*Description*: Window height in pixels \
132+
*Format*: `Integer` \
133+
*Default*: `300`
134+
135+
- `initialPositionX` \
136+
*Description*: Window's horizontal position in pixels, or "Center", for aligning it to the middle \
137+
*Format*: `Integer` | "Center" \
138+
*Default*: `Center`
139+
140+
- `initialPositionY` \
141+
*Description*: Window's vertical position in pixels, or "Center", for aligning it to the middle \
142+
*Format*: `Integer` | "Center" \
143+
*Default*: `0`
144+
118145
# Notes
119146

120147
## Previews

0 commit comments

Comments
 (0)