https://github.com/thomasballinger/endless-sky-vscode

Endless Sky data language VSCode support
https://github.com/thomasballinger/endless-sky-vscode

Last synced: 3 months ago
JSON representation

Endless Sky data language VSCode support

• Host: GitHub
• URL: https://github.com/thomasballinger/endless-sky-vscode
• Owner: thomasballinger
• License: gpl-3.0
• Created: 2021-09-13T11:49:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-09T17:44:51.000Z (about 3 years ago)
• Last Synced: 2024-10-11T19:12:01.806Z (4 months ago)
• Language: TypeScript
• Size: 822 KB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Endless Sky data file language extension

Notice your spelling mistakes sooner!

This extension interprets every .txt file as Endless Sky data. You can change the filetype of a document back to 'plaintext' to temporarily disable this, or disable the plugin to prevent it on all files. Maybe someday there will be a way to change language based on file contents or location, but for now there seems to be no way to do this in VSCode.

When creating Endless Sky plugins, see [the GitHub wiki](https://github.com/endless-sky/endless-sky/wiki/CreatingPlugins) for instructions. Some of this information in available in-editor with this extension, but the wiki will always be the authoritative source. Some keywords may be missing from syntax highlighting in this plugin, but the error messages are directly from an Endless Sky executable.

## Features

- syntax highlighting

- errors.txt messages shown inline

- snippets for creating new planets, fleets, and stellar objects.

- "Run Conversation" command for quickly testing conversations

- more coming soon!

# Config

The plugin looks in several standard locations for Endless Sky installed on your computer, but you can choose which executable to use by setting the executable path in settings by searching for endless sky settings or setting `endlesssky.executablePath` in settings.json.

In order to prevent all text files from being interpreted as Endless Sky files, add this to your settings:

```

    "files.associations": {

	"**/*.text": "plaintext",

	"**/data/**/*.txt": "endlesssky",

    }

```

## Contributing

Please open issues with bugs and ideas [here](https://github.com/thomasballinger/endless-sky-vscode). If you're using this plugin I'd love to hear from you.

If you want to improve anything, especially the snippets or syntax highlighting, make a pull request to [this repo](https://github.com/thomasballinger/endless-sky-vscode) or let [@ballingt](https://twitter.com/ballingt) know on Twitter or message @ballingt on the [Endless Sky Discord](https://discord.gg/ZeuASSx).

Syntax highlighting of keywords is based on the text files in the syntaxgen folder. If a word isn't being highlighted, it should be added to keywords.txt.

Some features are provided by an [LSP](https://microsoft.github.io/language-server-protocol/) which will soon use the [JavaScript Endless Sky bindings](https://github.com/thomasballinger/endless-sky-bindings). Contributions to these bindings are helpful too.