Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 2.33 KB

README.md

File metadata and controls

54 lines (38 loc) · 2.33 KB

ChaosRat은 OBS Studio와 같은 방송 소프트웨어에 사용할 수 있는 채팅 오버레이입니다.

주요 기능

  • 다중 플랫폼 지원
  • 스티커(디시콘) 기능 지원
  • 채팅 테마 지원
  • 채팅 필터링
    • 유저명, 메시지 내용을 정규표현식(RegExp)을 사용하여 필터링
  • 채팅 효과음
    • 새로운 채팅이 올라올 때마다 효과음을 재생
  • 채팅 명령어를 사용하여 빠른 설정 변경 가능
    • !!clear, !!클리어 명령어를 사용하여 채팅을 지울 수 있음
    • !!set theme video-master 등의 명령어로 설정을 실시간으로 변경할 수 있음
  • 개발자 친화적
    • Nuxt3를 사용하여 프론트엔드와 백엔드를 동시에 개발
    • 플랫폼, 스티커, 테마 등을 모듈화하여 쉽게 수정 및 추가
    • 도커(Docker)를 사용해 빠르게 개발 환경을 구축 및 배포

아래 기능은 아직 지원 예정이 없습니다. 추후 요청이 있을 경우 추가될 수 있습니다.

  • 플랫폼별 후원 메시지 표시

사용 방법

ChaosRat에 접속하여 간단한 설정을 통해 채팅 오버레이 URL을 생성할 수 있습니다.

생성한 URL을 OBS Studio의 브라우저 소스에 입력하여 사용하시면 됩니다.

개발

직접 서버를 호스팅하거나 개발하고 싶다면 다음과 같이 실행할 수 있습니다.

이 저장소를 클론한 후 다음 명령어를 실행하여 서버를 시작할 수 있습니다. 기본 주소는 http://localhost:3000입니다.

docker-compose up

트위치 연동을 위해서는 Twitch Developers에서 애플리케이션을 등록하고 클라이언트 ID와 클라이언트 시크릿을 발급받아야 합니다.

발급받은 클라이언트 ID와 클라이언트 시크릿을 docker-compose.yml 파일의 NUXT_TWITCH_CLIENT_IDNUXT_TWITCH_CLIENT_SECRET에 입력해주세요.

License

MIT License