bgforgenet/vscode-bgforge-mls

BGforge MultiLanguage server

BGforge multi-language server

Features | Screenshots | Install | Forum

BGforge MLS is a VScode extension adding support for Star-Trek Scripting Language (ssl) used in Fallout 1 and 2 games, and several file formats (d, baf, tp2, tra, 2da) used by WeiDU and Infinity Engine, as well as Sword Coast Stratagems Scripting Language (ssl/slb).

Features

• Syntax highlighting
• Completion
• Hovers
• Error reporting
• Signature help, diagnostics, docstrings, etc. See the forum.

Installation

1. Search for BGforge in VScode marketplace, like any other extension. (Alternatively, download the package from Github releases tab and install it manually.)
2. Check general settings.
3. Check file associations.
4. Check hotkeys.
5. Enable custom theme and icon theme.
6. (Infinity Engine) Install IElib.

Hotkeys

• CTRL+R: compile (Fallout ssl) or parse (WeiDU tp2) file, reporting errors if any.

Screenshots

Infinity Engine highlighting and completion

Fallout highlighting and hovers

Error reporting

vscode-bgforge-mls's Issues

Separate bgforge.weidu.path by OS and default values

Hi,

can you separate bgforge.weidu.path by OS? Like this:

bgforge.weidu.path.win
bgforge.weidu.path.mac
bgforge.weidu.path.lin

This would also allow for having weidu.exe as the default value for Windows OS, weidu for mac/lin. The additional improvement by implementing this is that extension would work out-of-the-box if the weidu.exe is added to system PATH.

[highlighting][ssl] "procedure" missing colors when "begin" is on next line

First procedure is missing colors as long as begin is on next line; if it's moved to same line as procedure, colors are set properly. Pretty minor and very easy to miss if using only one style for a whole file.

Would be nice if highlight could work same way no matter of begin position.

[SSL] Can't parse symantic error output properly

Screenshot

What's wrong on screenshot

It shows path as "Semantic> <.tml.ssl" instead of actual script path.

Code

variable x;
variable x;

The variable name of ID-Kit-Main has two colors because of minus char.

1. 

2. The variable name of ID-Kit-Main has two colors because of minus char.

3. I think this and that should be colored as one color.

Requsest - Publish to OpenVSX

Hello.

I am hoping to get this library via https://open-vsx.org registry. I see that it is not published. I was hoping that this could be an additional repository to host your extension.

Information on publishing to open-vsx: https://github.com/eclipse/openvsx/wiki/Publishing-Extensions

Thank you

[SSL] Problems are shown at the wrong file

Screenshot

What's wrong on screenshot

Based on compiler output, error is in the header, but plugin points to a random spot in ssl file instead.

Code

compilertest.ssl

#include "compilertest.h"

procedure start begin
    display_msg("Hello world!!!");
end

compilertest.h

procedure ceil(variable v) begin
    return v
end

`variable` is not in the auto-complete list

Adding it to completion.fallout-ssl.json fixes it.

Code

var

.bgforge.yml is case sensitive for Fallout .msg vs .ssl files?

Screenshot

What's wrong on screenshot

It looks like the .msg file isn't recognized if its a different case, but for some reason changing the .ssl file to all lower case didn't fix the issue.
Where does bgforge look for the matching filename? and is it possible to configure it to be case insensitive?

Code

[WeiDU, baf]Syntax Highlighting should not use the same color for Symbolic Identifiers and Numerical Constants

See the attached screenshot for further details. Code snippet below.

IF
	!CheckSpellState(Myself,WIZARD_SHIELD)
THEN
	RESPONSE #100
		Spell(Myself,WIZARD_SHIELD)
END

NOTE: This issue doesn't seem to be related to a particular Color Theme, it occurs with all of them....

Add some Fallout-style defines for IE

I'm getting tired of having to comment magical constants manually all the time:

Not to mention, this is prone to errors. We could instead define those constants and use them in code:

The actual definition would be either in an external weidu lib - bunch of SET/SPRINT, or could be handled by a preprocessor.

[WeiDU] Vars should be properly highlighted in "*.tra" files

%vars% are not highlighted as such in tra files (tested with theme BGforge Monokai).

