DenizenScript / DenizenVSCode

A DenizenScript extension for VS Code.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DenizenScript VS Code Extension

An extension to VS Code to provide general language support for .dsc files written for Denizen.

This can be downloaded from The Marketplace.

Installation and Usage

Install guide can be found in the Guides here.

You can enable auto-indenting by opening .vscode/settings.json and adding:

{
    "[denizenscript]": {
        "editor.autoIndent": "full",
    }
}

Building

  • Within DenizenLangServer/, build the C# language server project with dotnet build --configuration=release, or in Visual Studio 2022.
  • Copy the output files (deepest folder under DenizenLangServer/bin/) to path extension/server/
  • You will need NodeJS and NPM: https://nodejs.org/en/
  • Within extension/, run npm install and npm install -g typescript
  • Within extension/, build the extension TypeScript files with tsc -p ./ --skipLibCheck
  • You can test by just hitting F5 (it helps to have the extension.ts file open so VS knows what you're trying to run)
  • Packaging can be done via vsce package

Current Features

  • Full syntax highlighting (customizable via settings)
  • Error checking (imperfect but catches a lot of common mistakes)
  • Autocomplete suggestions, for tags, commands, script names, flag names, etc.
  • Hover-docs when you mouse over any recognized data (script names, commands, tags, etc.)
  • Full workspace analysis and checking

Planned Future Features

  • More detailed/thorough autocomplete suggestions, error checking, etc.

Licensing pre-note:

This is an open source project, provided entirely freely, for everyone to use and contribute to.

If you make any changes that could benefit the community as a whole, please contribute upstream.

The short of the license is:

You can do basically whatever you want, except you may not hold any developer liable for what you do with the software.

The long version of the license follows:

The MIT License (MIT)

Copyright (c) 2019-2023 The Denizen Scripting Team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A DenizenScript extension for VS Code.

License:MIT License


Languages

Language:C# 64.8%Language:TypeScript 35.2%