ZedScripts LSP

ZedScripts LSP is a language server protocol implementation in Python for the scripting format of Project Zomboid. Previously a VSCode extension, it is now reimplemented as a standalone LSP.

Installation

Releases

Python package

pip install git+https://github.com/PZ-Wiki-Modding/ZedScripts-LSP.git

pip install .

Usage

You can either launch the LSP from Python or you can launch the software as is.

LSP cache directory

The LSP uses a cache directory on your system to store temporary files and logs as well as configuration files. You can find it here:

~/.zedscripts

%USERPROFILE%\.zedscripts

Configuration

The LSP uses configurations files which provide information to the LSP about various settings. You have access to a global configuration file

Example configuration:

{
    "dataset": {
        "latest": true
    },
    "libraries": [
        "/home/simon/.steam/debian-installation/steamapps/common/ProjectZomboid/projectzomboid/media",
    ]
}

WIP: proper documentation will come soon

IDE configuration

Based on the IDE you use, you may need to install the ZedScripts LSP application for your OS in the releases (Linux, Windows).

Visual Studio Code

Install the ZedScripts extension from the Visual Studio Code marketplace. The extension will handle the downloading and setup of the ZedScripts LSP server for you.

VIM

Using yegappan/lsp, setup the ZedScripts LSP server as follows:

let lspServers = [
      \ #{
      \   name: 'zedscripts',
      \   filetype: ['text', 'zedscripts'],
      \   path: 'path/to/ZedScripts',
      \   args: []
      \ }
      \ ]

autocmd User LspSetup call LspAddServer(lspServers)

License

See LICENSE for details.