That is actually odd since they seem to be properly included (i.e. include: source.tp2.weidu#non-weidu-vars), so what is missing...?

Missing highlight for `WRITE_ASCIIL`

Screenshot

What's wrong on screenshot

Missing highlight for WRITE_ASCIIL

Code

  COPY ~%MOD_FOLDER%/cre/er_love1.cre~ ~override/er_love1.cre~
    SAY NAME1 @103
    SAY NAME2 @103
    WRITE_ASCII 0x2cc ~er_love1~ #8
    WRITE_ASCII 0x280 ~er_love1~ #32
    WRITE_ASCII 0x258 ~~ #8
    WRITE_ASCIIL 0x34 ~~ ~~

[WeiDU] Documentation does not show up

After the last update (v1.9.0), online documentation no longer shows up upon hovering mouse cursor over the various keywords...

Indicate field size somehow

It would be great to have some visual indicator of the field size for IElib constants, to know when to use READ_BYTE vs READ_SHORT, etc. Maybe not for all types, but at least for the common ones.

Some options:

1. Append a corresponding suffix (_b, _w, _dw, etc) in IElib itself. A bit clunky and the names are long already. But simple enough and works.
2. Indicate in the tooltip. Not as visible, and will require much larger rewrite of how IElib works.
3. Some scopes in Monokai are still unused. There's underlining, italic, etc. However, using those for constants would not be in line with other languages, and somewhat confusing because of that.
4. Make a custom Monokai fork and ship it with the extension and let users know to enable it. Not user-friendly, and likely a large maintenance burden.
5. Maybe Monokai supports some kind of customizaion/overrides? That way, it could be extended to support more scopes with different indicators.
6. Check if there are any other themes, (preferably Monokai-based), that allow distinguishing between different constant types.
7. Anything else?

Any option would require changes to IElib, though, because the information about type has to come from somewhere.

[WeiDU, .tra] Syntax Highlighting should highlight %variable% references appropriately

Unlike .tp2 files, %variable% references are not highlighted appropriately (i.e., you cannot distinguish them from the content of the string).

Version 2+ cannot compile SSL if the output path contains spaces

Hi, I installed the latest version and couldn't compile SSL file to a target path that contained space(s) in its name. For example C:\My Scripts

I had to downgrade to version 1.16.3 which works well with such paths.

Autocompletion should adjust itself after launching a PATCH/ACTION function

For example, it should suggest:

• INT_VAR
• RET
• STR_VAR
• opcode
• parameter1
• parameter2
• target
• duration
• timing
• resource
• special
• savingthrow
• savebonus
• power
• match_opcode
• header_type
• match_resist_dispel
• check_globals
• etc...........

Variables should be highlighted as such when containing "#" and/or "-" characters

Pretty much what the title states.

Test strings:

"%#var%"
"%var-var%"

Assuming Monokai as Color Theme, those strings should be highlighted in orange.

Error: ENOENT: no such file or directory, lstat 'C:\Users\ALIEN\AppData\Local\Programs\Microsoft VS Code Insiders\undefined'

Screenshot

What's wrong on screenshot

Code

onInitialize started
onInitialize completed
onInitialized started
{"code":"ERR_INVALID_ARG_TYPE"}
initializing translation
tra is not a directory, aborting tra load
initialized
reload filedata file:///e%3A/Gry-IE/BG2EE-SoS/SoSCre/lib/install-cre.tpa
node:fs:2538
      handleErrorFromBinding(ctx);
      ^

Error: ENOENT: no such file or directory, lstat 'C:\Users\ALIEN\AppData\Local\Programs\Microsoft VS Code Insiders\undefined'
    at Object.realpathSync (node:fs:2538:7)
    at Object.<anonymous> (node:electron/js2c/asar_bundle:2:4804)
    at ui (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:167:5422)
    at Ss.inWorkspace (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3646)
    at Ss.displayPath (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3710)
    at Ss.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:4672)
    at nc.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:223:3319)
    at c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:228:4638 {
  errno: -4058,
  syscall: 'lstat',
  code: 'ENOENT',
  path: 'C:\\Users\\ALIEN\\AppData\\Local\\Programs\\Microsoft VS Code Insiders\\undefined'
}
[Info  - 8:29:28 PM] Connection to server got closed. Server will restart.
true
onInitialize started
onInitialize completed
onInitialized started
{"code":"ERR_INVALID_ARG_TYPE"}
initializing translation
tra is not a directory, aborting tra load
initialized
reload filedata file:///e%3A/Gry-IE/BG2EE-SoS/SoSCre/lib/install-cre.tpa
node:fs:2538
      handleErrorFromBinding(ctx);
      ^

