Skip to content

Commit

Permalink
Updated readme and release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
TwitchBronBron committed Jan 4, 2019
1 parent f425536 commit 3ad8902
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
15 changes: 9 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Change Log

## [1.5.0] - 2019-01-03
- Added ability to send remote control commands from the keyboard. See readme for more details.

## [1.4.2] - 2018-12-19
- Upgraded to roku-deploy version 1.0.0 which brings `glob-all` support for negating globs.

Expand All @@ -14,23 +17,23 @@
- Added find usage support for brs documents

## [1.3.2] - 2018-12-07
- Fixed bug that was preventing using `function Main` as an entry function.
- Fixed bug that was preventing using `function Main` as an entry function.

## [1.3.1] - 2018-12-05
- Fixed bug introduced in 1.3.0 that was preventing a debug session from starting due to incorrect "out" path.
- Fixed bug introduced in 1.3.0 that was preventing a debug session from starting due to incorrect "out" path.
- Upgraded to brightscript-formatter version 1.5.0 which brings support for overriding keywordCase for specific keywords.

## [1.3.0] - 2018-11-20
- Added support for declarations and symbols
- Added support for go to definition
- Added ability to format hightlighted code without formatting the whole document.
- Added ability to format hightlighted code without formatting the whole document.
- Added new launch setting called 'debugRootDir' that allows deploying a build file, while still debugging a source file.
- Added command for switching between xml and brs files for a component.
- Added command for switching between xml and brs files for a component.
- Added support for conditional statements without the `then`.
- Breakpoints added after a debug session is launched are now correctly show as disabled.

## [1.2.2] - 2018-09-26
- Upgraded to brightscript-formatter version 1.3.0 which brings support for formatting conditional compile statements.
- Upgraded to brightscript-formatter version 1.3.0 which brings support for formatting conditional compile statements.

## [1.2.1] - 2018-09-26
- Upgraded to roku-deploy v0.2.1 which removed some packages containing security vulnerabilities.
Expand All @@ -42,7 +45,7 @@
- Upgraded to the latest brightscript-formatter version that enables removing trailing whitespace when formatting.

## [1.0.1] - 2018-04-04
- Fixed issue in debugger that was not properly handling truncated file paths received from Roku.
- Fixed issue in debugger that was not properly handling truncated file paths received from Roku.

## [1.0.0] - 2018-03-16
- Added debugger support
Expand Down
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A VSCode extension to support Roku's BrightScript language.
- XML goto definition support which navigates to xml component, code behind function, or brs script import (F12)
- Method signature help (open bracket, or APPLE/Ctrl + SHIFT + SPACE)
- Brightscript output log (which is searchable and can be colorized with a plugin like this: [https://marketplace.visualstudio.com/items?itemName=IBM.output-colorizer](https://marketplace.visualstudio.com/items?itemName=IBM.output-colorizer)
- [Roku remote control from keyboard](#rokuRemote)
- [Roku remote control from keyboard](#Roku-Remote-Control)


## Requirements
Expand Down Expand Up @@ -133,12 +133,13 @@ This extension contributes the following settings:
* `brightscript.format.compositeKeywords`: specify whether composite words (ie: "endif", "endfor") should be broken apart into their two-word format (ie: "end if", "end for")
* `brightscript.format.removeTrailingWhiteSpace`: specify whether trailing whitespace should be removed on format

## <a name="rokuRemote"></a></a>Roku Remote Control
## Roku Remote Control

This extension contributes keybindings to send keypresses to the Roku device through Roku's [External Control API](https://sdkdocs.roku.com/display/sdkdoc/External+Control+API#ExternalControlAPI-KeypressKeyValues) using `extension.brightscript.sendRemoteCommand` and passing the key to send as the `args`.
You can use your keyboard as a Roku remote by clicking inside the Output or Debug Console panel of VSCode, and then pressing one of the predefined keyboard shortcuts from the table below. You can also press `win+k (or cmd+k on mac)` from inside those same panels to bring up a text box to send text to the Roku device.

The basic 12 remote keys are already mapped with this extension as defined below. The keys are mapped using the `when` clause so it will only send the remote commands if the Panel has focus (`panelFocus`) AND the focus in NOT in the Debug Console REPL (`!inDebugRepl`) AND the Editor Find widget is NOT visible (`!findWidgetVisible`).
This extension sends keypresses to the Roku device through Roku's [External Control API](https://sdkdocs.roku.com/display/sdkdoc/External+Control+API#ExternalControlAPI-KeypressKeyValues). The 12 standard Roku remote buttons are already included. The keys are mapped using the `when` clause so it will only send remote commands if the Output or Debug Console Panel has focus (`panelFocus`) AND the Editor Find widget is NOT visible (`!findWidgetVisible`).

Here are the commands included in this extension:

|Keyboard Key | Roku Remote Key | Keybinging Command|
|--|--|--|
Expand All @@ -155,17 +156,14 @@ The basic 12 remote keys are already mapped with this extension as defined below
|`win+right` (or `cmd+right` on mac) | Fwd Button | `extension.brightscript.pressFwdButton` |
|`win+8` (or `cmd+8` on mac) | Info Button | `extension.brightscript.pressStarButton` |


You can also press `win+k (or cmd+k on mac)` when the focus in in the Output Console and that will bring up a text input box to send text to the Roku device.

Example Keybindings for other keys:
You also have the ability to create keybindings for any other Roku supported key by adding. Here's a example entry for `keybindings.json` of how to create a VSCode keyboard shortcut to send the space key to the Roku:
```
{
"key": "Space",
"command": "extension.brightscript.sendRemoteCommand",
"args": "Lit_%20",
"when": "panelFocus && !inDebugRepl && !findWidgetVisible"
},
}
```

## Contributing
Expand Down

0 comments on commit 3ad8902

Please sign in to comment.