Giter Club home page Giter Club logo

chaosrat's Introduction

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

chaosrat's People

Contributors

rishubil avatar

Stargazers

Hamoonrang avatar  avatar nezz avatar Bulhwi Cha avatar RaonMaru avatar

Watchers

 avatar

chaosrat's Issues

파비콘 추가

빨간색 쥐랑 치즈로 로고를 만들고 파비콘으로 지정하고 싶네요.

디시콘 출력 문제

디시콘 이름이 같고 뒤에 숫자가 붙는경우

숫자가 붙지 않은 디시콘만 출력되는 문제가 있네요

디시콘이 "~안녕 ~안녕1 ~안녕2" 가 있을 경우 "~안녕1 ~안녕2"를 입력해도

"~안녕" 디시콘만 출력되고 숫자는 텍스트로 표시됩니다

1234

커스텀용 테마 기능 추가

사용자가 직접 CSS를 지정하여 사용할 수 있도록 커스텀 테마 기능을 추가해야 합니다.

OBS등에서 사용자 지정 CSS를 지정할 수 있기 때문에, URL에 CSS를 직접 삽입할 필요는 없을 것 같지만,
메인 페이지에서 CSS 미리보기 가능한 기능 정도는 추가하면 좋을 것 같습니다.

사용 가이드 문서 추가

다음 내용을 포함하는 사용 가이드 문서 추가가 필요합니다.

  • 명령어 사용법
  • 숨길 유저명 등에서 정규표현식 사용법
  • 커스텀 효과음 제약사항
  • Open Dccon Selector에서 스티커 불러오기 조건

url 출력 이슈

  1. url 주소가 짤리는 현상

입력한 링크
url1

오버레이에 나오는 링크
url2

  1. 링크 대체 텍스트 기능 설정
    url 입력시 "[링크]" 로 출력

기능 건의

  1. 커스텀 테마
    텍스트 그림자 / 줄간격 등이 제한돼있는지 obs 사용자 지정 css로 적용이 안되는거 같네요

  2. 메세지당 표시 시간
    123123

  3. 이모티콘 크기 조절
    이모티콘 크기가 너무작아서 잘 안보이는거 같습니다

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.