157 lines
4.6 KiB (Stored with Git LFS)
Markdown
157 lines
4.6 KiB (Stored with Git LFS)
Markdown
# StreamDock Plugin SDK - 한국어 가이드
|
|
|
|
## 🚀 소개
|
|
|
|
Mirabox StreamDock 플러그인 개발을 위한 공식 SDK입니다. 이 저장소에는 다양한 프로그래밍 언어 템플릿과 완전한 개발 도구가 포함되어 있습니다.
|
|
|
|
## ✨ 주요 기능
|
|
|
|
- 📦 다중 언어 개발 템플릿
|
|
- 🛠️ 완전한 플러그인 개발 SDK
|
|
- 📚 포괄적인 문서
|
|
- 🔌 간소화된 플러그인 배포 프로세스
|
|
|
|
## 📂 개발 템플릿
|
|
|
|
이 저장소에는 다음 언어들의 플러그인 개발 템플릿이 포함되어 있습니다:
|
|
|
|
- **JavaScript** - 웹 기반 플러그인
|
|
- **Vue** - Vue.js 프레임워크 사용
|
|
- **Node.js** - 서버 사이드 로직
|
|
- **C++** - 고성능 네이티브 플러그인
|
|
- **Qt** - 크로스 플랫폼 GUI
|
|
- **Python** - 스크립팅 및 자동화
|
|
|
|
## 🔨 빠른 시작
|
|
|
|
### 1. 필수 요구사항 설치
|
|
|
|
#### Node.js 설치
|
|
```bash
|
|
# Node.js LTS 버전 다운로드
|
|
# https://nodejs.org/
|
|
```
|
|
|
|
#### 개발 도구 설치
|
|
- **Visual Studio Code**: https://code.visualstudio.com/
|
|
- **Git**: https://git-scm.com/
|
|
|
|
### 2. 프로젝트 설정
|
|
|
|
```bash
|
|
# 저장소 클론
|
|
git clone https://github.com/MiraboxSpace/StreamDock-Plugin-SDK.git
|
|
cd StreamDock-Plugin-SDK
|
|
|
|
# Node.js SDK 의존성 설치
|
|
cd SDNodeJsSDK/com.mirabox.streamdock.demo.sdPlugin
|
|
npm install
|
|
```
|
|
|
|
### 3. 첫 번째 플러그인 만들기
|
|
|
|
1. **샘플 플러그인 복사**
|
|
```bash
|
|
cp -r SDNodeJsSDK/com.mirabox.streamdock.demo.sdPlugin SDNodeJsSDK/my-first-plugin
|
|
```
|
|
|
|
2. **manifest.json 수정**
|
|
- 플러그인 이름, 설명, UUID 변경
|
|
- 액션 설정 수정
|
|
|
|
3. **플러그인 로직 작성**
|
|
- `plugin/index.js`에서 메인 로직 구현
|
|
- 이벤트 핸들러 추가
|
|
|
|
4. **설정 UI 개발**
|
|
- `propertyInspector/` 폴더에서 설정 인터페이스 구현
|
|
|
|
## 📁 프로젝트 구조
|
|
|
|
```
|
|
StreamDock-Plugin-SDK/
|
|
├── SDJavaScriptSDK/ # JavaScript 템플릿
|
|
├── SDNodeJsSDK/ # Node.js 템플릿
|
|
├── SDNodeJsSDKV2/ # Node.js v2 템플릿
|
|
├── SDPythonSDK/ # Python 템플릿
|
|
├── SDQtSDK/ # Qt 템플릿
|
|
├── SDVueSDK/ # Vue.js 템플릿
|
|
├── StreamDockCPPSDK/ # C++ 템플릿
|
|
├── 개발환경_설정_가이드.md # 개발환경 설정 가이드
|
|
├── 샘플_플러그인_개발_가이드.md # 샘플 플러그인 개발 가이드
|
|
└── README_한국어.md # 이 파일
|
|
```
|
|
|
|
## 🛠️ 개발 가이드
|
|
|
|
### 플러그인 구조
|
|
```
|
|
my-plugin/
|
|
├── manifest.json # 플러그인 메타데이터
|
|
├── plugin/ # 메인 플러그인 코드
|
|
│ └── index.js
|
|
├── propertyInspector/ # 설정 UI
|
|
│ └── action1/
|
|
│ ├── index.html
|
|
│ ├── index.js
|
|
│ └── index.css
|
|
├── static/ # 정적 파일 (이미지 등)
|
|
└── package.json # Node.js 의존성
|
|
```
|
|
|
|
### 주요 이벤트
|
|
- `_willAppear`: 버튼이 나타날 때
|
|
- `_willDisappear`: 버튼이 사라질 때
|
|
- `_keyDown`: 키패드 버튼 클릭
|
|
- `_keyUp`: 키패드 버튼 해제
|
|
- `dialRotate`: 다이얼 회전
|
|
- `dialDown`: 다이얼 누름
|
|
|
|
## 🚀 테스트 및 배포
|
|
|
|
### 로컬 테스트
|
|
1. StreamDock 소프트웨어 실행
|
|
2. 플러그인 폴더에 개발한 플러그인 지정
|
|
3. 플러그인 로드 및 테스트
|
|
|
|
### 디버깅
|
|
- 브라우저 개발자 도구 사용
|
|
- StreamDock 로그 확인
|
|
- console.log() 활용
|
|
|
|
### 배포
|
|
1. 플러그인 패키징
|
|
2. Space Platform에 업로드 (선택사항)
|
|
|
|
## 📚 참고 자료
|
|
|
|
- **공식 문서**: https://sdk.key123.vip
|
|
- **GitHub 저장소**: https://github.com/MiraboxSpace/StreamDock-Plugin-SDK
|
|
- **이메일 문의**: service@key123.vip
|
|
- **Discord 커뮤니티**: 공식 Discord 서버 참여
|
|
|
|
## 🤝 기여하기
|
|
|
|
커뮤니티 기여를 환영합니다!
|
|
|
|
1. 저장소 포크
|
|
2. 기능 브랜치 생성 (`git checkout -b feature/AmazingFeature`)
|
|
3. 변경사항 커밋 (`git commit -m 'Add some AmazingFeature'`)
|
|
4. 브랜치 푸시 (`git push origin feature/AmazingFeature`)
|
|
5. Pull Request 생성
|
|
|
|
## 📄 라이선스
|
|
|
|
이 프로젝트는 MIT 라이선스 하에 배포됩니다.
|
|
|
|
## 📮 연락처
|
|
|
|
- 📧 이메일: service@key123.vip
|
|
- 💡 이슈: GitHub Issues
|
|
- 🌐 문서: https://sdk.key123.vip
|
|
- 🏪 플러그인 마켓: Space Platform
|
|
- 💬 Discord: 커뮤니티 참여
|
|
|
|
---
|
|
|
|
StreamDock Plugin SDK를 사용해주셔서 감사합니다! 이 프로젝트가 도움이 되었다면 ⭐️를 눌러주세요! |