Giter Club home page Giter Club logo

kkutbot's Introduction

디스코드봇, 끝봇

koreanbots topgg GitHub python Codacy Badge DeepSource

소개

📔 끝말잇기 디스코드 봇 - 끝말잇기 게임을 디스코드에서 플레이하세요!

끝봇은 끝말잇기를 지원하는 디스코드 봇입니다.
끝봇의 접두사는 ㄲ이며, 빗금 명령어로도 사용하실 수 있습니다!

봇 초대하기

정보

  • 개발자: janu8ry, 관리자: 서진
  • 개발 언어: python 3.10.12 (discord.py 2.3.1)
  • 버전: 2.1.0
  • 데이터베이스: mongoDB 4.4
  • 크레딧: 끝봇 개발에 도움을 주신 서진님, 끝봇의 프로필 사진을 만들어주신 Tim232님께 감사드립니다!
  • 저작권: Icons made from www.flaticon.com

기여하기

이슈 등록이나 PR은 언제나 환영입니다!

건의사항

Issue 등록 또는 서포트 서버의 #건의사항 채널

버그제보

Issue 등록 또는 서포트 서버의 #버그제보 채널

버그를 해결하는 방법을 아시면 Pull Request 부탁드립니다!

다음 업데이트 TODO

  • 게임 모드 추가 (커스텀, 앞말잇기, 1:1 랭킹전)
  • 연승 시스템
  • 티어별 난이도 조정

봇 실행하기

끝봇의 코드를 직접 실행해보고 싶으시면, AGPL-3.0 라이선스를 꼭 지켜주세요.

요구사항

poetry 가상환경 사용 (기본)

git clone https://github.com/janu8ry/kkutbot.git
cd kkutbot
poetry install
nano config.yml # config.yml 수정
poetry shell
python3 main.py

pyenv 가상환경 사용 (추천)

pyenv install 3.10.12
pyenv virtualenv 3.10.12 kkutbot
git clone https://github.com/janu8ry/kkutbot.git
cd kkutbot
poetry config virtualenvs.create false --local
pyenv local kkutbot
poetry install
nano config.yml # config.yml 수정
python3 main.py

docker 사용 (배포시)

git clone https://github.com/janu8ry/kkutbot.git
cd kkutbot
nano config.yml # config.yml 수정
nano mongob.yml # mongob.yml 수정
nano .env # mongoDB 사용자 이름/암호, 데이터 저장 경로 수정
docker build -t kkutbot:latest .
docker compose up -d

로그 저장

매일 0시에 로그가 logs/yyyy-mm-dd.log.gz 형태로 압축되어 백업되고,
0시 5분에 config.yml에 지정한 백업용 디스코드 채널에도 공유됩니다.

DB 백업 (도커 전용)

매일 5시에 kkutbot 데이터베이스가 backup/yyyy-mm-dd.gz 형태로 압축되어 보관됩니다.
또한 5시 5분에 config.yml에 지정한 백업용 디스코드 채널에도 공유됩니다.

데이터 복구하기

docker exec -i kkutbot-mongo sh -c 'mongorestore --db kkutbot --gzip --archive --drop --authenticationDatabase admin -u username -p password' < /yyyy-mm-dd.gz

연락하기

개발자 디스코드: janu8ry
끝봇 이메일: [email protected]
discord

라이선스

AGPL-3.0

  • 사용자의 요청시 소스코드를 제공할 의무가 있습니다.
  • 어떤 목적으로, 어떤 형태로든 사용할 수 있지만 사용하거나 변경된 프로그램을 배포하는 경우 무조건 동일한 라이선스 즉, AGPL로 공개해야 합니다.

본 오픈소스 프로젝트를 사용하시려면 아래의 규칙을 따라주세요.

  • 봇 도움말 또는 정보 명령어와 레포지토리에 본 오픈소스를 사용했다는 사실을 명시
  • (선택) ⭐ 누르기

kkutbot's People

Contributors

codacy-badger avatar deepsource-autofix[bot] avatar deepsourcebot avatar janu8ry avatar motsuni04 avatar seojin200403 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

kkutbot's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.