Skip to content

Latest commit

 

History

History
162 lines (117 loc) · 6.02 KB

README.md

File metadata and controls

162 lines (117 loc) · 6.02 KB
Raw

Source Engine Support for Vscode

CI Test contributions welcome Release

VSCODE ESLINT TYPESCRIPT NODE.JS

Visual Studio Marketplace - OpenVSX Registry

Discord - Bugs

This extension adds intelligent syntax highlighting and additional tooling for Source Engine file formats.

State of this project

Looking at the last commit times, you may assume this project is abandoned. But I would rather call it done. I built this extension to aid in my work on Portal: Revolution, which has now released. I have added all the features I wanted and don't know what else I'd add. If you find any bugs, please feel free to report them. I want to keep this extension in a working state, but have no plans to add any new features unless I need them in another modding endevour.

Syntax highlighting

Available for:

  • KeyValue files
    • .vdf .res .acf .kv .vmf .vmm .vmx
    • .txt files can be auto-detected as being KV files
  • .vmt
  • .fgd
  • .qc
  • .cfg
  • lights.rad
  • .vpc, .vgc
  • .smd
  • .fxc and _fxc.h

Syntax highlighting in vmt files

In-Editor compilation

Instead of juggling standalone tools or CLI programs, simply compile model (.qc) and captions (subtitles_english.txt) right inside of the extension.

Compile button

KeyValue file auto-detection

In Source, many KeyValue files are saved with a .txt extension. Since not all .txt files should be treated as KeyValue files, this extension can auto-detect KeyValue files which end in .txt. Instead, KeyValue files are matched using a list of common keyvalue file names. (e.g.: gameinfo.txt, game_sounds_*.txt, subtitles_engish.txt...)

Full feature list

Here's a list of all the things that are implemented in this extension

General

  • KeyValue syntax highlighting
  • KeyValue semantic highlighting
  • Auto-detect common file names like gameinfo.txt
  • Semantic Tokenizer
  • Error detection
  • Duplicate key detection
  • Support for #include and #base
  • Support for conditionals (e.g.: [$Debug])

VMT

  • .vmt syntax highlighting
  • .vmt semantic highlighting with error detection and completions
  • Parameter name completion
  • Config for parameters
  • Parameter value completion
  • Parameter value validation dependent on parameter name
  • Texture (vtf) file path completion and missing file detection
  • Color value preview

FGD

  • .fgd syntax highlighting
  • UnifyFGD syntax support (Hammer Addons)

QC

  • QC syntax highlighting
  • Compile model button
    • Configuration for mdlcompile.exe
    • Configuration for game root path

Captions

  • Captions syntax highlighting
  • Captions markup highlighting (I, B, clr tags...)
  • Captions color preview (clr tags)
  • In-editor Compile captions button

CFG

  • .cfg syntax highlighting

VPC

  • .vpc and .vgc syntax highlighting

Lights.rad

  • .rad file syntax highlighting

Soundscripts

  • Soundscript syntax highlighting
  • Soundscript snippets

SMD

  • .smd syntax highlighting

FXC

  • .fxc syntax highlighting
  • _fxc.h syntax highlighting (Shader header files)

Sourcelib

This extension implements the features seen in sourcelib.

Contributing

This repository uses trunk based development, which means that all changes can be pushed straight to master. Every commit is automatically tested via the CI pipeline. Once a new version tag is pushed, the release is deployed.

As an outside contributor, please create your pull requests to merge to the master branch. Do not edit changelog.md or the feature listings in readme.md as the changelog will be handled later when releasing.

Make sure all workflows succeed. To validate locally:

npm run lint
npm run test

Compiling and testing locally

Users can just install this extension on the VSCode Marketplace, but developers might want to run the development build of the extension.

Prerequisites

  1. Install NPM and NodeJS (>v12)
  2. Install Visual Studio Code (Duh)
  3. Clone the repository
  4. Run npm install in the repository's folder, to install the dependencies

Testing

To start the unit tests, run npm run test. The project will be automatically compiled.

Benchmarking

To run the benchmark tests, run npm run benchmark. The project will be automatically compiled

Running the extension

  1. To start the extension, first compile the project npm run build (Or npm run watch to auto-compile on every file change)
  2. Open the repository in VSCode
  3. Open the 'Run and Debug' tab
  4. Select the 'Extension' run configuration on the dropdown on the top
  5. Run by pressing F5

License

This project is licensed under the GNU Public License version 3: License