Noyebot

적당히 쓸만한 디코 봇

시작하기

준비물: node, npm
git clone https://github.com/codingnoye/noyebot으로 봇을 가져온다.
cd noyebot으로 디렉토리에 들어간다.
npm install로 node 의존성을 설치한다.
디코 개발자 포탈로 가서 봇을 만들고 토큰을 가져온다.
config.preview.js를 config.js로 복사하고 토큰을 넣는다.
봇을 디스코드 서버에 초대한다.
npm start로 봇을 실행한다.
기본적으로 discord.js를 사용했으므로 참고하자.

폴더 구조

cmds/ : 명령어 파일들이 들어 있음. 안에 파일 만들면 알아서 명령어에 추가됨. extension에 넣는 걸 권장, disabled에 넣어 비활성화
data/ : 데이터(배럴)가 저장되는 영역.
data/config.js : 설정 파일. 여기다 토큰을 넣어야 봇이 굴러감.
lib/ : 라이브러리 영역.
plugins/ : 플러그인 영역. 안에 파일 만들면 알아서 적용됨.
src/ : 소스 영역. 열어봤자 지저분한 코드밖에 없음.
index.js : 엔트리 포인트.

명령어 추가하기

echo.js를 보자.

module.exports = {
    func : (msg, guild, param) => {
        if (param.length != 0) {
            msg.channel.send(param)
        } else {
            msg.channel.send("인자를 입력해 주세요.")
        }
    },
    keyword : 'echo',
    help : '말을 따라합니다.'
}

규격에 맞춰 module.exports를 하나 내보내면 된다.
func (msg, guild, param) => {} : msg는 discord.js 의 msg객체를 그대로 전달해 주고, param은 명령어 뒷부분의 인자들을 텍스트로 그대로 입력한다. guild는 저장공간에 접근할 수 있도록 barrel 객체를 준다. barrel은 아래에서 더 설명함.
keyword는 호출 키워드이다.
help는 도움말이다.'
cmds/core/의 기본 명령어를 참고하자.

명령어는 파일로 넣으면 알아서 등록된다.
keyword와 help는 알아서 도움말에 등록된다.

barrel 객체

일종의 저장 가능한 JSON을 구현하기 위해 만든 클래스.

const barrel1 = new Barrel('파일이름')
// data/파일이름.json

와 같은 방법으로 배럴 객체를 생성할 수 있다. 이미 존재하는 파일이라면 불러오고, 아니라면 생성해서 불러온다. baekjoon 플러그인의 main.js를 보면 그를 확인할 수 있다.

barrel1.data // 배럴의 데이터 전체는 이곳에 담긴다. 저장하면 이 객체의 내용이 JSON.stringify 된다.
barrel1.save() // 배럴을 저장한다.
barrel1.data[msg.guild.id] // 데이터를 저장할 필요가 있는 확장을 만드려면 서버별로 데이터를 따로 저장하는 것이 좋을 것이다.
// 서버 설정은 서버별로 하나의 배럴을 가지는 식으로 구현되어 있음.
// 모든 배럴은 data/ 밑에 저장되어 있다.

일단은 이런 식으로 만들어 두긴 했는데, 플러그인의 권한 제한은 없으니 맘에 안 들면 알아서 짜면 된다.

플러그인

plugin/example/main.js를 보자.

const plugin = (bot) => {
    return {
        name: 'example',
        desc: '아무 기능이 없는 테스트 플러그인입니다.',
        load (container) {
            debug.log('example 플러그인 로드 완료', 2)
        },
        guildLoad (guild) {
            debug.log(`${guild.id} 서버 로드`)
        },
        message (msg) {
            debug.log(`${msg.content} 메시지 받음`)
        },
        command (msg, keyword, param) {
            if (keyword == "myecho") {
                msg.channel.send(param)
                return true
            }
            return false
        },
        help (msg) {
            msg.channel.send('example 플러그인의 도움말입니다.')
        },
        api: {
            
        }
    }
}
module.exports = plugin

bot 객체를 받으면 plugin 객체를 반환하는 형태로 구현한다.
아래의 요소만 채워서 module.exports 해주면 된다.
plugin/enabled.js에 플러그인 이름이 포함되어 있다면, plugin/플러그인이름/main.js를 불러온다.
name : 플러그인의 이름을 나타내는 문자열
desc : 플러그인의 설명
guildLoad : 서버가 로드되었을 때 작동하는 함수
message : 메시지를 받았을 때 작동하는 함수
command : 메시지 객체, 키워드, 인자를 넘겨받는 함수. true를 반환하면 이 플러그인에 해당 명령어가 있었다는 말이다. 기본 명령어와의 충돌을 고려해서 만든 영역이다.
help : 플러그인의 도움말을 보여주는 함수. embed를 사용하면 좋다.
api : 다른 플러그인에서 접근할 수 있는 객체. bot.apis.플러그인이름의 형태로 접근할 수 있다.
플러그인 폴더 내에서 무슨 짓을 해도 괜찮으니 API만 위 형식을 맞추면 된다.
plugins/를 참고하자.

기타

디스코드 코딩노예 #1483
PR 해주세요