Code Monkey home page Code Monkey logo

vscode-dm-langclient's Introduction

DreamMaker Language Client

This VS Code extension acts as a client to the DreamMaker language server, a component of SpacemanDMM. It provides language-related services for DreamMaker, the scripting language of the BYOND engine. It also includes syntax highlighting definitions.

The extension has an optional auto-update feature for the language server, with binaries available for Windows and Linux.

On other platforms, the path to the `dm-langserver` binary must be specified manually.

For other platforms such as macOS/darwin, you'll need to clone the source repository for the dm-langserver linked above. Once cloned, with rust installed, you'll follow that repo's README to compile the langserver (takes about 7 minutes without rust already having the dependencies cached). In the resulting '/target/release/' directory in the repo's root folder, you'll find 'dm-langserver'. When opening a repo with a .dme, I.E. tgstation - this extension will prompt you to find your dm-langserver executable and select it. (Be sure to not enable auto-update when prompted, the autoupdate server will not contain darwin/x64 binaries)

Language server features include:

  • Workspace symbol search (Ctrl+T).
  • Go to definition (Ctrl+Click).
  • Go to type definition.
  • As-you-type autocomplete.
  • Signature help in proc calls.
  • Find references to a symbol.
  • Current file outline view.
  • Hovering var and proc definitions to see their parents.
  • And more, with details at the language server documentation.

Additional extension features include:

  • Project object tree view.
  • Build task (Ctrl+Shift+B) support for invoking DreamMaker.
  • Status bar control to toggle a file's tickmark in the .dme.
    • Optionally automatically ticking created/unticking deleted files.
  • Built-in DM Reference browser.
    • Open index with "DreamMaker: Open DM Reference" in the command palette.
    • Look up items with workspace symbol search, go to definition, or object tree.

Building

  1. Install Node and NPM.
  2. Download dependencies: npm install
  3. npx @vscode/vsce package
  4. Install produced .vsix into Visual Studio Code.

License

DreamMaker Language Client is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

DreamMaker Language Client is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with DreamMaker Language Client. If not, see http://www.gnu.org/licenses/.

vscode-dm-langclient's People

Contributors

anturk avatar dependabot[bot] avatar gbasood avatar spacemaniac avatar vvvv-vvvv avatar willox avatar zewaka avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.