1
0
Autopost/README.md
2023-11-24 09:17:06 +09:00

2.9 KiB

Misskey Autoposter

간단한 Misskey (또는 CherryPick!) 전용 자동 노트 봇

⚠️ 이 봇을 사용할 때에는 봇 친화적인 서버, 또는 개인 서버에서 사용하시는 것을 권장합니다.

버그가 있거나 도움이 필요하시다면 @ALPINE_SECTOR@phater.live로 알려주세요.

본 소스 코드의 수정 및 이용은 자유이나, 재배포 시애는 해당 리포지토리의 링크를 걸어주세요!

What

Google 스프레드시트를 기반으로 지정된 문구들을 자동적으로 노트로 작성합니다.

현재 이 소스 코드를 기반으로 작동하고 있는 봇을 여기에서 확인하실 수 있습니다!

Features

  • 최근 등장한 n개의 문구를 스킵할 수 있는 기능
  • @멘션 시 입력된 문구 정보와 함께 즉시 문구를 출력할 수 있는 기능

Options

.env.example 파일을 참조하여 .env 파일을 작성해주세요.

MISSKEY_TOKEN : 계정 액세스 토큰
MISSKEY_ORIGIN : 호스트 서버 이름 (misskey.io, phater.live...)
MAX_DUPLICATE_COUNT : 중복 시 출력되지 않게 할 간격
(3으로 설정 시 다음 3개의 문구가 나올 동안은 출력되지 않음)
WORKSHEET_URL : 문구를 불러올 스프레드시트 URL

How

Requirements

  • Git
  • Google Cloud Service Account
  • Ubuntu 20.04+ or Windows 10+
  • Python 3.10+
  • Google 스프레드시트 (예시 스프레드시트)
    • 예시에서 복사본을 생성하여 수정하세요. 양식이 맞지 않으면 오류가 발생합니다.

Clone source code

GitHub에서 소스 코드를 복사 후, 해당 디렉토리로 이동합니다.

> git clone https://github.com/Unstarrified/Autopost.git
> cd Autopost

Setup venv (Optional)

프로덕션 서버에서 작동하는 경우, 아래 명령어로 venv를 설정하시는 것을 권장합니다.

> python3 -m venv .venv
# Ubuntu의 경우 가상 환경을 불러오려면 이 명령어를 실행하세요.
> source ./.venv/bin/activate
# Windows의 경우 가상 환경을 불러오려면 이 명령어를 실행하세요.
> call ./.venv/Scripts/activate

Install dependencies

아래 명령어를 실행해 봇이 필요한 의존성 패키지를 설치합니다.

> pip install -r requirements.txt

Run

아래 명령어를 실행하면 봇이 동작하기 시작합니다.

> python3 main.py

끝입니다! 계속 실행되도록 하시려면 nohup이나 systemd 등을 사용해주세요.

Update

추후 봇 코드가 변경되어 업데이트가 필요한 경우, 아래 명령어를 실행하세요.

> git pull