OBS Chzzk Extension

NAVER Chzzk OBS Studio Extension

한국어 | 日本語 | 繁體中文

Preview

Pre-requirements

• (Recommended / Tested) OBS Studio - 32.1.1 or higher
• (Recommended / Tested) Rust Compiler - 1.94.1
• (Recommended) Linux - Debian 13 / Ubuntu 24.04 LTS / Fedora 43 / etc... more recent distribution
• Qt 6 development packages with pkg-config support
  • Debian / Ubuntu: qt6-base-dev
  • Fedora: qt6-qtbase-devel

Build Notes

• This project now builds against Qt 6 only.
• The OBS Studio binary and this plugin should use the same Qt major version at runtime.

Installation

# Clone the repository
git clone https://github.com/zeroday0619/obs-chzzk-extension.git
cd obs-chzzk-extension

# Build the OBS Chzzk Extension
make release

# Install the OBS Chzzk Extension
sudo cp target/release/libobs_chzzk_extension.so /usr/lib/x86_64-linux-gnu/obs-plugins/

Debian Packaging

• Debian packaging files are stored in debian/.
• Packaging helper scripts are stored in scripts/.
• A Debian packaging container is provided in docker/debian-package/.
• GitHub Actions workflow .github/workflows/build-and-package.yml builds the release plugin and Debian packages on pushes, pull requests, tags, and manual runs.
• The workflow uploads libobs_chzzk_extension.so and Debian packaging artifacts as workflow artifacts.

# Generate debian/changelog from git commits
scripts/generate-debian-changelog.sh --since-ref <git-tag-or-commit>

# Build Debian packages
scripts/build-deb.sh --generate-changelog --since-ref <git-tag-or-commit> --clean

# Build Debian packages and collect them in ./dist
scripts/build-deb.sh --generate-changelog --since-ref <git-tag-or-commit> --clean --artifacts-dir dist

• scripts/generate-debian-changelog.sh reads git commit subjects and writes a Debian-style changelog entry.
• scripts/build-deb.sh wraps dpkg-buildpackage and can regenerate the changelog before building.
• Generated package artifacts such as .deb, .buildinfo, and .changes are written to the parent directory of the repository by default.
• Use --artifacts-dir <dir> to copy generated artifacts into a directory inside the repository, which is especially useful in Docker.

Build In Docker

# Build the packaging image
docker build -f docker/debian-package/Dockerfile -t obs-chzzk-extension-deb .

# Build Debian packages inside the container
docker run --rm \
  -v "$PWD":/work \
  -w /work \
  obs-chzzk-extension-deb \
  scripts/build-deb.sh --clean --artifacts-dir dist

# Example: regenerate changelog before building
docker run --rm \
  -v "$PWD":/work \
  -w /work \
  obs-chzzk-extension-deb \
  scripts/build-deb.sh --generate-changelog --since-ref <git-tag-or-commit> --clean --artifacts-dir dist

• The container installs the Debian packaging toolchain, Rust, and Qt 6 build dependencies.
• The container installs Rust 1.94.1 via rustup, matching the recommended toolchain for this project.
• With --artifacts-dir dist, copied package artifacts will be available in ./dist on the host after the container exits.

Version Management

Use scripts/bump-version.sh to update the project version and Debian package version together.

• Updates [package] version in Cargo.toml.
• Updates the package version in the first line of debian/changelog.
• Use --dry-run to preview changes without modifying files.

# Bump patch version (e.g. 0.1.0 -> 0.1.1, Debian: 0.1.1-1)
scripts/bump-version.sh --bump patch

# Set project version explicitly (Debian revision defaults to -1)
scripts/bump-version.sh --version 0.2.0

# Set project version and Debian revision
scripts/bump-version.sh --version 1.0.0 --debian-revision 2

# Set Debian package version explicitly
scripts/bump-version.sh --version 1.0.0 --debian-version 1.0.0-3

# Preview changes without modifying files
scripts/bump-version.sh --dry-run --bump patch

Usage

1. Open OBS Studio.
2. Go to Tools > OBS Chzzk Extension Settings.
   • How to Generate a Chzzk Client ID and Secret
     1. Chzzk Developers > 내 서비스 > 애플리케이션 등록
     2. Set 애플리케이션 ID and 애플리케이션 이름
     3. Set Redirect URI to http://127.0.0.1:20132/callback
     4. Set API Scope to 채널 정보 조회, 채널 관리자 조회, 채팅 메시지 조회, 채팅 메시지 쓰기, 채팅 공지 쓰기, 채팅 설정 조회, 채팅 설정 변경, 후원 조회, 방송 설정 조회, 방송 설정 변경, 활동제한 조회, 활동제한 쓰기, 구독 조회, 유저 조회, 방송 스트림키 조회
     5. Click 등록 to create the application and obtain the Client ID and Client Secret.
   • How to Generate a Discord Application ID
     1. Discord Developer Portal > New Application
     2. Set Name and click Create
     3. Go to Rich Presence > Enable Rich Presence
     4. Click Save Changes to apply the settings and obtain the Application ID.
3. Configure the settings as needed.
4. Click Ok to apply the settings.
5. Go to Docks > CHZZK Live Editor to edit live title/category/tags.

Features

Implemented

• Discord Rich Presence Integration
• Edit Live Stream Information (Title / Category / Tags / Thumbnail Preview / Sort)
• Automatic CHZZK Stream Key Setup

Contributing

Contributions are welcome!

Please feel free to submit a pull request or open an issue for any improvements or bug fixes.

Why does the OBS Chzzk Extension only support Linux?

There’s no particular reason. It’s simply because I primarily use Linux distributions. I want this project to work on all platforms, and that is the direction of this project. Therefore, if contributions related to cross-platform support are submitted, I intend to review and approve them very positively.

License

This project is licensed under the MIT License - see the LICENSE file for details.

AI-Generated Code Notice

Parts of this project were created with assistance from AI tools (e.g. large language models). All AI-assisted contributions were reviewed and adapted by maintainers before inclusion. If you need provenance for specific changes, please refer to the Git history and commit messages.