Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/r-koubou/vscode-ksp

Visual Studio Code Extension for NI KONTAKT Script Processor (KSP)
https://github.com/r-koubou/vscode-ksp

computer-music kontakt ksp native-instruments

Last synced: 6 days ago
JSON representation

Visual Studio Code Extension for NI KONTAKT Script Processor (KSP)

Host: GitHub
URL: https://github.com/r-koubou/vscode-ksp
Owner: r-koubou
License: mit
Created: 2016-11-06T16:43:07.000Z (about 8 years ago)
Default Branch: main
Last Pushed: 2024-07-16T13:38:56.000Z (6 months ago)
Last Synced: 2024-07-16T20:10:44.075Z (6 months ago)
Topics: computer-music, kontakt, ksp, native-instruments
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=rkoubou.ksp
Size: 8.07 MB
Stars: 28
Watchers: 8
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.ja.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

[English is here](https://github.com/r-koubou/vscode-ksp/blob/master/README.md)

# Language support for NI KONTAKT(TM) Script Processor (KSP)

## KSP互換

- KONTAKT 7.x / 6.x / 5.x のKSPに対応しています

## 機能

* 文法解析後、スクリプトをクリップボードにコピー
* アウトラインビュー
* スクリプトのオブファスケートとオプティマイザ **(BETA)**
* シンタックスハイライト
* 補完入力
* スニペット
* ホバー表示
* 宣言箇所へのジャンプ
* スクリプト内のシンボル参照箇所の検索
* 文法解析機能
* リネーム機能

## 動作に必要なもの

* 文法解析機能
* Java 1.8 (or higher)

## 文法解析後、スクリプトをクリップボードにコピー

`F7` キーを押し、スクリプトの内容に問題がない場合、スクリプトをクリップボードにコピーします。

または、コマンドパレットからも実行できます。

![](https://github.com/r-koubou/vscode-ksp/raw/master/resources/readme/parse_cmd_ja.png)

* 文法解析機能が使用可能である必要があります。
* `Shift+F7` キーを押した場合、オブファスケータを実行します。

## 文法解析機能 (BETA)

* 文法解析
* 意味解析（論理チェック）
- 配列変数宣言時の要素数をチェック
- コマンドや、UI変数へ渡すパラメータのチェック
- 未使用の変数、ユーザー定義関数の検出

など

`初期設定ではこの機能はオフになっています。`
使用する際は、設定画面で設定を変えて下さい。
(Preferences->Settings内、"KONTAKT Script Processor (KSP)" )

## オブファスケート (BETA)

**ベータ版のため、動作保証外**

コマンドパレットから実行できます

### [実行方法]

1. スクリプファイルを開く
2. 言語モードを'ksp'に設定する
3. コマンドパレットを開き、'ksp' とタイプする
4. オブファスケーターを選択する

![](https://github.com/r-koubou/vscode-ksp/raw/master/resources/readme/obfuscate_01.gif)

またはエディタ内で右クリックで項目を選択

![](https://github.com/r-koubou/vscode-ksp/raw/master/resources/readme/obfuscate_ctx_ja.png)

### 詳細

* 定数、リテラルの展開

~~~
例：
[Before]
declare const $MAX := 100
declare $i
declare @s
$i := $MAX * 10
@a := "MAX is" & $MAX & ". $MAX is always 100"

[After]
declare $_geug
declare @_sxhd
$_geug := 1000
@_sxhd := "MAX is 100. $MAX is always 100"
~~~

* リネーム
- ユーザー定義の変数名
- ユーザー定義の関数名
* シュリンク
* どこからも使用されていない変数、関数

* ユーザー定義関数のインライン展開

初期設定ではオフにしています。もし試す場合はVSCodeの設定→ **"ksp.obfuscator.inline.function"** を編集して下さい。

### 文法解析機能について

* この機能を使用するには Java 1.8 以上が必要です。
* `[注意]パーサーは可能な限り多くのエラー検出を試みますが、記述されているスクリプトの文法がKSP仕様から逸脱していると、正しく機能しません。`

## TODO

* 適宜調整

## ソースコード

[githubリポジトリ](https://github.com/r-koubou/vscode-ksp)

### ライセンス

[MIT License](https://github.com/r-koubou/vscode-ksp/blob/master/LICENSE)

## KSP文法解析プログラムのソースコード

[githubリポジトリ](https://github.com/r-koubou/KSPSyntaxParser)

## 作成者

あーる

* Twitter: [@rkoubou_jp](https://twitter.com/rkoubou_jp)
* GitHub: [https://github.com/r-koubou/](https://github.com/r-koubou/)

## KONTAKT について

KONTAKT is registered trademarks of Native Instruments GmbH.

[https://www.native-instruments.com/](https://www.native-instruments.com/)