Error: ENOENT: no such file or directory, lstat 'C:\Users\ALIEN\AppData\Local\Programs\Microsoft VS Code Insiders\undefined'
    at Object.realpathSync (node:fs:2538:7)
    at Object.<anonymous> (node:electron/js2c/asar_bundle:2:4804)
    at ui (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:167:5422)
    at Ss.inWorkspace (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3646)
    at Ss.displayPath (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3710)
    at Ss.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:4672)
    at nc.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:223:3319)
    at c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:228:4638 {
  errno: -4058,
  syscall: 'lstat',
  code: 'ENOENT',
  path: 'C:\\Users\\ALIEN\\AppData\\Local\\Programs\\Microsoft VS Code Insiders\\undefined'
}
[Info  - 8:29:28 PM] Connection to server got closed. Server will restart.
true
onInitialize started
onInitialize completed
onInitialized started
{"code":"ERR_INVALID_ARG_TYPE"}
node:fs:2538
      handleErrorFromBinding(ctx);
      ^

Error: ENOENT: no such file or directory, lstat 'C:\Users\ALIEN\AppData\Local\Programs\Microsoft VS Code Insiders\undefined'
    at Object.realpathSync (node:fs:2538:7)
    at Object.<anonymous> (node:electron/js2c/asar_bundle:2:4804)
    at ui (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:167:5422)
    at Ss.inWorkspace (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3646)
    at Ss.displayPath (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3710)
    at Ss.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:4672)
    at nc.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:223:3319)
    at c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:228:4638 {
  errno: -4058,
  syscall: 'lstat',
  code: 'ENOENT',
  path: 'C:\\Users\\ALIEN\\AppData\\Local\\Programs\\Microsoft VS Code Insiders\\undefined'
}
initializing translation
tra is not a directory, aborting tra load
[Info  - 8:29:28 PM] Connection to server got closed. Server will restart.
true
onInitialize started
onInitialize completed
onInitialized started
{"code":"ERR_INVALID_ARG_TYPE"}
node:fs:2538
      handleErrorFromBinding(ctx);
      ^

Error: ENOENT: no such file or directory, lstat 'C:\Users\ALIEN\AppData\Local\Programs\Microsoft VS Code Insiders\undefined'
    at Object.realpathSync (node:fs:2538:7)
    at Object.<anonymous> (node:electron/js2c/asar_bundle:2:4804)
    at ui (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:167:5422)
    at Ss.inWorkspace (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3646)
    at Ss.displayPath (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3710)
    at Ss.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:4672)
    at nc.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:223:3319)
    at c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:228:4638 {
  errno: -4058,
  syscall: 'lstat',
  code: 'ENOENT',
  path: 'C:\\Users\\ALIEN\\AppData\\Local\\Programs\\Microsoft VS Code Insiders\\undefined'
}
initializing translation
tra is not a directory, aborting tra load
[Info  - 8:29:31 PM] Connection to server got closed. Server will restart.
true
onInitialize started
onInitialize completed
onInitialized started
{"code":"ERR_INVALID_ARG_TYPE"}
initializing translation
tra is not a directory, aborting tra load
initialized
reload filedata file:///e%3A/Gry-IE/BG2EE-SoS/SoSCre/lib/install-cre.tpa
node:fs:2538
      handleErrorFromBinding(ctx);
      ^

