Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastian-lenz committed Sep 6, 2018
1 parent 523c6f9 commit 5db81b3
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This extensions enables language features for the scripting language Osiris found in The Divinity Engine 2 based games.

**New: You can now use LSLib Compiler and Debugger with this extension. This allows you to compile story scripts directly from VS Code and use the debugger of VS Code with story scripts. More info available here: https://gist.github.com/Norbyte/8b7eb35cd17f799ea113636b15e1f967**

## Getting started

### Installation
Expand Down Expand Up @@ -73,6 +75,22 @@ The code completion, hovers and the signature help will show you short snippet f

The extensions includes a special syntax highlighting for Osiris log files.

## Compiler and debugger

This extension offers additional features when used together with LSLib Compiler and Debugger. You can install LSLib using the built-in installer. Open the command palette using Ctrl+Shift+P and search for the command `Install LSLib Compiler and Debugger`. The command will ask you for an install location, you must pick an empty folder. Tools installed this way will be automatically kept up-to-date on every launch of VS Code. You can manually check for updates using the command `Update LSLib Compiler and Debugger`.

### Compile

You can compile your story by pressing Ctrl+Shift+B and select one of the compile tasks.

![API explorer](resources/features/compiler.gif)

### Debug

You can setup the debugger like any other debugger in VS Code by creating a launch configuartion, press F5 to create the default launch configuartion. After that you can start the debugger from the debugger panel or by pressing F5 again. The debugger needs modifications to your game or editor directory, follow this guide for a detailed description: https://gist.github.com/Norbyte/8b7eb35cd17f799ea113636b15e1f967

![API explorer](resources/features/debugger.gif)

## Differences to the built in editor

Unlike the built in editor VS Code will not display three different regions when editing story goals. Instead you'll see the complete source file of each goal. The basic file structure looks like this:
Expand Down
Binary file added resources/features/compiler.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/features/debugger.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5db81b3

Please sign in to comment.