README.md
3.15 KB
Emon_Bot
About The Project
도라에몽처럼 각종 편의기능을 통합적(All-in-One)으로 서비스할 수 있는 디스코드 챗봇입니다.
현재 제공하고 있는 기능으로는 아래 세 가지가 있습니다.
이미지 텍스트 인식 (OCR)
언어번역
필기구 가격비교
Built With
Getting Started
aws EC2 사용해서 배포
Installation
- Clone the repo
git clone http://khuhub.khu.ac.kr/2017103984/emon_bot.git
- Install NPM packages
npm install
- 디스코드 회원가입
- Discord Developer Portal에 들어가서 New Application을 생성
- Application 생성 후 왼쪽에 보이는 사이드바에서 Bot을 눌러서 디스코드 봇 생성
- 디스코드 봇 생성 후 토큰 복사 (외부 유출 주의)
- 다시 왼쪽 사이드바에서 OAuth2를 눌러 들어간 후 SCOPES에서 bot을 체크
- 생성되는 주소로 이동해서 디스코드 봇을 본인의 서버로 초대
Usage
Command List
!도움말 - 봇에 대한 명령어 리스트들을 불러옵니다.
!도움말 <명령어> - <명령어>에 해당하는 명령어의 사용방법을 조회합니다.
!ocr <사용 언어> - 이미지를 첨부하고 <사용 언어>를 입력하면, 이미지에 있는 텍스트를 추출합니다.
!번역 <채팅> - <채팅>에 대한 번역결과를 보여줍니다.
!나라 - 봇이 띄워주는 버튼을 눌러서 번역할 언어(나라)를 선택합니다.
!문구 <채팅> - <채팅>에 대한 검색결과를 보여줍니다.-
사용 예시
도움말 명령어 실행화면
ocr 명령어 실행화면
번역, 나라 명령어 실행화면
문구 명령어 실행화면
Contributing
프로젝트에 기여하고 싶으신 분들은 아래 절차를 따라주시기 바랍니다.
- 프로젝트 fork
- feature branch 생성 (git checkout -b feature/name)
- commit (git commit -m "Add feature")
- push (git push origin feature/name)
- pull request 생성
License
MIT 라이센스 아래 사용 가능합니다. LICENSE.txt를 통해 자세한 정보를 확인하세요.
Contact
- 김연수: deathcat@khu.ac.kr
- 노영우: dndn1544@khu.ac.kr
박건희: wm5256@khu.ac.kr
Project Link: http://khuhub.khu.ac.kr/2017103984/emon_bot.git