예제
arisa_bot
Nazu로 만든 샘플 봇의 실행 방법과 코드 구조입니다.
arisa_bot은 Nazu로 만든 카카오톡 샘플 봇입니다. 명령어 응답, 미디어 전송, 카카오링크, 입장과 퇴장 같은 이벤트 처리가 한 프로젝트에 들어 있어서, 필요한 부분을 골라 가져다 쓸 수 있습니다.
실행하기
Node.js 24.11 이상과 실행 중인 Arisa 서버가 필요합니다. Arisa 준비는 시작하기를 참고하세요.
저장소를 내려받고 패키지를 설치합니다.
git clone https://github.com/huni-ee/arisa_bot
cd arisa_bot
npm installsrc/index.ts의 target을 Arisa 서버 주소로 바꿉니다. 기본값은 127.0.0.1:3000입니다.
const client = new ArisaClient({
target: '127.0.0.1:3000',
botName: 'Arisa',
dashboard: true,
});봇을 실행합니다. 코드를 고칠 때마다 자동으로 다시 실행하려면 npm run dev를 사용합니다.
npm start관리자 설정
봇을 실행한 뒤 대시보드(http://127.0.0.1:3001)에서 관리자를 추가합니다. 관리자와 차단 목록은 data/arisa.db에 저장됩니다.
명령어
명령어는 src/index.ts의 switch 문에서 나뉘며, 접두사는 !입니다.
| 명령어 | 동작 |
|---|---|
!ㅎㅇ | 보낸 사람의 이름을 넣어 인사합니다. |
!ping | pong!을 보내고 걸린 시간을 알려줍니다. |
!원답 | 답장으로 사용합니다. 답장을 거슬러 올라가 맨 처음 메세지를 보여줍니다. |
!윗메, !밑메 | 답장으로 사용합니다. 답장한 메세지의 이전 메세지와 다음 메세지를 보여줍니다. |
!가사찾기 가사 | 가사로 노래를 찾습니다. |
!노래가사 제목 | 노래 제목으로 가사를 보여줍니다. |
!멜론 검색어 | 검색한 곡을 멜론 카카오링크로 보냅니다. |
!사진 검색어 | 네이버 이미지 검색 결과를 보냅니다. |
!hh, !hhh | 사진 한 장, 사진 세 장을 보냅니다. |
!음성, !비디오 | 음성 파일과 동영상을 보냅니다. |
!프사, !프사링 | 답장으로 사용합니다. 답장한 메세지를 보낸 사람의 프로필 사진을 사진 또는 카카오링크로 보냅니다. |
다음 명령어는 관리자만 사용할 수 있습니다.
| 명령어 | 동작 |
|---|---|
!node 코드, !ev 코드 | 코드를 실행하고 결과를 보냅니다. |
!ban, !unban | 유저를 멘션하거나 메세지에 답장해서, 그 유저의 봇 사용을 막거나 다시 허용합니다. |
이벤트
메세지 외에 채팅방에서 일어나는 일에도 반응합니다.
| 이벤트 | 동작 |
|---|---|
message | 명령어에 응답하고, 동영상·음성·지도 메세지에 반응합니다. |
delete | 삭제된 메세지의 내용을 알려줍니다. |
edit | 수정 전과 수정 후 내용을 알려줍니다. |
hide | 방장이나 부방장이 메세지를 가리면 알려줍니다. |
join, invite | 입장과 초대를 알려줍니다. |
leave, kick | 퇴장과 강퇴를 알려줍니다. |
member_type_change | 부방장 임명과 해제, 방장 변경을 알려줍니다. |
open_profile_change | 오픈채팅 프로필 변경을 알려줍니다. |
feed | 피드 메세지를 받습니다. 기본으로는 아무 동작도 하지 않습니다. |
error | 이벤트 처리 중 생긴 오류를 콘솔에 출력합니다. |
코드 구조
arisa_bot/
├── src/
│ ├── index.ts # 클라이언트 생성, 명령어 분기, 이벤트 처리
│ ├── bots/ # 명령어별 기능
│ │ ├── lyrics.ts # 가사 검색
│ │ ├── melon.ts # 멜론 검색
│ │ ├── nodeeval.ts # 코드 실행
│ │ ├── photo.ts # 사진 검색
│ │ ├── reply.ts # 답장 처리
│ │ └── sendmedia.ts # 미디어 전송
│ └── helper/
│ └── bancontrol.ts # 차단 등록과 해제
└── res/ # 예제 사진과 음성 파일API 키
일부 명령어는 API 키가 필요합니다. .env.example을 .env로 복사한 뒤 값을 넣습니다.
| 변수 | 쓰는 곳 |
|---|---|
KAKAO_APP_KEY_1, KAKAO_ORIGIN_1 | !프사링의 카카오링크. Kakao Developers에서 발급받은 JavaScript 키와 웹 플랫폼 도메인입니다. |
NAVER_CLIENT_ID, NAVER_CLIENT_SECRET | !사진의 네이버 이미지 검색 |
카카오링크를 쓰지 않는다면 src/index.ts 맨 아래의 kakaoLink.init()과 melonKakaoLink.init()을 주석 처리합니다. 카카오링크를 여러 개 쓰는 방법과 네이버 검색 API 안내는 저장소 README를 참고하세요.