404
Page not found
That’s a Four-Oh-Four.
Config Groups & Config Files
Config Group
Summary
PLS implements various advanced language features based on config groups, which consists of many CWT config files.
Config groups can have different sources. For config groups from the same source, there are config groups for different game types, and the core config group, which is shared by all game types.
Reference Links:
Sources
Built-in Config Groups
- Path:
config/{gameType}[1] (in the plugin jar) - Enabled: Always
- Customizable ：No
These config files are from plugin repository and config repositories of each game. Compare to the config files used by CWTools, there are several modifications and extensions.
Local Config Groups
- Path:
{rootPath}/{gameType}[1:1] (rootPathneed be to be configured in plugin's settings page) - Enabled: Yes if path is existing
- Customizable ：Yes
Containing config files are customized by users themselves. Available for all projects. Changes should be confirmed to import manually.
Project Config Groups
- Path:
.config/{gameType}[1:2] (in the project root directory) - Enabled: Yes if path is existing
- Customizable ：Yes
Containing config files are customized by users themselves. Only available for this project. Changes should be confirmed to import manually.
Overridden Strategy
Configs use the LIOS overridden strategy based on the file path and the config ID.
When reading configs, the plugin will iterate config groups by following order: built-in config groups, local config groups, and project config groups. The core config group is shared by all game types, and will be iterated before the config group for related game type.
For example, if you have written some custom configs in the config file .config/stellaris/modifiers.cwt (which is in the project root directory), it will completely override the built-in modifier configs. Since the built-in modifier configs are located in the config file config/stellaris/modifiers.cwt (which is in the plugin jar), and both of their file path is modifiers.cwt. If these are no content in the custom config file, after applied, the plugin will be unable to resolve any modifier in script files.
CWT Config File
Summary
CWT config file use its own file format, which can be considered as a variant of paradox script language. Its file extension is .cwt.
Syntax
The basic syntax of a CWT config file is as follows:
# both equal sign ('=', '==') and not equal sign ('<>', '!=') can be used as the k-v separator (also available in options)
+# properties (options) and values can be mixed in clauses (also available in options)
+
+### documentation comment
+## option = option_value
+## option_0 = { k = v }
+## option_value
+prop = {
+ # line comment
+ k = v
+ v
+}Writing CWT Config Files
Summary
In progress.
For more detailed specifications, please refer to the reference links below and the built-in config files.
Reference Links:
Specifications
`,34),m={id:"priorities-new-in-1-3-7",tabindex:"-1"},v={class:"header-anchor",href:"#priorities-new-in-1-3-7"},g=e(`Priority configs are used to configure the override order for targets (scripted variables, definitions, localisations and complex enums).
priorities = {
+ # LHS - file path (relative to game or mod root directory)
+ # RHS - priority (available values: "fios", "lios", "ordered", default value: "lios", ignore case)
+
+ # file path - path of specific directory (e.g. ""common/on_actions", "common/scripted_variables", "localisation")
+
+ # fios - use the one that reads first, ignore all remaining items
+ # lios - use the one that reads last (if not specified, use this as default)
+ # ordered - reads by order, no overrides
+
+ "events" = fios
+ # ...
+}System Scopes
TODO
Localisation Locales
TODO
Types and Subtypes
TODO
Declarations
TODO
Enums and Complex Enums
TODO
Dynamic Values
TODO
Aliases and Single Aliases
TODO
Inlines
TODO
Modifiers and Modifier Groups
TODO
Links
TODO
Scopes and Scope Groups
TODO
Localisation Links and Localisation Commands
TODO
Specifications (Extended CWT Configs)
Tips
These configs are mostly provided by users themselves, they can be used to enhance plugin's various language features, such as quick documentation, inlay hints, code highlighting and code completion.
scripted_variables = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+}Definitions
definitions = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## type = civic_or_origin.civic
+ x
+
+ # since 1.3.5, scope context related options are also available here
+ ## type = scripted_trigger
+ ## replace_scopes = { this = country root = country }
+ x
+}Game Rules
game_rules = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to override declaration config
+
+ ### Some documentation
+ ## replace_scopes = { this = country root = country }
+ x
+}On Actions
on_actions = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## replace_scopes = { this = country root = country }
+ ## event_type = country
+ x
+}Inline Scripts
inline_scripts = {
+ # 'x' or 'x = xxx'
+ # 'x' is a inline script expression, e.g., for 'inline_script = jobs/researchers_add', 'x' should be 'jobs/researchers_add'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to declare context config(s) (add '## context_configs_type = multiple' if there are various context configs)
+ # note extended documentation is unavailable for inline scripts
+
+ x
+
+ # more detailed examples for declaring context config(s)
+
+ ## context_configs_type = multiple
+ x = {
+ ## cardinality = 0..1
+ potential = single_alias_right[trigger_clause]
+ ## cardinality = 0..1
+ possible = single_alias_right[trigger_clause]
+ }
+
+ # since 1.3.5, scope context related options are also available here
+
+ ## replace_scopes = { this = country root = country }
+ x
+
+ # since 1.3.6, using single alias at root level is also available here
+
+ ## context_configs_type = multiple
+ x = single_alias_right[trigger_clause]
+}Example:
Parameters
parameters = {
+ # 'x' or 'x = xxx'
+ # 'x' is a parameter name, e.g., for '$JOB$', 'x' should be 'JOB'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to declare context config(s) (add '## context_configs_type = multiple' if there are various context configs)
+
+ # since 1.3.6, value of option 'context_key' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## context_key = scripted_trigger@some_trigger
+ x
+
+ # more detailed examples for declaring context config(s)
+
+ ## context_key = scripted_trigger@some_trigger
+ x = localistion
+
+ ## context_key = scripted_trigger@some_trigger
+ ## context_configs_type = multiple
+ x = {
+ localisation
+ scalar
+ }
+
+ # since 1.3.5, scope context related options are also available here
+
+ ## context_key = scripted_trigger@some_trigger
+ ## replace_scopes = { this = country root = country }
+ x
+
+ # since 1.3.6, using single alias at root level is also available here
+
+ ## context_key = scripted_trigger@some_trigger
+ ## context_configs_type = multiple
+ x = single_alias_right[trigger_clause]
+
+ # since 1.3.12, a parameter's config context and scope context can be specified to inherit from its context
+ # e.g. for parameter 'x' with context key 'scripted_trigger@some_trigger', its context is scripted trigger 'some_trigger'
+
+ ## context_key = scripted_trigger@some_trigger
+ ## inherit
+ x
+}Example:
Complex Enum Values
complex_enum_values = {
+ component_tag = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+ }
+}Dynamic Values
dynamic_values = {
+ event_target = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+
+ # since 1.3.9, scope context related options are also available here
+ # only receive push scope (this scope), ignore others (like root scope, etc.)
+
+ ## push_scope = country
+ x
+ }
+}FAQ
About the Template Expression
Template expressions are composed of string literals and expressions of limited types (definitions, enums and dynamic values), and can be used for more flexible matching.
# a string literal, exactly matches 'x'
+x
+# a template expression which contains a reference to jobs, matches 'a_researcher_b', 'a_farmer_b', etc.
+a_<job>_b
+# a template expression which contains a references to enum of weight_or_base, matches 'a_weight_b' and 'a_base_b'
+a_enum[weight_or_base]_b
+# a template expression which contains a references to dynamic value type of anything
+# generally, there is no limit for 'value[anything]', so this expression is equivalent to regex 'a_.*_b'
+a_value[anything]_bSince 1.3.6, the ANT expression can be used for more flexible matching.
# a ant expression use prefix 'ant:'
+ant:/foo/bar?/*
+# a ant expression use prefix 'ant.i:' (ignore case)
+ant.i:/foo/bar?/*
+
+# wildcards in ant expression:
+# '?' - used to match any single character
+# '*' - used to match any characters (exclude '/')
+# '**' - used to match any charactersSince 1.3.6, Regex can be used for more flexible matching.
# a regex use prefix 're:'
+re:foo.*
+# a regex use prefix 're.i:' (ignore case)
+re.i:foo.*How to Specify the Scope Context in Config Files
In config files, the scope context is specified by option push_scope and replace_scope.
# push 'country' scope to scope stack
+# for this example, the next this scope will be 'country'
+## push_scope = country
+some_config
+
+# replace scopes of specific system scopes into scope context
+# not supported for 'prev' system scope (and 'prevprev', etc.)
+# for this example, the next this scope will be 'country', so do the next root scope and the next from scope
+## replace_scopes = { this = country root = country from = country }
+some_configImporting CWT Config Files
Summary
You can write customized config files in directories of local config groups or project config groups. They are helpful for optimizing plugin's built-in configs, or enhancing plugin's features.
If some changes are happened, the refresh button will be appeared in the context float toolbar in the upper right corner of the editor. Click it to confirm to import, so changes of these custom config files will be applied.
IDE will take some time to reparse opened files in background, And please note that if the changes in the config files will result in the change of the indexing logic (for example, a new definition type is added, or a match condition for some definition type is changed), you may need to reindex the whole project (this may take several minutes), to make sure the plugin works properly, if in the situation that involves these changes.
规则分组与规则文件
规则分组
概述
PLS基于由CWT规则文件组成的规则分组，实现了诸多语言功能。
规则分组可以有不同的来源，而对于同一来源的规则分组，又区分为各自游戏类型的规则分组，以及所有游戏类型共享的核心规则分组。
参考链接：
来源
内置的规则分组
- 路径：
config/{gameType}[1]（位于插件jar包中） - 是否启用：始终启用
- 是否可自定义：否
其中的规则文件来自插件仓库以及各自游戏的规则仓库，相较于CWTools所使用的规则文件，它们经过一定的修改和扩展。
本地的规则分组
- 路径：
{rootPath}/{gameType}[1:1]（可在插件的配置页面中配置rootPath对应的文件路径） - 是否启用：如果路径存在
- 是否可自定义：是
其中的规则文件由用户自定义，适用于所有项目。对它们的更改需要手动确认导入。
项目的规则分组
- 路径：
.config/{gameType}[1:2]（位于项目根目录中） - 是否启用：如果路径存在
- 是否可自定义：是
其中的规则文件由用户自定义，仅适用于当前项目。对它们的更改需要手动确认导入。
覆盖策略
规则会按照文件路径和规则ID进行后序覆盖。
读取规则时，插件会依次遍历内置的规则分组、本地的规则分组以及项目的规则分组。 核心规则分组由所有游戏类型共享，会在对应游戏类型的规则分组之前被遍历。
例如，如果你在项目根目录下的规则文件.config/stellaris/modifiers.cwt中编写了自定义的规则，它将完全覆盖插件内置的修正规则。 因为插件内置的修正规则位于插件jar包中的规则文件config/stellaris/modifiers.cwt中，它们的文件路径都是modifiers.cwt。 如果此自定义的规则文件中没有任何内容，应用后插件将无法解析脚本文件中的任何修正。
CWT规则文件
概述
CWT规则文件使用一种特别的文件格式，可以视为Paradox脚本语言的变种。它的文件扩展名为.cwt。
语法
CWT规则文件的基本语法如下所示：
# both equal sign ('=', '==') and not equal sign ('<>', '!=') can be used as the k-v separator (also available in options)
+# properties (options) and values can be mixed in clauses (also available in options)
+
+### documentation comment
+## option = option_value
+## option_0 = { k = v }
+## option_value
+prop = {
+ # line comment
+ k = v
+ v
+}编写CWT规则文件
概述
正在更新中。
关于更详细的编写规范，请参考下方的参考链接以及插件内置的那些规则文件。
参考链接：
编写规范
`,34),u={id:"priorities-new-in-1-3-7",tabindex:"-1"},m={class:"header-anchor",href:"#priorities-new-in-1-3-7"},b=a(`优先级规则可以用来配置目标（封装变量，定义、本地化与复杂枚举）的覆盖顺序。
priorities = {
+ # LHS - file path (relative to game or mod root directory)
+ # RHS - priority (available values: "fios", "lios", "ordered", default value: "lios", ignore case)
+
+ # file path - path of specific directory (e.g. ""common/on_actions", "common/scripted_variables", "localisation")
+
+ # fios - use the one that reads first, ignore all remaining items
+ # lios - use the one that reads last (if not specified, use this as default)
+ # ordered - reads by order, no overrides
+
+ "events" = fios
+ # ...
+}System Scopes
TODO
Localisation Locales
TODO
Types and Subtypes
TODO
Declarations
TODO
Enums and Complex Enums
TODO
Dynamic Values
TODO
Aliases and Single Aliases
TODO
Inlines
TODO
Modifiers and Modifier Groups
TODO
Links
TODO
Scopes and Scope Groups
TODO
Localisation Links and Localisation Commands
TODO
编写规范（扩展的CWT规则）
提示
这些规则基本上由用户自行编写，用于强化插件的各项语言功能，例如快速文档、内嵌提示、代码高亮与代码补全。
scripted_variables = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+}Definitions
definitions = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## type = civic_or_origin.civic
+ x
+
+ # since 1.3.5, scope context related options are also available here
+ ## type = scripted_trigger
+ ## replace_scopes = { this = country root = country }
+ x
+}Game Rules
game_rules = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to override declaration config
+
+ ### Some documentation
+ ## replace_scopes = { this = country root = country }
+ x
+}On Actions
on_actions = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## replace_scopes = { this = country root = country }
+ ## event_type = country
+ x
+}Inline Scripts
inline_scripts = {
+ # 'x' or 'x = xxx'
+ # 'x' is a inline script expression, e.g., for 'inline_script = jobs/researchers_add', 'x' should be 'jobs/researchers_add'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to declare context config(s) (add '## context_configs_type = multiple' if there are various context configs)
+ # note extended documentation is unavailable for inline scripts
+
+ x
+
+ # more detailed examples for declaring context config(s)
+
+ ## context_configs_type = multiple
+ x = {
+ ## cardinality = 0..1
+ potential = single_alias_right[trigger_clause]
+ ## cardinality = 0..1
+ possible = single_alias_right[trigger_clause]
+ }
+
+ # since 1.3.5, scope context related options are also available here
+
+ ## replace_scopes = { this = country root = country }
+ x
+
+ # since 1.3.6, using single alias at root level is also available here
+
+ ## context_configs_type = multiple
+ x = single_alias_right[trigger_clause]
+}示例：
Parameters
parameters = {
+ # 'x' or 'x = xxx'
+ # 'x' is a parameter name, e.g., for '$JOB$', 'x' should be 'JOB'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to declare context config(s) (add '## context_configs_type = multiple' if there are various context configs)
+
+ # since 1.3.6, value of option 'context_key' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## context_key = scripted_trigger@some_trigger
+ x
+
+ # more detailed examples for declaring context config(s)
+
+ ## context_key = scripted_trigger@some_trigger
+ x = localistion
+
+ ## context_key = scripted_trigger@some_trigger
+ ## context_configs_type = multiple
+ x = {
+ localisation
+ scalar
+ }
+
+ # since 1.3.5, scope context related options are also available here
+
+ ## context_key = scripted_trigger@some_trigger
+ ## replace_scopes = { this = country root = country }
+ x
+
+ # since 1.3.6, using single alias at root level is also available here
+
+ ## context_key = scripted_trigger@some_trigger
+ ## context_configs_type = multiple
+ x = single_alias_right[trigger_clause]
+
+ # since 1.3.12, a parameter's config context and scope context can be specified to inherit from its context
+ # e.g. for parameter 'x' with context key 'scripted_trigger@some_trigger', its context is scripted trigger 'some_trigger'
+
+ ## context_key = scripted_trigger@some_trigger
+ ## inherit
+ x
+}示例：
Complex Enum Values
complex_enum_values = {
+ component_tag = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+ }
+}Dynamic Values
dynamic_values = {
+ event_target = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+
+ # since 1.3.9, scope context related options are also available here
+ # only receive push scope (this scope), ignore others (like root scope, etc.)
+
+ ## push_scope = country
+ x
+ }
+}FAQ
关于模版表达式
模版表达式由字符串字面量以及限定类型的表达式（定义，枚举，动态值）组合而成，用来进行更加灵活的匹配。
# a string literal, exactly matches 'x'
+x
+# a template expression which contains a reference to jobs, matches 'a_researcher_b', 'a_farmer_b', etc.
+a_<job>_b
+# a template expression which contains a references to enum of weight_or_base, matches 'a_weight_b' and 'a_base_b'
+a_enum[weight_or_base]_b
+# a template expression which contains a references to dynamic value type of anything
+# generally, there is no limit for 'value[anything]', so this expression is equivalent to regex 'a_.*_b'
+a_value[anything]_b从1.3.6开始，可以通过ANT表达式进行更加灵活的匹配。
# a ant expression use prefix 'ant:'
+ant:/foo/bar?/*
+# a ant expression use prefix 'ant.i:' (ignore case)
+ant.i:/foo/bar?/*
+
+# wildcards in ant expression:
+# '?' - used to match any single character
+# '*' - used to match any characters (exclude '/')
+# '**' - used to match any characters从1.3.6开始，可以通过正则表达式进行更加灵活的匹配。
# a regex use prefix 're:'
+re:foo.*
+# a regex use prefix 're.i:' (ignore case)
+re.i:foo.*如何在规则文件中指定作用域上下文
在规则文件中，作用域上下文是通过选项push_scope与replace_scope来指定的。
# push 'country' scope to scope stack
+# for this example, the next this scope will be 'country'
+## push_scope = country
+some_config
+
+# replace scopes of specific system scopes into scope context
+# not supported for 'prev' system scope (and 'prevprev', etc.)
+# for this example, the next this scope will be 'country', so do the next root scope and the next from scope
+## replace_scopes = { this = country root = country from = country }
+some_config导入CWT规则文件
概述
你可以在本地的规则分组或者项目的规则分组对应的目录下编写自定义的规则文件。 它们可以用来完善插件内置的规则，或是增强插件的功能。
如果发生更改，编辑器右上角的上下文悬浮工具栏中会出现刷新按钮。 点击确认导入后，即可应用这些自定义的规则文件的更改。
IDE将会在后台花费一些时间重新解析已打开的文件， 并且请注意，如果规则文件的更改会引发索引逻辑的更改 （例如，新增了一种定义类型，或是更改了某种定义类型的匹配条件）， 你可能需要重新索引整个项目（这可能需要花费数分钟），以使在涉及到这些更改的场合，插件能够正常工作。
Introduce
Summary
GitHub | Plugin Marketplace Page | Discord
IDEA plugin: Support for Paradox language.
Features:
- Supports script & localisation languages and CWT language (used by config files).
- Provides various almost excellent language features for script & localisation languages, including code highlight, code navigation, code completion, code inspection, code refactoring, quick documentation, inlay hints, live templates, code hierarchy, diagram, diff and more.
- Provides basic language features for CWT language, including code highlight, code navigation, quick documentation and more.
- Supports rendering scope context, localisation text, DDS images and other useful information via quick documentation and inlay hints.
- Supports most advanced features of script & localisation languages (such as parameters, scopes, inline scripts and various complex expressions).
- Supports customizing extended config files, allowing plugin to provide more perfect language features (such as code navigation, code completion, quick documentation and inlay hints).
- Automatically recognizes the game directory (containing the launcher settings file
launcher-settings.json) and mod directory (containing the mod descriptor filedescriptor.mod).
References
Reference manual:
Tools and plugins:
- cwtools/cwtools
- cwtools/cwtools-vscode
- bcssov/IronyModManager
- OldEnt/stellaris-triggers-modifiers-effects-list
- YiiGuxing/TranslationPlugin
Wiki:
',8);function h(f,_){const t=s("RouteLink");return c(),l("div",null,[u,n("p",null,[e("This plugin has implemented various advanced language features based on "),a(t,{to:"/en/config.html#config-group"},{default:r(()=>[e("config groups")]),_:1}),e(", which consists of CWT config files. The latest-version config files are already built into this plugin, make it works right out of the box. Besides, "),a(t,{to:"/en/config.html#writing-cwt-config-files"},{default:r(()=>[e("customizing")]),_:1}),e(" and "),a(t,{to:"/en/config.html#importing-cwt-config-files"},{default:r(()=>[e("importing")]),_:1}),e(" local config files are also supported.")]),n("p",null,[e("If "),d,e(" is also installed, this plugin can provide some "),a(t,{to:"/en/plugin-integration.html"},{default:r(()=>[e("additional features")]),_:1}),e(".")]),m])}const x=i(g,[["render",h],["__file","index.html.vue"]]),y=JSON.parse('{"path":"/en/","title":"Introduce","lang":"en-US","frontmatter":{"description":"Introduce Summary GitHub | Plugin Marketplace Page | Discord IDEA plugin: Support for Paradox language. Features: Supports script & localisation languages and CWT language (used...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://windea.icu/Paradox-Language-Support/zh/"}],["meta",{"property":"og:url","content":"https://windea.icu/Paradox-Language-Support/en/"}],["meta",{"property":"og:site_name","content":"Paradox Language Support"}],["meta",{"property":"og:title","content":"Introduce"}],["meta",{"property":"og:description","content":"Introduce Summary GitHub | Plugin Marketplace Page | Discord IDEA plugin: Support for Paradox language. Features: Supports script & localisation languages and CWT language (used..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2024-09-24T04:21:24.000Z"}],["meta",{"property":"article:author","content":"DragonKnightOfBreeze"}],["meta",{"property":"article:modified_time","content":"2024-09-24T04:21:24.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Introduce\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2024-09-24T04:21:24.000Z\\",\\"author\\":[{\\"@type\\":\\"Person\\",\\"name\\":\\"DragonKnightOfBreeze\\",\\"url\\":\\"https://github.com/DragonKnightOfBreeze\\",\\"email\\":\\"dk_breeze@qq.com\\"}]}"]]},"headers":[{"level":2,"title":"Summary","slug":"summary","link":"#summary","children":[]},{"level":2,"title":"References","slug":"references","link":"#references","children":[]}],"git":{"createdTime":1727151684000,"updatedTime":1727151684000,"contributors":[{"name":"DragonKnightOfBreeze","email":"dk_breeze@qq.com","commits":1}]},"readingTime":{"minutes":1.07,"words":321},"filePathRelative":"en/README.md","localizedDate":"September 24, 2024","autoDesc":true}');export{x as comp,y as data}; diff --git a/assets/index.html-D2IGkW7s.js b/assets/index.html-D2IGkW7s.js new file mode 100644 index 000000000..8ea293f03 --- /dev/null +++ b/assets/index.html-D2IGkW7s.js @@ -0,0 +1 @@ +import{_ as i}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as l,a as o,b as e,d as r,w as a,e as n,r as s,o as p}from"./app-CEUNVpLB.js";const c="/Paradox-Language-Support/assets/preview_1_zh-Cb81Ertl.png",g={},h=n('介绍
概述
GitHub | Plugin Marketplace Page | Discord | QQ群：653824651
IDEA插件：Paradox语言支持。
特性：
- 支持脚本语言与本地化语言，以及规则文件所使用的CWT语言。
- 为脚本语言与本地化语言提供诸多较为完备的语言功能，包括代码高亮、代码导航、代码补全、代码检查、代码重构、快速文档、内嵌提示、动态模版、代码层级、图表、差异比较等。
- 为CWT语言提供基础的语言功能，包括代码高亮、代码导航、快速文档等。
- 支持通过快速文档与内嵌提示等方式，渲染作用域上下文、本地化文本、DDS图片以及其他有用的信息。
- 支持脚本语言与本地化语言的多数高级特性（例如参数、作用域、内联脚本和各种复杂表达式）。
- 支持自定义扩展的规则文件，从而允许插件提供更加完善的语言功能（例如代码导航、代码补全、快速文档和内嵌提示）。
- 自动识别游戏目录（包含启动器配置文件
launcher-settings.json）和模组目录（包含模组描述符文件descriptor.mod）。
参考
参考手册：
工具和插件：
- cwtools/cwtools
- cwtools/cwtools-vscode
- bcssov/IronyModManager
- OldEnt/stellaris-triggers-modifiers-effects-list
- YiiGuxing/TranslationPlugin
Wiki：
',8);function m(f,_){const t=s("RouteLink");return p(),l("div",null,[h,o("p",null,[e("此插件基于由CWT规则文件组成的"),r(t,{to:"/zh/config.html#config-group"},{default:a(()=>[e("规则分组")]),_:1}),e("，实现了诸多语言功能。 插件已经内置了最新版本的规则文件，以便开箱即用。 除此之外，插件也支持"),r(t,{to:"/zh/config.html#writing-cwt-config-files"},{default:a(()=>[e("自定义")]),_:1}),e("与"),r(t,{to:"/zh/config.html#importing-cwt-config-files"},{default:a(()=>[e("导入")]),_:1}),e("本地的规则文件。")]),o("p",null,[e("如果同时安装了 "),d,e(" ，此插件可以提供一些"),r(t,{to:"/zh/plugin-integration.html"},{default:a(()=>[e("额外的功能")]),_:1}),e("。")]),u])}const x=i(g,[["render",m],["__file","index.html.vue"]]),w=JSON.parse('{"path":"/zh/","title":"介绍","lang":"zh-CN","frontmatter":{"description":"介绍 概述 GitHub | Plugin Marketplace Page | Discord | QQ群：653824651 IDEA插件：Paradox语言支持。 特性： 支持脚本语言与本地化语言，以及规则文件所使用的CWT语言。 为脚本语言与本地化语言提供诸多较为完备的语言功能，包括代码高亮、代码导航、代码补全、代码检查、代码重构、快速文档、内...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://windea.icu/Paradox-Language-Support/en/"}],["meta",{"property":"og:url","content":"https://windea.icu/Paradox-Language-Support/zh/"}],["meta",{"property":"og:site_name","content":"Paradox Language Support"}],["meta",{"property":"og:title","content":"介绍"}],["meta",{"property":"og:description","content":"介绍 概述 GitHub | Plugin Marketplace Page | Discord | QQ群：653824651 IDEA插件：Paradox语言支持。 特性： 支持脚本语言与本地化语言，以及规则文件所使用的CWT语言。 为脚本语言与本地化语言提供诸多较为完备的语言功能，包括代码高亮、代码导航、代码补全、代码检查、代码重构、快速文档、内..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2024-09-24T04:21:24.000Z"}],["meta",{"property":"article:author","content":"DragonKnightOfBreeze"}],["meta",{"property":"article:modified_time","content":"2024-09-24T04:21:24.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"介绍\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2024-09-24T04:21:24.000Z\\",\\"author\\":[{\\"@type\\":\\"Person\\",\\"name\\":\\"DragonKnightOfBreeze\\",\\"url\\":\\"https://github.com/DragonKnightOfBreeze\\",\\"email\\":\\"dk_breeze@qq.com\\"}]}"]]},"headers":[{"level":2,"title":"概述","slug":"概述","link":"#概述","children":[]},{"level":2,"title":"参考","slug":"参考","link":"#参考","children":[]}],"git":{"createdTime":1727151684000,"updatedTime":1727151684000,"contributors":[{"name":"DragonKnightOfBreeze","email":"dk_breeze@qq.com","commits":1}]},"readingTime":{"minutes":1.68,"words":505},"filePathRelative":"zh/README.md","localizedDate":"2024年9月24日","autoDesc":true}');export{x as comp,w as data}; diff --git a/assets/inline_scripts_1-yKrsHaqt.png b/assets/inline_scripts_1-yKrsHaqt.png new file mode 100644 index 000000000..56f7236d0 Binary files /dev/null and b/assets/inline_scripts_1-yKrsHaqt.png differ diff --git a/assets/intention_copy_loc_for_locale-C4QIHec9.gif b/assets/intention_copy_loc_for_locale-C4QIHec9.gif new file mode 100644 index 000000000..10abb5aa7 Binary files /dev/null and b/assets/intention_copy_loc_for_locale-C4QIHec9.gif differ diff --git a/assets/intention_copy_loc_for_locale-HyhT4N-Y.js b/assets/intention_copy_loc_for_locale-HyhT4N-Y.js new file mode 100644 index 000000000..7875741de --- /dev/null +++ b/assets/intention_copy_loc_for_locale-HyhT4N-Y.js @@ -0,0 +1 @@ +const a="/Paradox-Language-Support/assets/translate_documentation-B2ai8mXP.gif",o="/Paradox-Language-Support/assets/intention_copy_loc_for_locale-C4QIHec9.gif";export{a as _,o as a}; diff --git a/assets/parameters_1-CIbMC7kI.png b/assets/parameters_1-CIbMC7kI.png new file mode 100644 index 000000000..189a82d4c Binary files /dev/null and b/assets/parameters_1-CIbMC7kI.png differ diff --git a/assets/parameters_1-E5MDCLKe.js b/assets/parameters_1-E5MDCLKe.js new file mode 100644 index 000000000..188fc126d --- /dev/null +++ b/assets/parameters_1-E5MDCLKe.js @@ -0,0 +1 @@ +const a="/Paradox-Language-Support/assets/inline_scripts_1-yKrsHaqt.png",s="/Paradox-Language-Support/assets/parameters_1-CIbMC7kI.png";export{a as _,s as a}; diff --git a/assets/photoswipe.esm-GXRgw7eJ.js b/assets/photoswipe.esm-GXRgw7eJ.js new file mode 100644 index 000000000..2fd7cfd3f --- /dev/null +++ b/assets/photoswipe.esm-GXRgw7eJ.js @@ -0,0 +1,4 @@ +/*! + * PhotoSwipe 5.4.4 - https://photoswipe.com + * (c) 2024 Dmytro Semenov + */function f(r,t,i){const e=document.createElement(t);return r&&(e.className=r),i&&i.appendChild(e),e}function p(r,t){return r.x=t.x,r.y=t.y,t.id!==void 0&&(r.id=t.id),r}function M(r){r.x=Math.round(r.x),r.y=Math.round(r.y)}function A(r,t){const i=Math.abs(r.x-t.x),e=Math.abs(r.y-t.y);return Math.sqrt(i*i+e*e)}function x(r,t){return r.x===t.x&&r.y===t.y}function I(r,t,i){return Math.min(Math.max(r,t),i)}function b(r,t,i){let e=`translate3d(${r}px,${t||0}px,0)`;return i!==void 0&&(e+=` scale3d(${i},${i},1)`),e}function y(r,t,i,e){r.style.transform=b(t,i,e)}const $="cubic-bezier(.4,0,.22,1)";function R(r,t,i,e){r.style.transition=t?`${t} ${i}ms ${e||$}`:"none"}function L(r,t,i){r.style.width=typeof t=="number"?`${t}px`:t,r.style.height=typeof i=="number"?`${i}px`:i}function U(r){R(r)}function q(r){return"decode"in r?r.decode().catch(()=>{}):r.complete?Promise.resolve(r):new Promise((t,i)=>{r.onload=()=>t(r),r.onerror=i})}const _={IDLE:"idle",LOADING:"loading",LOADED:"loaded",ERROR:"error"};function G(r){return"button"in r&&r.button===1||r.ctrlKey||r.metaKey||r.altKey||r.shiftKey}function K(r,t,i=document){let e=[];if(r instanceof Element)e=[r];else if(r instanceof NodeList||Array.isArray(r))e=Array.from(r);else{const s=typeof r=="string"?r:t;s&&(e=Array.from(i.querySelectorAll(s)))}return e}function C(){return!!(navigator.vendor&&navigator.vendor.match(/apple/i))}let F=!1;try{window.addEventListener("test",null,Object.defineProperty({},"passive",{get:()=>{F=!0}}))}catch{}class X{constructor(){this._pool=[]}add(t,i,e,s){this._toggleListener(t,i,e,s)}remove(t,i,e,s){this._toggleListener(t,i,e,s,!0)}removeAll(){this._pool.forEach(t=>{this._toggleListener(t.target,t.type,t.listener,t.passive,!0,!0)}),this._pool=[]}_toggleListener(t,i,e,s,n,o){if(!t)return;const a=n?"removeEventListener":"addEventListener";i.split(" ").forEach(l=>{if(l){o||(n?this._pool=this._pool.filter(d=>d.type!==l||d.listener!==e||d.target!==t):this._pool.push({target:t,type:l,listener:e,passive:s}));const c=F?{passive:s||!1}:!1;t[a](l,e,c)}})}}function B(r,t){if(r.getViewportSizeFn){const i=r.getViewportSizeFn(r,t);if(i)return i}return{x:document.documentElement.clientWidth,y:window.innerHeight}}function S(r,t,i,e,s){let n=0;if(t.paddingFn)n=t.paddingFn(i,e,s)[r];else if(t.padding)n=t.padding[r];else{const o="padding"+r[0].toUpperCase()+r.slice(1);t[o]&&(n=t[o])}return Number(n)||0}function N(r,t,i,e){return{x:t.x-S("left",r,t,i,e)-S("right",r,t,i,e),y:t.y-S("top",r,t,i,e)-S("bottom",r,t,i,e)}}class Y{constructor(t){this.slide=t,this.currZoomLevel=1,this.center={x:0,y:0},this.max={x:0,y:0},this.min={x:0,y:0}}update(t){this.currZoomLevel=t,this.slide.width?(this._updateAxis("x"),this._updateAxis("y"),this.slide.pswp.dispatch("calcBounds",{slide:this.slide})):this.reset()}_updateAxis(t){const{pswp:i}=this.slide,e=this.slide[t==="x"?"width":"height"]*this.currZoomLevel,n=S(t==="x"?"left":"top",i.options,i.viewportSize,this.slide.data,this.slide.index),o=this.slide.panAreaSize[t];this.center[t]=Math.round((o-e)/2)+n,this.max[t]=e>o?Math.round(o-e)+n:this.center[t],this.min[t]=e>o?n:this.center[t]}reset(){this.center.x=0,this.center.y=0,this.max.x=0,this.max.y=0,this.min.x=0,this.min.y=0}correctPan(t,i){return I(i,this.max[t],this.min[t])}}const T=4e3;class H{constructor(t,i,e,s){this.pswp=s,this.options=t,this.itemData=i,this.index=e,this.panAreaSize=null,this.elementSize=null,this.fit=1,this.fill=1,this.vFill=1,this.initial=1,this.secondary=1,this.max=1,this.min=1}update(t,i,e){const s={x:t,y:i};this.elementSize=s,this.panAreaSize=e;const n=e.x/s.x,o=e.y/s.y;this.fit=Math.min(1,nPlugin Integration
Integrate Translation Plugin
When Translation plugin is also installed and enabled, PLS will provide bellow additional features:
Translate documentation
When the cursor is over a definition name, a localisation name or some other positions, can translate documentation content by click and select Translate Documentation icon button in quick documentation popup window, or click Translate Documentation item in right-click menu.
Warning
There is no guarantee that special markers will be preserved correctly after translation yet.
Intention: Copy localisation(s) to the clipboard for locale...
When the cursor selection scope involves localisation(s), this intention can copy all involved localisation(s) to the clipboard, and try to translate the localisation text into the specified locale before doing so.
Warning
There is no guarantee that special markers will be preserved correctly after translation yet.
插件集成
集成Translation插件
当同时安装且启用了Translation插件时，PLS将会额外提供以下功能：
翻译文档内容
当光标位于定义的名字、本地化的名字等位置时，可以通过点击并选择快速文档弹出窗口中的Translate Documentation图标按钮，或者点击右键菜单中的Translate Documentation选项翻译文档内容。
注意
暂不保证翻译后能够正确地识别并保留各种特殊标记。
意向：复制本地化到剪贴板并将本地化文本翻译为指定的语言区域
当光标选取范围涉及到本地化时，此意向可以将所有涉及到的本地化复制到剪切板，并且在这之前尝试将本地化文本翻译为指定的语言区域。
注意
暂不保证翻译后能够正确地识别并保留各种特殊标记。
快速开始
使用
- 通过IDE打开你的模组根目录。（需要直接包含模组描述符文件
descriptor.mod） - 打开模组描述符文件，点击位于编辑器右上角的悬浮工具栏中的模组配置按钮。
- 配置模组的游戏类型、游戏目录以及额外的模组依赖。
- 点击确定按钮完成配置，然后等待IDE索引完成。
- 开始你的模组编程之旅吧！
提示
',4),u=o("- 点击
Ctrl Shift R或者Ctrl Shift F在当前项目、目录或者指定作用域中搜索。 - 点击
Shift Shift查找文件、定义、封装变量（scripted_variable）以及其他各种符号。
- 按住
Ctrl并点击目标位置，从而导航到目标的声明或使用处。 - 按住
Ctrl Shift并点击目标位置，从而导航到目标的类型声明处。 - 按住
Alt并点击目标位置，从而导航到目标对应的CWT规则的声明处。 - 按住
Shift Alt并点击目标位置，从而导航到目标定义的相关本地化的声明处。 - 按住
Ctrl Shift Alt并点击目标位置，从而导航到目标定义的相关图片的声明处。 - 点击
Navigate或者编辑器右键菜单中的Go To，选择要导航到的目标。 - 点击
Navigate > Definition Hierarchy，打开定义层级窗口，从而查看某一类型的定义的实现关系。 - 点击
Navigate > Call Hierarchy，打开调用层级窗口，从而查看定义、本地化、封装变量（scripted_variable）等的调用关系。 - 点击
Alt 1或者Project工具窗口，打开项目视图面板，然后点击左上角的Project > Paradox Files，从而查看汇总后的游戏与模组文件。 - 点击
Alt 1或者Project工具窗口，打开项目视图面板，然后点击左上角的Project > CWT Config Files，从而查看汇总后的CWT规则文件。
- 点击
Alt 6或者Problems工具窗口，打开问题面板，然后查看当前文件存在的问题，或者进行整个项目的全局代码检查。 - 点击
Code > Inspect Code...，进行整个项目的全局代码检查。 - 完成代码检查后，IDE将会在问题面板中显示详细的检查结果。
- 点击
Settings > Languages & Frameworks > Paradox Language Support，打开插件的配置页面。
- 点击
Settings > Languages & Frameworks > Paradox Language Support，可配置默认的游戏目录。 - 点击位于页面右上方的编辑器悬浮工具栏中的蓝色齿轮图标。
- 在编辑器中打开右键菜单，点击
Paradox Language Support > Open Mod Settings...。 - 点击
Tools > Paradox Language Support > Open Mod Settings...。
Quick Start
Usages
- Open your mod root directory through the IDE. (It needs to directly contain the mod descriptor file
descriptor.mod) - Open the mod descriptor file, click the mod settings button in the floating toolbar at the top right of the editor.
- Configure the game type, game directory, and additional mod dependencies of the mod.
- Click the OK button to complete the configuration, and then wait for the IDE to complete indexing.
- Start your mod programming journey.
Tips
',4),p=o("- Click
Ctrl Shift RorCtrl Shift Fto search within the current project, directory, or specified scope. - Click
Shift Shiftto find files, definitions, scripted variables, and other symbols.
- Hold down
Ctrland click on the target location, to navigate to the declarations or usages of the target. - Hold down
Ctrl Shiftand click on the target location, to navigate to the type declarations of the target. - Hold down
Altand click on the target location, to navigate to the related CWT config declarations of the target. - Hold down
Shift Altand click on the target location, to navigate to the related localisation declarations of the target definition. - Hold down
Ctrl Shift Altand click on the target location to navigate to the related image declarations of the target definition. - Click
NavigateorGo Toin the editor's right-click menu, and choose the target to navigate to. - Click
Navigate > Definition Hierarchyto open the definition hierarchy window, to view the definition implementation relationship of a specific definition type. - Click
Navigate > Call Hierarchyto open the call hierarchy window, to view the call relationship of definitions, localisations, scripted variables, etc. - Click
Alt 1orProjectTool window, open the Project View panel, then clickProject > Paradox Filesin the upper left corner, to view the summarized game and mod files. - Click
Alt 1orProjectTool window, open the Project View panel, then clickProject > CWT Config Filesin the upper left corner, to view the summarized CWT config files.
- Click
Alt 6orProblemsTool window, open the Problems panel ,then view problems of current file, or run a global code inspection for whole project. - Click
Code > Inspect Code..., run a global code inspection for whole project. - When code inspection is finished ,IDE will show detail inspection result in Problems panel.
- Click
Settings > Languages & Frameworks > Paradox Language Supportto open the settings page for the plugin.
- Click
Settings > Languages & Frameworks > Paradox Language Supportto configure default game directories. - Click the blue gear icon in the editor floating toolbar located in the upper right corner of the page.
- In the editor, open the context menu and click
Paradox Language Support > Open Mod Settings.... - Click
Tools > Paradox Language Support > Open Mod Settings....
Redirecting...
+ + diff --git a/core-features.html b/core-features.html new file mode 100644 index 000000000..8a3c8b8c2 --- /dev/null +++ b/core-features.html @@ -0,0 +1,69 @@ + + + + + +Redirecting...
+ + diff --git a/en/advance-features.html b/en/advance-features.html new file mode 100644 index 000000000..8062e3b66 --- /dev/null +++ b/en/advance-features.html @@ -0,0 +1,40 @@ + + + + + + + + + +Skip to main content
+
+
+
diff --git a/en/core-features.html b/en/core-features.html
new file mode 100644
index 000000000..e87ffe9a1
--- /dev/null
+++ b/en/core-features.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+
+
+ Config Groups & Config Files
About 1640 wordsAbout 5 min
Config Groups & Config Files
Config Group
Summary
PLS implements various advanced language features based on config groups, which consists of many CWT config files.
Config groups can have different sources. For config groups from the same source, there are config groups for different game types, and the core config group, which is shared by all game types.
Reference Links:
Sources
Built-in Config Groups
- Path:
config/{gameType}[1] (in the plugin jar) - Enabled: Always
- Customizable ：No
These config files are from plugin repository and config repositories of each game. Compare to the config files used by CWTools, there are several modifications and extensions.
Local Config Groups
- Path:
{rootPath}/{gameType}[1:1] (rootPathneed be to be configured in plugin's settings page) - Enabled: Yes if path is existing
- Customizable ：Yes
Containing config files are customized by users themselves. Available for all projects. Changes should be confirmed to import manually.
Project Config Groups
- Path:
.config/{gameType}[1:2] (in the project root directory) - Enabled: Yes if path is existing
- Customizable ：Yes
Containing config files are customized by users themselves. Only available for this project. Changes should be confirmed to import manually.
Overridden Strategy
Configs use the LIOS overridden strategy based on the file path and the config ID.
When reading configs, the plugin will iterate config groups by following order: built-in config groups, local config groups, and project config groups. The core config group is shared by all game types, and will be iterated before the config group for related game type.
For example, if you have written some custom configs in the config file .config/stellaris/modifiers.cwt (which is in the project root directory), it will completely override the built-in modifier configs. Since the built-in modifier configs are located in the config file config/stellaris/modifiers.cwt (which is in the plugin jar), and both of their file path is modifiers.cwt. If these are no content in the custom config file, after applied, the plugin will be unable to resolve any modifier in script files.
CWT Config File
Summary
CWT config file use its own file format, which can be considered as a variant of paradox script language. Its file extension is .cwt.
Syntax
The basic syntax of a CWT config file is as follows:
# both equal sign ('=', '==') and not equal sign ('<>', '!=') can be used as the k-v separator (also available in options)
+# properties (options) and values can be mixed in clauses (also available in options)
+
+### documentation comment
+## option = option_value
+## option_0 = { k = v }
+## option_value
+prop = {
+ # line comment
+ k = v
+ v
+}Writing CWT Config Files
Summary
In progress.
For more detailed specifications, please refer to the reference links below and the built-in config files.
Reference Links:
Specifications
Priorities New in 1.3.7
Priority configs are used to configure the override order for targets (scripted variables, definitions, localisations and complex enums).
priorities = {
+ # LHS - file path (relative to game or mod root directory)
+ # RHS - priority (available values: "fios", "lios", "ordered", default value: "lios", ignore case)
+
+ # file path - path of specific directory (e.g. ""common/on_actions", "common/scripted_variables", "localisation")
+
+ # fios - use the one that reads first, ignore all remaining items
+ # lios - use the one that reads last (if not specified, use this as default)
+ # ordered - reads by order, no overrides
+
+ "events" = fios
+ # ...
+}System Scopes
TODO
Localisation Locales
TODO
Types and Subtypes
TODO
Declarations
TODO
Enums and Complex Enums
TODO
Dynamic Values
TODO
Aliases and Single Aliases
TODO
Inlines
TODO
Modifiers and Modifier Groups
TODO
Links
TODO
Scopes and Scope Groups
TODO
Localisation Links and Localisation Commands
TODO
Specifications (Extended CWT Configs)
Tips
These configs are mostly provided by users themselves, they can be used to enhance plugin's various language features, such as quick documentation, inlay hints, code highlighting and code completion.
Scripted Variables New in 1.3.5
scripted_variables = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+}Definitions
definitions = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## type = civic_or_origin.civic
+ x
+
+ # since 1.3.5, scope context related options are also available here
+ ## type = scripted_trigger
+ ## replace_scopes = { this = country root = country }
+ x
+}Game Rules
game_rules = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to override declaration config
+
+ ### Some documentation
+ ## replace_scopes = { this = country root = country }
+ x
+}On Actions
on_actions = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## replace_scopes = { this = country root = country }
+ ## event_type = country
+ x
+}Inline Scripts
inline_scripts = {
+ # 'x' or 'x = xxx'
+ # 'x' is a inline script expression, e.g., for 'inline_script = jobs/researchers_add', 'x' should be 'jobs/researchers_add'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to declare context config(s) (add '## context_configs_type = multiple' if there are various context configs)
+ # note extended documentation is unavailable for inline scripts
+
+ x
+
+ # more detailed examples for declaring context config(s)
+
+ ## context_configs_type = multiple
+ x = {
+ ## cardinality = 0..1
+ potential = single_alias_right[trigger_clause]
+ ## cardinality = 0..1
+ possible = single_alias_right[trigger_clause]
+ }
+
+ # since 1.3.5, scope context related options are also available here
+
+ ## replace_scopes = { this = country root = country }
+ x
+
+ # since 1.3.6, using single alias at root level is also available here
+
+ ## context_configs_type = multiple
+ x = single_alias_right[trigger_clause]
+}Example:
Parameters
parameters = {
+ # 'x' or 'x = xxx'
+ # 'x' is a parameter name, e.g., for '$JOB$', 'x' should be 'JOB'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to declare context config(s) (add '## context_configs_type = multiple' if there are various context configs)
+
+ # since 1.3.6, value of option 'context_key' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## context_key = scripted_trigger@some_trigger
+ x
+
+ # more detailed examples for declaring context config(s)
+
+ ## context_key = scripted_trigger@some_trigger
+ x = localistion
+
+ ## context_key = scripted_trigger@some_trigger
+ ## context_configs_type = multiple
+ x = {
+ localisation
+ scalar
+ }
+
+ # since 1.3.5, scope context related options are also available here
+
+ ## context_key = scripted_trigger@some_trigger
+ ## replace_scopes = { this = country root = country }
+ x
+
+ # since 1.3.6, using single alias at root level is also available here
+
+ ## context_key = scripted_trigger@some_trigger
+ ## context_configs_type = multiple
+ x = single_alias_right[trigger_clause]
+
+ # since 1.3.12, a parameter's config context and scope context can be specified to inherit from its context
+ # e.g. for parameter 'x' with context key 'scripted_trigger@some_trigger', its context is scripted trigger 'some_trigger'
+
+ ## context_key = scripted_trigger@some_trigger
+ ## inherit
+ x
+}Example:
Complex Enum Values
complex_enum_values = {
+ component_tag = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+ }
+}Dynamic Values
dynamic_values = {
+ event_target = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+
+ # since 1.3.9, scope context related options are also available here
+ # only receive push scope (this scope), ignore others (like root scope, etc.)
+
+ ## push_scope = country
+ x
+ }
+}FAQ
About the Template Expression
Template expressions are composed of string literals and expressions of limited types (definitions, enums and dynamic values), and can be used for more flexible matching.
# a string literal, exactly matches 'x'
+x
+# a template expression which contains a reference to jobs, matches 'a_researcher_b', 'a_farmer_b', etc.
+a_<job>_b
+# a template expression which contains a references to enum of weight_or_base, matches 'a_weight_b' and 'a_base_b'
+a_enum[weight_or_base]_b
+# a template expression which contains a references to dynamic value type of anything
+# generally, there is no limit for 'value[anything]', so this expression is equivalent to regex 'a_.*_b'
+a_value[anything]_bHow to Use the ANT Expression in Config Files New in 1.3.6
Since 1.3.6, the ANT expression can be used for more flexible matching.
# a ant expression use prefix 'ant:'
+ant:/foo/bar?/*
+# a ant expression use prefix 'ant.i:' (ignore case)
+ant.i:/foo/bar?/*
+
+# wildcards in ant expression:
+# '?' - used to match any single character
+# '*' - used to match any characters (exclude '/')
+# '**' - used to match any charactersHow to Us Regex in Config Files New in 1.3.6
Since 1.3.6, Regex can be used for more flexible matching.
# a regex use prefix 're:'
+re:foo.*
+# a regex use prefix 're.i:' (ignore case)
+re.i:foo.*How to Specify the Scope Context in Config Files
In config files, the scope context is specified by option push_scope and replace_scope.
# push 'country' scope to scope stack
+# for this example, the next this scope will be 'country'
+## push_scope = country
+some_config
+
+# replace scopes of specific system scopes into scope context
+# not supported for 'prev' system scope (and 'prevprev', etc.)
+# for this example, the next this scope will be 'country', so do the next root scope and the next from scope
+## replace_scopes = { this = country root = country from = country }
+some_configImporting CWT Config Files
Summary
You can write customized config files in directories of local config groups or project config groups. They are helpful for optimizing plugin's built-in configs, or enhancing plugin's features.
If some changes are happened, the refresh button will be appeared in the context float toolbar in the upper right corner of the editor. Click it to confirm to import, so changes of these custom config files will be applied.
IDE will take some time to reparse opened files in background, And please note that if the changes in the config files will result in the change of the indexing logic (for example, a new definition type is added, or a match condition for some definition type is changed), you may need to reindex the whole project (this may take several minutes), to make sure the plugin works properly, if in the situation that involves these changes.
Skip to main content
+
+
+
diff --git a/en/plugin-integration.html b/en/plugin-integration.html
new file mode 100644
index 000000000..0d457a1fe
--- /dev/null
+++ b/en/plugin-integration.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+
+
+ Introduce
About 321 wordsAbout 1 min
Introduce
Summary
GitHub | Plugin Marketplace Page | Discord
IDEA plugin: Support for Paradox language.
Features:
- Supports script & localisation languages and CWT language (used by config files).
- Provides various almost excellent language features for script & localisation languages, including code highlight, code navigation, code completion, code inspection, code refactoring, quick documentation, inlay hints, live templates, code hierarchy, diagram, diff and more.
- Provides basic language features for CWT language, including code highlight, code navigation, quick documentation and more.
- Supports rendering scope context, localisation text, DDS images and other useful information via quick documentation and inlay hints.
- Supports most advanced features of script & localisation languages (such as parameters, scopes, inline scripts and various complex expressions).
- Supports customizing extended config files, allowing plugin to provide more perfect language features (such as code navigation, code completion, quick documentation and inlay hints).
- Automatically recognizes the game directory (containing the launcher settings file
launcher-settings.json) and mod directory (containing the mod descriptor filedescriptor.mod).
This plugin has implemented various advanced language features based on config groups, which consists of CWT config files. The latest-version config files are already built into this plugin, make it works right out of the box. Besides, customizing and importing local config files are also supported.
If Translation is also installed, this plugin can provide some additional features.
References
Reference manual:
Tools and plugins:
- cwtools/cwtools
- cwtools/cwtools-vscode
- bcssov/IronyModManager
- OldEnt/stellaris-triggers-modifiers-effects-list
- YiiGuxing/TranslationPlugin
Wiki:
Skip to main content
+
+
+
diff --git a/en/plugin-settings.html b/en/plugin-settings.html
new file mode 100644
index 000000000..509fc97ea
--- /dev/null
+++ b/en/plugin-settings.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+
+
+ Plugin Integration
About 140 wordsLess than 1 minute
Plugin Integration
Integrate Translation Plugin
When Translation plugin is also installed and enabled, PLS will provide bellow additional features:
Translate documentation
When the cursor is over a definition name, a localisation name or some other positions, can translate documentation content by click and select Translate Documentation icon button in quick documentation popup window, or click Translate Documentation item in right-click menu.
Warning
There is no guarantee that special markers will be preserved correctly after translation yet.
Intention: Copy localisation(s) to the clipboard for locale...
When the cursor selection scope involves localisation(s), this intention can copy all involved localisation(s) to the clipboard, and try to translate the localisation text into the specified locale before doing so.
Warning
There is no guarantee that special markers will be preserved correctly after translation yet.
Redirecting...
+ + diff --git a/plugin-integration.html b/plugin-integration.html new file mode 100644 index 000000000..8a3c8b8c2 --- /dev/null +++ b/plugin-integration.html @@ -0,0 +1,69 @@ + + + + + +Redirecting...
+ + diff --git a/plugin-settings.html b/plugin-settings.html new file mode 100644 index 000000000..8a3c8b8c2 --- /dev/null +++ b/plugin-settings.html @@ -0,0 +1,69 @@ + + + + + +Redirecting...
+ + diff --git a/quick-start.html b/quick-start.html new file mode 100644 index 000000000..8a3c8b8c2 --- /dev/null +++ b/quick-start.html @@ -0,0 +1,69 @@ + + + + + +Redirecting...
+ + diff --git a/robots.txt b/robots.txt new file mode 100644 index 000000000..ada58cf46 --- /dev/null +++ b/robots.txt @@ -0,0 +1,5 @@ + +User-agent:* +Disallow: + +Sitemap: https://windea.icu/Paradox-Language-Support/sitemap.xml diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 000000000..b03eeffe4 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,3 @@ + + +
+
+
+
+
+
+
+
+ Sitemap
+|
+ |
+ Priority | +Change Frequency | +Last Updated Time | +
|---|---|---|---|
|
+ |
+
+ |
+
+ |
+
+ |
+
跳至主要內容
+
+
+
diff --git a/zh/core-features.html b/zh/core-features.html
new file mode 100644
index 000000000..924719c4f
--- /dev/null
+++ b/zh/core-features.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+
+
+ 规则分组与规则文件
约 2109 字大约 7 分钟
规则分组与规则文件
规则分组
概述
PLS基于由CWT规则文件组成的规则分组，实现了诸多语言功能。
规则分组可以有不同的来源，而对于同一来源的规则分组，又区分为各自游戏类型的规则分组，以及所有游戏类型共享的核心规则分组。
参考链接：
来源
内置的规则分组
- 路径：
config/{gameType}[1]（位于插件jar包中） - 是否启用：始终启用
- 是否可自定义：否
其中的规则文件来自插件仓库以及各自游戏的规则仓库，相较于CWTools所使用的规则文件，它们经过一定的修改和扩展。
本地的规则分组
- 路径：
{rootPath}/{gameType}[1:1]（可在插件的配置页面中配置rootPath对应的文件路径） - 是否启用：如果路径存在
- 是否可自定义：是
其中的规则文件由用户自定义，适用于所有项目。对它们的更改需要手动确认导入。
项目的规则分组
- 路径：
.config/{gameType}[1:2]（位于项目根目录中） - 是否启用：如果路径存在
- 是否可自定义：是
其中的规则文件由用户自定义，仅适用于当前项目。对它们的更改需要手动确认导入。
覆盖策略
规则会按照文件路径和规则ID进行后序覆盖。
读取规则时，插件会依次遍历内置的规则分组、本地的规则分组以及项目的规则分组。 核心规则分组由所有游戏类型共享，会在对应游戏类型的规则分组之前被遍历。
例如，如果你在项目根目录下的规则文件.config/stellaris/modifiers.cwt中编写了自定义的规则，它将完全覆盖插件内置的修正规则。 因为插件内置的修正规则位于插件jar包中的规则文件config/stellaris/modifiers.cwt中，它们的文件路径都是modifiers.cwt。 如果此自定义的规则文件中没有任何内容，应用后插件将无法解析脚本文件中的任何修正。
CWT规则文件
概述
CWT规则文件使用一种特别的文件格式，可以视为Paradox脚本语言的变种。它的文件扩展名为.cwt。
语法
CWT规则文件的基本语法如下所示：
# both equal sign ('=', '==') and not equal sign ('<>', '!=') can be used as the k-v separator (also available in options)
+# properties (options) and values can be mixed in clauses (also available in options)
+
+### documentation comment
+## option = option_value
+## option_0 = { k = v }
+## option_value
+prop = {
+ # line comment
+ k = v
+ v
+}编写CWT规则文件
概述
正在更新中。
关于更详细的编写规范，请参考下方的参考链接以及插件内置的那些规则文件。
参考链接：
编写规范
Priorities New in 1.3.7
优先级规则可以用来配置目标（封装变量，定义、本地化与复杂枚举）的覆盖顺序。
priorities = {
+ # LHS - file path (relative to game or mod root directory)
+ # RHS - priority (available values: "fios", "lios", "ordered", default value: "lios", ignore case)
+
+ # file path - path of specific directory (e.g. ""common/on_actions", "common/scripted_variables", "localisation")
+
+ # fios - use the one that reads first, ignore all remaining items
+ # lios - use the one that reads last (if not specified, use this as default)
+ # ordered - reads by order, no overrides
+
+ "events" = fios
+ # ...
+}System Scopes
TODO
Localisation Locales
TODO
Types and Subtypes
TODO
Declarations
TODO
Enums and Complex Enums
TODO
Dynamic Values
TODO
Aliases and Single Aliases
TODO
Inlines
TODO
Modifiers and Modifier Groups
TODO
Links
TODO
Scopes and Scope Groups
TODO
Localisation Links and Localisation Commands
TODO
编写规范（扩展的CWT规则）
提示
这些规则基本上由用户自行编写，用于强化插件的各项语言功能，例如快速文档、内嵌提示、代码高亮与代码补全。
Scripted Variables New in 1.3.5
scripted_variables = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+}Definitions
definitions = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## type = civic_or_origin.civic
+ x
+
+ # since 1.3.5, scope context related options are also available here
+ ## type = scripted_trigger
+ ## replace_scopes = { this = country root = country }
+ x
+}Game Rules
game_rules = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to override declaration config
+
+ ### Some documentation
+ ## replace_scopes = { this = country root = country }
+ x
+}On Actions
on_actions = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## replace_scopes = { this = country root = country }
+ ## event_type = country
+ x
+}Inline Scripts
inline_scripts = {
+ # 'x' or 'x = xxx'
+ # 'x' is a inline script expression, e.g., for 'inline_script = jobs/researchers_add', 'x' should be 'jobs/researchers_add'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to declare context config(s) (add '## context_configs_type = multiple' if there are various context configs)
+ # note extended documentation is unavailable for inline scripts
+
+ x
+
+ # more detailed examples for declaring context config(s)
+
+ ## context_configs_type = multiple
+ x = {
+ ## cardinality = 0..1
+ potential = single_alias_right[trigger_clause]
+ ## cardinality = 0..1
+ possible = single_alias_right[trigger_clause]
+ }
+
+ # since 1.3.5, scope context related options are also available here
+
+ ## replace_scopes = { this = country root = country }
+ x
+
+ # since 1.3.6, using single alias at root level is also available here
+
+ ## context_configs_type = multiple
+ x = single_alias_right[trigger_clause]
+}示例：
Parameters
parameters = {
+ # 'x' or 'x = xxx'
+ # 'x' is a parameter name, e.g., for '$JOB$', 'x' should be 'JOB'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+ # use 'x = xxx' to declare context config(s) (add '## context_configs_type = multiple' if there are various context configs)
+
+ # since 1.3.6, value of option 'context_key' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## context_key = scripted_trigger@some_trigger
+ x
+
+ # more detailed examples for declaring context config(s)
+
+ ## context_key = scripted_trigger@some_trigger
+ x = localistion
+
+ ## context_key = scripted_trigger@some_trigger
+ ## context_configs_type = multiple
+ x = {
+ localisation
+ scalar
+ }
+
+ # since 1.3.5, scope context related options are also available here
+
+ ## context_key = scripted_trigger@some_trigger
+ ## replace_scopes = { this = country root = country }
+ x
+
+ # since 1.3.6, using single alias at root level is also available here
+
+ ## context_key = scripted_trigger@some_trigger
+ ## context_configs_type = multiple
+ x = single_alias_right[trigger_clause]
+
+ # since 1.3.12, a parameter's config context and scope context can be specified to inherit from its context
+ # e.g. for parameter 'x' with context key 'scripted_trigger@some_trigger', its context is scripted trigger 'some_trigger'
+
+ ## context_key = scripted_trigger@some_trigger
+ ## inherit
+ x
+}示例：
Complex Enum Values
complex_enum_values = {
+ component_tag = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+ }
+}Dynamic Values
dynamic_values = {
+ event_target = {
+ # 'x' or 'x = xxx'
+ # 'x' can also be a pattern expression (template expression, ant expression or regex)
+
+ ### Some documentation
+ ## hint = §RSome inlay hint text§!
+ x
+
+ # since 1.3.9, scope context related options are also available here
+ # only receive push scope (this scope), ignore others (like root scope, etc.)
+
+ ## push_scope = country
+ x
+ }
+}FAQ
关于模版表达式
模版表达式由字符串字面量以及限定类型的表达式（定义，枚举，动态值）组合而成，用来进行更加灵活的匹配。
# a string literal, exactly matches 'x'
+x
+# a template expression which contains a reference to jobs, matches 'a_researcher_b', 'a_farmer_b', etc.
+a_<job>_b
+# a template expression which contains a references to enum of weight_or_base, matches 'a_weight_b' and 'a_base_b'
+a_enum[weight_or_base]_b
+# a template expression which contains a references to dynamic value type of anything
+# generally, there is no limit for 'value[anything]', so this expression is equivalent to regex 'a_.*_b'
+a_value[anything]_b如何在规则文件中使用ANT表达式 New in 1.3.6
从1.3.6开始，可以通过ANT表达式进行更加灵活的匹配。
# a ant expression use prefix 'ant:'
+ant:/foo/bar?/*
+# a ant expression use prefix 'ant.i:' (ignore case)
+ant.i:/foo/bar?/*
+
+# wildcards in ant expression:
+# '?' - used to match any single character
+# '*' - used to match any characters (exclude '/')
+# '**' - used to match any characters如何在规则文件中使用正则表达式 New in 1.3.6
从1.3.6开始，可以通过正则表达式进行更加灵活的匹配。
# a regex use prefix 're:'
+re:foo.*
+# a regex use prefix 're.i:' (ignore case)
+re.i:foo.*如何在规则文件中指定作用域上下文
在规则文件中，作用域上下文是通过选项push_scope与replace_scope来指定的。
# push 'country' scope to scope stack
+# for this example, the next this scope will be 'country'
+## push_scope = country
+some_config
+
+# replace scopes of specific system scopes into scope context
+# not supported for 'prev' system scope (and 'prevprev', etc.)
+# for this example, the next this scope will be 'country', so do the next root scope and the next from scope
+## replace_scopes = { this = country root = country from = country }
+some_config导入CWT规则文件
概述
你可以在本地的规则分组或者项目的规则分组对应的目录下编写自定义的规则文件。 它们可以用来完善插件内置的规则，或是增强插件的功能。
如果发生更改，编辑器右上角的上下文悬浮工具栏中会出现刷新按钮。 点击确认导入后，即可应用这些自定义的规则文件的更改。
IDE将会在后台花费一些时间重新解析已打开的文件， 并且请注意，如果规则文件的更改会引发索引逻辑的更改 （例如，新增了一种定义类型，或是更改了某种定义类型的匹配条件）， 你可能需要重新索引整个项目（这可能需要花费数分钟），以使在涉及到这些更改的场合，插件能够正常工作。
跳至主要內容
+
+
+
diff --git a/zh/plugin-integration.html b/zh/plugin-integration.html
new file mode 100644
index 000000000..a580d059f
--- /dev/null
+++ b/zh/plugin-integration.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+
+
+ 介绍
约 505 字大约 2 分钟
介绍
概述
GitHub | Plugin Marketplace Page | Discord | QQ群：653824651
IDEA插件：Paradox语言支持。
特性：
- 支持脚本语言与本地化语言，以及规则文件所使用的CWT语言。
- 为脚本语言与本地化语言提供诸多较为完备的语言功能，包括代码高亮、代码导航、代码补全、代码检查、代码重构、快速文档、内嵌提示、动态模版、代码层级、图表、差异比较等。
- 为CWT语言提供基础的语言功能，包括代码高亮、代码导航、快速文档等。
- 支持通过快速文档与内嵌提示等方式，渲染作用域上下文、本地化文本、DDS图片以及其他有用的信息。
- 支持脚本语言与本地化语言的多数高级特性（例如参数、作用域、内联脚本和各种复杂表达式）。
- 支持自定义扩展的规则文件，从而允许插件提供更加完善的语言功能（例如代码导航、代码补全、快速文档和内嵌提示）。
- 自动识别游戏目录（包含启动器配置文件
launcher-settings.json）和模组目录（包含模组描述符文件descriptor.mod）。
此插件基于由CWT规则文件组成的规则分组，实现了诸多语言功能。 插件已经内置了最新版本的规则文件，以便开箱即用。 除此之外，插件也支持自定义与导入本地的规则文件。
如果同时安装了 Translation ，此插件可以提供一些额外的功能。
参考
参考手册：
工具和插件：
- cwtools/cwtools
- cwtools/cwtools-vscode
- bcssov/IronyModManager
- OldEnt/stellaris-triggers-modifiers-effects-list
- YiiGuxing/TranslationPlugin
Wiki：
跳至主要內容
+
+
+
diff --git a/zh/plugin-settings.html b/zh/plugin-settings.html
new file mode 100644
index 000000000..9a28fa2a3
--- /dev/null
+++ b/zh/plugin-settings.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+
+
+ 插件集成
约 245 字小于 1 分钟
插件集成
集成Translation插件
当同时安装且启用了Translation插件时，PLS将会额外提供以下功能：
翻译文档内容
当光标位于定义的名字、本地化的名字等位置时，可以通过点击并选择快速文档弹出窗口中的Translate Documentation图标按钮，或者点击右键菜单中的Translate Documentation选项翻译文档内容。
注意
暂不保证翻译后能够正确地识别并保留各种特殊标记。
意向：复制本地化到剪贴板并将本地化文本翻译为指定的语言区域
当光标选取范围涉及到本地化时，此意向可以将所有涉及到的本地化复制到剪切板，并且在这之前尝试将本地化文本翻译为指定的语言区域。
注意
暂不保证翻译后能够正确地识别并保留各种特殊标记。