docs.en-US.md

Documentation

Note

This document is machine-translated.
It may incorrect.

Note

The documentation is still being improved
If you want to contribute to the improvement, please follow the instructions in this document to submit a PR

Usage

See README for startup methods

Configuration File

The configuration is stored in config.json.
You can modify this file to change the configuration.

Configuration File Structure

• (Object) Root object
  • rules (Array) Rule group
    • (Object) A rule
      • path (String) Path to traverse (must be an absolute path)
      • matches (Array) Matching rule list
        • (Object) A matching rule
          • type (String) Match type (see below Supported Matches)
          • value (String) Match value
          • full (Boolean) Full match
          • rename (String) Renamed name (without .lnk)
        • ...
    • ...

Supported Matches

Parameters provided by the windows-shortcuts package, see the documentation of this package for details

• target: Target of the shortcut
• args: Command line arguments
• workingDir: Working directory
• runStyle: Running style (specific data is not clear yet)
• icon: Icon path
• iconIndex: Icon index in the file (for DLL and files with multiple icons)
• hotKey: Startup hotkey (specific data is not clear yet)

Configuration File Example

Click to expand

{
    "rules": [
        {
            "path": "Path1",
            "matches": [
                {
                    "type": "target",
                    "value": "Target Address1",
                    "full": false,
                    "rename": "Rename1"
                },
                {
                    "type": "workingDir",
                    "value": "Working Directory1 (Exact Match)",
                    "full": true,
                    "rename": "Rename2"
                }
            ]
        },
        {
            "path": "Path2",
            "matches": [
                {
                    "type": "icon",
                    "value": "Icon Path1",
                    "full": false,
                    "rename": "Rename3"
                }
            ]
        }
    ]
}

Additionally, this repository's config.json also comes with several examples.