Skip to content

Installation

Joël Deffner edited this page Oct 6, 2026 · 6 revisions

Installation

Plugin 0.2.2 with px-lsp 0.3.8. The bundled server comes from the PX Toolkit 0.5.5 prerelease. Download 0.2.2 for x86, x64 or ARM64 Notepad++.

Notepad++ plugin version 0.2.2 supports Windows x86, x64, and ARM64. Each package bundles px-lsp 0.3.8 and Windows Node; you do not need a separate Node installation. The plugin and the main toolkit have separate version numbers.

Windows

Use Windows 10 or later and choose the package that matches the architecture of Notepad++, even if Windows has a different architecture. The native editor tests use Notepad++ 8.9.8. See validation for tested configurations and limits.

Notepad++ architecture 0.2.2 package
32-bit x86 PxToolkit-NotepadPlusPlus-0.2.2-win-x86.zip
64-bit x64 PxToolkit-NotepadPlusPlus-0.2.2-win-x64.zip
ARM64 PxToolkit-NotepadPlusPlus-0.2.2-win-arm64.zip
  1. Choose the matching 0.2.2 ZIP from the table. The main toolkit's px-lsp ZIP contains only the language server. GitHub's Source code downloads require building the plugin.
  2. Save your files and close Notepad++.
  3. Extract the complete PxToolkit folder into the Notepad++ plugins folder.
  4. Start Notepad++ and open a supported file inside a mod.
  5. Open Plugins > Paradox Modding Toolkit > Options, select your game, and configure the game data folder if you want vanilla files indexed.

The resulting layout includes:

Notepad++/
  plugins/
    PxToolkit/
      PxToolkit.dll
      architecture.txt
      px-lsp/
        px-lsp.cmd
        node.exe
        dist/
        data/
      update-server.ps1
      server-version.txt

Keep the license and notice files from the archive. Copying only the DLL leaves the bundled server unavailable. Replacing the plugin files retains settings stored in the plugin configuration folder.

Use x64 or ARM64 Notepad++ for large vanilla or mod indexes. The x86 server has a 1 GiB JavaScript heap limit because of its smaller address space; the other architectures use 4 GiB.

Wine on Linux or macOS

Wine support is experimental and untested. It runs the Windows plugin inside Windows Notepad++. There is no native Linux or macOS plugin.

Install and run Windows Notepad++ in a Wine prefix configured for Windows 10 or later, then use the Windows plugin package matching that editor's architecture. Your Wine distribution must support both the editor and the included Windows node.exe. On Apple Silicon, this also depends on the Windows architecture support provided by your Wine distribution.

Extract the complete PxToolkit folder into that Notepad++ installation's plugins folder within the same prefix. The bundled .cmd launcher and Node run there. Do not point the custom launcher at a native Linux or macOS executable. Enter game and documentation folders using Windows paths visible in the prefix, such as a mapped drive path, rather than POSIX paths.

The bundled server does not need PowerShell to start. Managed downloads require working Windows PowerShell in that prefix. If it is unavailable, turn off Check for language server updates and install new plugin packages manually. For failures, include your OS, Wine distribution and version, prefix architecture, and Notepad++ architecture in the report.

Open a recognized mod file

An ancestor directory must contain descriptor.mod or a .metadata folder. The plugin recognizes .gui files, localization .yml files, and script .txt files in folders such as common and events. Ordinary text files outside a recognized mod do not start language features.

Use UTF-8 for non-ASCII text. The plugin refuses language features when the buffer contains invalid UTF-8.

One language-server session serves the active mod. Activating a file in another mod starts a session for that mod. Game data can take time to index. The status bar reports the connection and indexing state.

A blank game data folder disables vanilla file indexing. It does not trigger installation detection. A blank script docs folder uses bundled documentation for your selected game. See Settings and updates for both paths.

Check your first session

Open a script in your mod, wait for the status bar to show a connected server, and press Ctrl+Space inside a script block. Open Plugins > Paradox Modding Toolkit > Problems and outline and choose Outline to check that the active file has symbols. If the results area is too short, drag the panel's upper divider upward. See Troubleshooting if the server does not start or the file has no language features.

Outline and syntax colors in a recognized CK3 mod file

Clone this wiki locally