YAML syntax overview

Only write the fields that need to be modified, do not copy the entire subscription.

生成一个符合 YumeBox 语法的 YAML 覆写

Execution process

Read original configuration

First resolve the subscription or local configuration. Raw YAML errors will stop this compilation.

Read overwrite chain

Read the .yaml and .yml files in binding order. Empty files are skipped and a prompt is logged.

Apply current file

Parse key name modifiers and then perform replacement, append, merge, or force override based on field type.

Generate run configuration

After the user overwrite is completed, YumeBox will supplement the DNS, Tun, listener and Provider path settings required for runtime.

Modifier quick check

Writing method	Function	Detailed description
`key`	Normal write.	Object recursion, array replacement, scalar coverage.
`key-start`	Insert at the beginning of the list.	Lists and Rules
`key-end`	Append to the end of the list.	Lists and Rules
`key-merge`	Merge objects or append list items.	Field Behavior
`key-force`	Directly replaces the entire field.	Field Behavior
`+key`	`key-start` Abbreviation.	Lists and Rules
`key+`	`key-end` Abbreviation.	Lists and Rules
`<key>`	Reserve literal key names.	Examples and Troubleshooting

Explicit -start, -end, -merge, -force take precedence over +key and key+. For example, <rules+> eventually writes the real key name rules+.

Minimal example

修改端口.yaml

mixed-port: 7890

添加规则.yaml

rules-start:
  - DOMAIN-SUFFIX,lan,DIRECT

替换 DNS.yaml

dns-force:
  enable: true
  enhanced-mode: fake-ip
  nameserver:
    - 1.1.1.1

Start here

Guides

Overrides

More

YAML syntax overview

Execution process

Modifier quick check

Minimal example

​Execution process

​Modifier quick check

​Minimal example

Execution process

Modifier quick check

Minimal example