Error: ENOENT: no such file or directory, lstat 'C:\Users\ALIEN\AppData\Local\Programs\Microsoft VS Code Insiders\undefined'
    at Object.realpathSync (node:fs:2538:7)
    at Object.<anonymous> (node:electron/js2c/asar_bundle:2:4804)
    at ui (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:167:5422)
    at Ss.inWorkspace (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3646)
    at Ss.displayPath (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:3710)
    at Ss.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:220:4672)
    at nc.reloadFileData (c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:223:3319)
    at c:\Users\ALIEN\.vscode-insiders\extensions\bgforge.bgforge-mls-2.1.2\server\out\server.js:228:4638 {
  errno: -4058,
  syscall: 'lstat',
  code: 'ENOENT',
  path: 'C:\\Users\\ALIEN\\AppData\\Local\\Programs\\Microsoft VS Code Insiders\\undefined'
}
[Error - 8:29:32 PM] The BGforge MLS server crashed 5 times in the last 3 minutes. The server will not be restarted. See the output for more information.

[WeiDU] Syntax Highlighting should highlight %variable% references appropriately

When using the array construct, Syntax Highlighting should highlight %variable% references appropriately.

Example:
TEXT_SPRINT $patchITM(%spl%) ~%itm%~

VS Code console should not throw an error every time you write a trigger/action

OK, this is rather odd, but what can you tell me of this?

Object parameters should use a distinct color in .baf/.d files

If I write CheckSpellState(Myself,BERSERKER_RAGE), both the trigger and the object reference are highlighted with the same color.

It would be (much) better to have two distinct colors.........

"Detail" should not be missing

OK, latest version (v1.0.5) - I noticed that "detail" (from weidu.completion.yml) no longer shows up upon hovering over a specific tp2-action/flag/whatever.

For instance, if you hover over ACTION_IF, then you'll only see its documentation but not the following => ACTION_IF value THEN BEGIN TP2 Action list END [ ELSE BEGIN TP2 Action list END ]

Feature request

delete

[WeiDU, feature request]Add support for SSL/SLB files

@burner1024

Since we're speaking of BAF files, I must confess that I rarely use them – I prefer to code scripts in SSL, it's much more compact and versatile.

So, my question is: what do you think about adding support for this format?

Autocompletion: weidu built-in constants

Pretty much what the title states.
Autocompletion should suggest all the constants listed in section 15 (WeiDU constants) of the official documentation.

[highlighting] SSL 'call' colorizing incosistency

• procedure name is not colorized when using call proc(); syntax
  skipping () and using call proc; syntax works correctly
• procedure name is not colorized if there's at least 1 whitespace between name and (
  engine/sfall functions does not have that problem, and are colorized correctly

Both are edge cases; first probably overlooked as scripts i checked simply skip () - for me it's a muscle memory due to messing with C-like langs :} Second can be spotted only if someone wants to write pretty code and align arguments at same position when using block of procs with different names length; haven't seen anything like that in regular mods either.

[WeiDU, .ssl] Syntax Highlighting should highlight 'TargetBlock/TriggerBlock' names appropriately

Syntax Highlighting should be consistent when highlighting TargetBlock/TriggerBlock names that contain - // hyphen characters.

Example:

TargetBlock(PC-FIGHTER_ALLsInOrderShort&GOODCUTOFF-FIGHTER_ALLsInOrderShort)
TriggerBlock(PC-test)

[WeiDU] Syntax Highlighting should handle double variable references appropriately

As you can see, the outer %% are highlighted as if they were content of the string... You could use another color to distinguish the outer pair from the inner one....

[WeiDU, .tpa/tph] Syntax Highlighting should handle "-" characters and string delimiters appropriately

If you combine - characters and string delimiters " // or ~, then everything is messed up.

Example code:

DEFINE_ACTION_FUNCTION ~demi-shadow_monsters~
BEGIN
	ACTION_IF (VARIABLE_IS_SET ~WIZARD_DEMI_SHADOW_MONSTERS~) BEGIN

BGforge MLS v2.0.0 Server crashes when opening mod folder

Description

When opening a folder with a modification (in my case it is NTotSC), there is a VS Code notification about plugin's server crash.
Visual Studio Code version: 1.74.3

Console output

onInitialize started
workspace_root = c:\<path to mod>\NTotSC
onInitialize completed
onInitialized started
{"errno":-4058,"syscall":"open","code":"ENOENT","path":"c:\\<path to mod>\\NTotSC\\.bgforge.yml"}
initializing translation
tra is not a directory, aborting tra load
initialized
reload filedata file:///c%3A/<path to mod>/NTotSC/ntotsc/ntotsc.tp2
node:fs:2490
      handleErrorFromBinding(ctx);
      ^

