/studyChatBot

2021학년도 2학기 OSS 프로젝트

Primary LanguageJavaScriptMIT LicenseMIT


Logo

Discord ChatBot for Study

디스코드 상에서 스터디 진행할 수 있는 툴
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

demo

핵심기능

  1. StopWatch 기능
  • 공부한 시간을 기록하고 어제보다 더 나은 오늘을, 오늘보다 더 나은 내일을 만들어 보아요!

  1. 공부시간 순위 확인
  • 스터디멤버들과 함께 경쟁하며 발전해보아요!

  1. D-day 기능
  • 중요한 이벤트를 기록하고 스터디멤버들과 공유해보아요!

  1. 음악 재생 기능
  • 같이 공부하는 스터디 멤버들과 한 공간에 함께 있는듯한 느낌을 가져보아요!

(back to top)

Built With

(back to top)

Getting Started

  • 이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 디스코드를 설치해 주신 후 다음의 과정을 진행해주시기 바랍니다.

Library Installation

  • npm install

API Installation

위의 두 API를 다운받으신 후에 config.json 파일에 입력해주어야합니다.

config.json
{
    "prefix": "~",  
    "token": "이곳에 디스코드 봇 API를 입력해주세요",
    "youtubeAPI": "이곳에 유튜브 API를 입력해주세요"
}

Usage

  • ~ping
    쿠옹이와 탁구를 칩니다.
  • ~현재시간
    현재시간을 알려줍니다.
  • ~공부시작
    공부 시작!
    스톱워치가 켜집니다.
  • ~공부끝
    공부 끝!
    스톱워치가 멈춥니다.
  • ~순위
    공부한 시간 순위를 알려줍니다.
  • ~디데이설정 ① ②
    디데이를 설정합니다.
    ① : 이벤트이름
    ② : 이벤트날짜 (mm/dd)
    ex) ~디데이설정 기말고사 12/15
  • ~디데이보기
    설정된 디데이를 보여줍니다.
  • ~디데이삭제 ①
    입력한 이벤트를 삭제합니다.
    ① : 이벤트이름
    ex) ~디데이삭제 기말고사
  • ~재생 ①
    ①을 재생합니다.
    ① : 노래제목
    (먼저 음성채널에 입장해야합니다)

(back to top)

Roadmap

  • Link Discord API
    • Implement Discord ChatBot through discord.js
  • Implement StopWatch
    • Implement StudyTime Ranking
  • Implement dDay
  • Link Youtube API
    • Implement Music Play Function in Discord Bot
  • Using AWS EC2
    • Amazon Cloud Server Hosting
    • Always run DiscordBot demo

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request.

Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

(back to top)