Skip to content

Commit

Permalink
initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelhartung committed Apr 3, 2024
0 parents commit 304897f
Show file tree
Hide file tree
Showing 16 changed files with 4,557 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 6,
"sourceType": "module"
},
"plugins": [
"@typescript-eslint"
],
"rules": {
"@typescript-eslint/naming-convention": [
"warn",
{
"selector": "import",
"format": [ "camelCase", "PascalCase" ]
}
],
"@typescript-eslint/semi": "warn",
"curly": "warn",
"eqeqeq": "warn",
"no-throw-literal": "warn",
"semi": "off"
},
"ignorePatterns": [
"out",
"dist",
"**/*.d.ts"
]
}
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Mac
.DS_Store

# VSCode
.vscode

# NodeJS
dist/
node_modules

# vsce
*.vsix
5 changes: 5 additions & 0 deletions .vscode-test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { defineConfig } from '@vscode/test-cli';

export default defineConfig({
files: 'out/test/**/*.test.js',
});
14 changes: 14 additions & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.vscode/**
.vscode-test/**
out/**
node_modules/**
src/**
.gitignore
.yarnrc
webpack.config.js
vsc-extension-quickstart.md
**/tsconfig.json
**/.eslintrc.json
**/*.map
**/*.ts
**/.vscode-test.*
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Change Log

## 0.1.0

- Initial release
9 changes: 9 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
The MIT License (MIT)

Copyright © 2024 Michael Hartung

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# fmod-vscode-js

Is a [Visual Studio Code](https://code.visualstudio.com/) extension that allows
to execute javascript in a [FMOD Studio](https://fmod.com) project via the
[FMOD Scripting API](https://www.fmod.com/docs/2.01/studio/scripting-api-reference.html)
over TCP/IP.

## Installation

To install the extension download the `.vsix` file of latest release and install
it manually from a terminal using:

```
code --install-extension vscode-fmod-js-<version>.vsix
```

**Note:** For the time being I don't intend to distribute this extension via the
VSCode marketplace as I don't know what this entails in terms of costs.

## Usage

Running `FMOD: Attach` will attempt to attach to an open FMOD Studio project
using the `host` configured in the settings which defaults to `127.0.0.1`.

On success, an output window is opened for the open connection and a
notification is displayed (in case no notification is shown, check your
notication settings).

Running `FMOD: Run` or pressing `CTRL+Enter` will send the current text
buffer/file to the FMOD Studio project to execute.

If a text selection exists, only the selection is sent.

**Note**: The extension checks if the file language is set to `javascript` and
does not sent anything to FMOD if that's not the case.

The result will be displayed in the `FMOD JS` output window.

`FMOD: Detach` will close the remote connection.

![demo](./media/demo/vscode-fmod-js_demo.gif)

## Extension Settings

This extension contributes the following settings:

### `fmod-js.remote.host`

The host to connect to. Defaults to `localhost`.

**Note**: I have **not tested** remote connections on local networks, in *theory
should work*™.

## Contributing

This project welcomes contributions.

## License

This project is licensed under a [MIT license](https://mit-license.org/), see
[LICENSE.md](LICENSE.md).

Copyright of the FMOD icon belongs to Firelight Technologies Pty Ltd.
Binary file added media/demo/vscode-fmod-js_demo.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 media/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 304897f

Please sign in to comment.