Error: ENOENT: no such file or directory, lstat 'c:\c:'
    at Object.realpathSync (node:fs:2490:7)
    at Object.<anonymous> (node:electron/js2c/asar_bundle:5:4831)
    at li (c:\Users\<user>\.vscode\extensions\bgforge.bgforge-mls-2.0.0\server\out\server.js:167:5395)
    at ws.inWorkspace (c:\Users\<user>\.vscode\extensions\bgforge.bgforge-mls-2.0.0\server\out\server.js:220:3646)
    at ws.displayPath (c:\Users\<user>\.vscode\extensions\bgforge.bgforge-mls-2.0.0\server\out\server.js:220:3710)
    at ws.reloadFileData (c:\Users\<user>\.vscode\extensions\bgforge.bgforge-mls-2.0.0\server\out\server.js:220:4472)
    at Zo.reloadFileData (c:\Users\<user>\.vscode\extensions\bgforge.bgforge-mls-2.0.0\server\out\server.js:223:3109)
    at c:\Users\<user>\.vscode\extensions\bgforge.bgforge-mls-2.0.0\server\out\server.js:228:4643 {
  errno: -4058,
  syscall: 'lstat',
  code: 'ENOENT',
  path: 'c:\\c:'
}
[Error - 20:45:27] The BGforge MLS server crashed 5 times in the last 3 minutes. The server will not be restarted. See the output for more information.

color fallout defines

Need to add automatic colorization for sfall defines. Maybe RP, too.

Weird behavior when using "" or ~~

Let's consider the following example:

LAF DELETE_SCRIPT_BLOCK
STR_VAR
	script = ~GTSUM00~
	match = EVAL "RESPONSE #100[%WNL%%LNL%%MNL%]*END"
END

All the code that follows this line match = EVAL "RESPONSE #100[%WNL%%LNL%%MNL%]*END" is highlighted in yellow (as if a string delimiter is missing).

Why!?

Comments should be greyed out after launching a PATCH/ACTION function

For example:

// This comment is greyed out
LPF ADD_ITEM_EQEFFECT
INT_VAR
    opcode = 319    // This comment is not greyed out
     .........
END

[WeiDU, .slb] Syntax Highlighting should highlight TARGET/TRIGGER names appropriately

Syntax Highlighting should be consistent when highlighting TARGET/TRIGGER names that contain - characters.

Example:
TARGET=EVILCUTOFF-FIGHTER_ALLsInOrderShort

Steals c/c++ header file association

1. Observed behavior. When installed, it configures "*.h" files away from C/C++.
2. Expected behavior. It should not do that.

Add support for 2DA files

Pretty much what the title says.

I'd like to have .2da syntax highlighting (so that they don't look like plain text files). Something similar to what you've recently done with .tra files.

[Fallout] Errors in header files never go away from "Problems"

Screenshot

What's wrong on screenshot

Errors in header files never go away from "Problems"

Code

_mls_test.h:

#define cantdoit(1)

_mls_test.ssl:

#include "_mls_test.h"

procedure start begin
   display_msg("Hello");
end

Try compiling above SSL, you'll get error like on screenshot. Add space before (1) to fix the error, then recompile. Error stays.

Autocompletion: weidu built-in macro and functions

The following PATCH functions are missing:

• ADD_ITEM_EQEFFECT
• ADD_ITEM_EFFECT
• ADD_SPELL_EFFECT
• ADD_SPELL_CFEFFECT

Use parameters data from actual code when jsdoc is used

Screenshot

What's wrong on screenshot

• If you add jsdoc comment but omit some arguments, they disappear from the argument list in the hint.
• If you have default value in code itself, it is not reflected in the hint, you have to duplicate this information in the jsdoc

Code

/**
 * Adds one recipe item for a given crafted item, if it doesn't exist. If recipe is known, deletes the item.
 * 
 * @arg {int} schematicPid - PID of schematic item to create
 * @arg {int} probability - % probability of spawn, if conditions are met.
 */
procedure check_restock_craft_schematic(variable schematicPid, variable craftedItemPid, variable probability := 100) begin
end