michael/scrypted
1
0
Fork 0
mirror of https://github.com/koush/scrypted.git synced 2026-02-03 06:03:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Koushik Dutta
2023-01-18 15:02:19 -08:00
committed by GitHub
parent 3dedabdc7a
commit f8e0ef42dd
1 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -51,20 +51,6 @@ Supported accessories:
## Development
## Debug the Scrypted Server in VSCode
```sh
# check out the code
git clone https://github.com/koush/scrypted
cd scrypted
# get the dependencies for the server and various plugins
./npm-install.sh
# open server project in VS Code
code server
```
You can now launch Scrypted in VSCode.
## Debug Scrypted Plugins in VSCode
```sh
@@ -87,7 +73,23 @@ If you do not want to set up VS Code, you can also run build and install the plu
npm run build && npm run scrypted-deploy 127.0.0.1
```
## Plugin Development
### Plugin SDK Documentation
Want to write your own plugin? Full documentation is available here: https://developer.scrypted.app
## Debug the Scrypted Server in VSCode
Debugging the server should not be necessary, as the server only provides the hosting and RPC mechanism for plugins. The following is for reference purpose. Most development can be done by debugging the plugin.
```sh
# check out the code
git clone https://github.com/koush/scrypted
cd scrypted
# get the dependencies for the server and various plugins
./npm-install.sh
# open server project in VS Code
code server
```
You can now launch the Scrypted Server in VSCode.