Cacophony 는 기존 자바진영의 Major Discord API 클라이언트인 JDA 를 기반으로 개발된 Discord API Client Library 입니다.
기존 JDA 및 여타 Java DiscordAPI Client 들의 문제점을 해결함과 동시에 패셔너블하고 편리한 디스코드 봇 개발 을 목표로 개발하였습니다.
Cacophony Library 는 JDA 와 마찬가지로, 디스코드의 공식 문서에 의거하여 DiscordAPI 에서 지원중단된 API endpoint 나 프로토콜의 지원이 불가합니다.
자세한 내용은 Discord 문서 를 참고해주세요
💡 라이브러리 의존성 관리에 관한 내용은 Download 를 참고해주세요!
일반 자바 환경에서 당연히 Cacophony Library 를 사용하실 수 있습니다!
CacophonyVanilla.start("봇 토큰");
- 카코포니에서 필요한 데이터들을 초기화하기위한 메서드입니다.
- bot token 을 인자로 받아 JDA 클라이언트를 초기화합니다
CacophonyVanilla.getJda();
- 카코포니에서 빌드되어 사용중인 JDA 를 가져올 수 있습니다.
- 반드시 CacophonyVanilla.start(..) 메서드 호출 이후 사용해주세요!
- 아직 카코포니에서 지원하지 않는 기능들을 JDA 클라이언트를 가져와 수동으로 구현할 수 있습니다.
example
public class CacophonySpringBootApplication {
public static void main(String[] args) {
CacophonyVanilla.start("TOKEN");
...
}
...
}SpringBoot 환경에서도 쉽게 Cacophony Library 를 사용하실 수 있습니다!
@UseCacophony
- SpringBoot 에서 Cacophony Library 를 사용하기위해 명시해야하는 Annotation 입니다.
@SpringBootApplication어노테이션이 붙는 Main Class 에 명시하면 됩니다
application.properties
- Cacophony 에서 JDA 를 Build 할때 사용할 bot token 을 명시해야합니다
cacophony.token = "봇 토큰"으로 설정하실 수 있습니다.- 만약 직접 JDA Bean 을 SpringBoot 에 등록하였을 경우, 작성하지 않으셔도 무방합니다.
- 봇 토큰에 대한 자세한 내용은 다음 문서 를 참고해주세요
example
@SpringBootApplication
@UseCacophony
public class CacophonySpringBootApplication {
...
}cacophony.token = Iy3kO6Wc5NDOT3TIc85IFDYx.McRJEw.FB3sezTy2F6KJ7DMjb40q7EWCJg카코포니 라이브러리는 기본적으로 Entry -> Action 형태의 Flow 묶음으로 이루어져 있습니다
Flow 의 구성요소
- Entry : Action 을 실행할 조건을 검사하는 블록
- Action : 봇에서 실행할 행동을 담은 블록
Flow 구조
- Cacophony 에 있는 특정한 Event 가 발생했을 때 (Entry) 다음 로직을 실행한다 (Action)
- 예를들어, 유저의 채팅이 감지되면(Entry), 채팅 내용을 log 에 출력한다(Action)
다음과 같은 Flow 를 모은 형태로 봇이 개발되게 됩니다
진입지점 메서드를 통해 더욱 간단하게 Flow 를 생성할 수 있습니다
//Example001
when( //EntryBlock 을 설정하는 진입지점(EntryPoint = when)
onChat().and().onJoin() //채팅이벤트나 입장이벤트가 발생했을경우 (EntryPoint = onChat)
).doSomething( //ActionBlock 을 설정하는 메서드
//람다를 통해 Action 을 구현한다
event -> System.out.println(
event.getClass().getSimpleName() + " 가 발생하였습니다!"
)
).complete(); //완성된 Flow 를 디스코드 봇에 등록한다
//Example002
when( //EntryBlock 을 설정하는 진입지점(EntryPoint = when)
onJoin() //입장이벤트가 발생했을경우 (EntryPoint = onJoin)
).doSomething( //ActionBlock 을 설정하는 메서드
//람다를 통해 Action 을 구현한다
event -> System.out.println(
event.getClass().getSimpleName() + " 가 발생하였습니다!"
)
).complete(); //완성된 Flow 를 디스코드 봇에 등록한다이곳 에서 더 많은 예제들을 확인하세요!
진입지점은 Flow 나 Block 등을 더욱 편리하게 생성할 수 있도록 구성된 static method 입니다.
진입지점 method 로는 when(), onChat(), onReact() 등이 있습니다
자세한 내용은 위키 에서 확인해주세요!
💡 Entry 와 EntryPoint(진입지점) 은 "완전히 다른 개념" 입니다!!
헷갈리지 않도록 주의해주세요!
Cacophony Library 는 MavenCentral 에 등록되어있습니다!
현재 VERSION 을 참고하여 다음과 같은 방법으로 다운로드하시면 됩니다.
repositories {
mavenCentral()
}
dependencies {
//gradle 버전이 낮은경우, 'implementation' 을 'compile' 로 바꾸어주세요!
//SpringBoot 에서 사용시
implementation 'io.github.key-del-jeeinho:cacophony-spring-boot-starter:VERSION'
//VanillaJava 에서 사용시
implementation 'io.github.key-del-jeeinho:cacophony-lib:VERSION'
}<!--SpringBoot 에서 사용시-->
<dependency>
<groupId>io.github.key-del-jeeinho</groupId>
<artifactId>cacophony-spring-boot-starter</artifactId>
<version>VERSION</version>
</dependency>
<!--VanillaJava 에서 사용시-->
<dependency>
<groupId>io.github.key-del-jeeinho</groupId>
<artifactId>cacophony-lib</artifactId>
<version>VERSION</version>
</dependency>이곳 에서 이슈를 작성하여 문의하시거나, 디스코드 JeeInho#8790 혹은 이메일 velocia.developer@gmail.com 으로 문의해주세요!
💡 이메일 문의시 답변까지 많은 시간이 소요될 수 있습니다. 되도록이면 Github Issue 나 Discord 를 통해 문의해주세요!
이곳 에서 Cacophony 에 대한 자세한 정보들을 확인하실 수 있습니다!
Copyright 2021. JeeInho All pictures cannot be copied without permission.