Commit a5305469 authored by Jesse McGrew's avatar Jesse McGrew
Browse files

More metadata/docs.

parent 8b7fca8e6dce
......@@ -3,9 +3,11 @@
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## 0.2.0 (March 19, 2018)
## [Unreleased]
## [0.2.0] (March 19, 2018)
### Added
- A debug adapter for source-level debugging, based on ZLR.
- New debug adapter for source-level debugging, based on ZLR.
- Signature help for builtin MDL/ZIL functions.
- Symbols for local variables, including activations.
- Symbols for parts of objects (properties, flags, vocab words).
......@@ -15,5 +17,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Completions are sorted.
- Some duplicate symbols are hidden.
## 0.1.0 (January 17, 2018)
- Initial release
\ No newline at end of file
## [0.1.0] (January 17, 2018)
- Initial release
[Unreleased]: https://bitbucket.org/jmcgrew/zil-editor-support/branches/compare/default..0.2.0
[0.2.0]: https://bitbucket.org/jmcgrew/zil-editor-support/branches/compare/0.2.0..0.1.0
[0.1.0]: https://bitbucket.org/jmcgrew/zil-editor-support/src/0.1.0/vscode/zil-language/?at=0.1.0
\ No newline at end of file
......@@ -23,11 +23,15 @@ This extension implements:
Some features require an installation of ZILF (the ZIL compiler).
To set this up, download the latest release from [Bitbucket](https://bitbucket.org/jmcgrew/zilf/downloads/) (e.g. `zilf-0.8.zip`), and extract it somewhere. Navigate to the folder containing `zilf.exe` and `zapf.exe` when prompted by the extension, or set the `zil.compiler.path` and `zil.assembler.path` settings to point to those files.
To set this up, [download the latest release from Bitbucket](https://bitbucket.org/jmcgrew/zilf/downloads/) (e.g. `zilf-0.8.zip`), and extract it somewhere. Navigate to the folder containing `zilf.exe` and `zapf.exe` when prompted by the extension, or set the `zil.compiler.path` and `zil.assembler.path` settings to point to those files.
### ZLR (optional)
Debugging requires an installation of ZLR, a [Z-machine](https://en.wikipedia.org/wiki/Z-machine) interpreter.
Debugging requires a recent build of ZLR, a [Z-machine](https://en.wikipedia.org/wiki/Z-machine) interpreter.
Such a build is included in this extension package, but if you have another one, you can configure the extension to use it instead.
**NOTE**: The debugger has only been tested on Windows so far. On other operating systems, you may be able to use the debugger by installing [Mono](https://www.mono-project.com/).
## Extension Settings
......@@ -46,10 +50,20 @@ This extension contributes the following settings, which can be customized per f
## Known Issues
* Local variables and Z-code builtins aren't indexed.
* MDL builtins don't have signature help.
### IntelliSense
* Definitions in ZIL code are only reindexed when the file is saved.
### Editor
* When this extension's bracket highlighting conflicts with VS Code's, both pairs are highlighted.
### Debugger
* The debugger has only been tested on Windows.
* Breakpoints can't be set while the game is running.
- Workaround: Pause the game, set the breakpoint, resume.
* Source line breakpoints can't be set in some cases where the extension and ZILF calculate different
relative paths for the source file.
- Workaround: Set a named function breakpoint.
## Release Notes
### 0.1.0
......
......@@ -11,16 +11,15 @@
},
"categories": [
"Languages",
"Debuggers"
"Debuggers",
"Snippets"
],
"keywords": [
"ZIL",
"ZILF",
"Z-machine",
"interactive fiction",
"game development"
"zil",
"zilf",
"zmachine",
"gamedev"
],
"main": "./out/extension",
"scripts": {
"compile": "run-s compile:*",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment