🤠 FATALDRAW Profile Card

KOR

당신의 깃허브 활동 내역을 FATALDRAW식 현상수배 포스터 스타일의 픽셀 아트로 만들어주는 액션입니다.
커밋, 스타, PR 수에 따라 당신의 현상금(Bounty) 이 책정되고, 그에 맞는 위험 등급(Rank) 도장이 찍힙니다!

특징 (Features)

• 현상금 시스템: 활동량에 따라 현상금이 최대 $99,999,999까지 올라갑니다.

• 등급 시스템: 현상금 액수에 따라 S+ 부터 D 까지 등급이 매겨집니다.

• 빈티지 효과: 종이 질감과 잉크 번짐 효과가 자동으로 적용됩니다.

• 멀티 캐릭터: Juno와 Rosalyn 중 원하는 캐릭터를 선택할 수 있습니다.

캐릭터 종류

Juno	Rosalyn

Quick Start

복잡한 설정 없이 바로 적용해 보세요!

1단계: 워크플로우 파일 만들기

1. 본인의 리포지토리에서 .github/workflows 폴더로 이동합니다. (없으면 생성해주세요)
2. profile-card.yml 파일을 새로 만들고 아래 코드를 그대로 복사해 붙여넣습니다.

name: FATALDRAW Profile Card

on:
  schedule:
    - cron: '0 0 * * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    
    steps:
      - uses: actions/checkout@v3

      - name: Generate Wanted Poster
        uses: DevBawky/FATALDRAW_Github_Profile_Card@main
        with:
          username: ${{ github.repository_owner }}
          token: ${{ secrets.GITHUB_TOKEN }} # 비공개 커밋까지 합하려면 Configuration을 참고해주세요
          character: 'Juno' # Choose Character you want (Juno / Rosalyn)

      - name: Move to dist
        run: |
          mkdir -p dist
          mv stats.svg dist/

      - name: Push to Output Branch
        uses: crazy-max/ghaction-github-pages@v3
        with:
          target_branch: output
          build_dir: dist
          keep_history: true
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

2. 적용 확인

1. 파일을 Commit 합니다.
2. 리포지토리 상단 [Actions] 탭을 클릭합니다.
3. 왼쪽 메뉴에서 FATALDRAW Profile Card 를 클릭하고, 오른쪽 Run workflow 버튼을 눌러 수동으로 실행해줍니다.
4. 약 10초 후 초록색 체크가 뜨면 성공입니다!

3. 프로필(README.md)에 이미지 띄우기

이제 생성된 이미지를 본인의 프로필(README.md) 에 붙여넣으세요!
반드시 본인 아이디 와 리포지토리명 으로 src 를 수정해야 합니다!!

<div align="center">
  <a href="https://github.com/DevBawky/FATALDRAW_Github_Profile_Details.git">
      <img src="https://github.com/{YOUR_GITHUB_ID}/{YOUR_REPOSITORY_NAME}/raw/output/stats.svg" width="600" alt="FATALDRAW" />
  </a>
</div>

Configuration

캐릭터 변경 방법

profile-card.yml 에서 character 값을 변경하면 캐릭터가 바뀝니다!

    steps:
      - uses: actions/checkout@v3

      - name: Generate Wanted Poster
        uses: DevBawky/FATALDRAW_Github_Profile_Card@main
        with:
          username: ${{ github.repository_owner }}
          token: ${{ secrets.GITHUB_TOKEN }}
          character: 'Juno' # (Juno / Rosalyn)

Private 내역까지 포함하고 싶다면?

기본 설정 (secrets.GITHUB_TOKEN) 은 공개(Public) 리포지토리 의 활동만 집계합니다.
비공개 커밋까지 모두 합쳐서 "진짜 현상금"을 보고 싶다면 아래 단계를 따라하세요.

1. Personal access tokens (classic) 으로 이동하여
   Generate new token -> Generate new token(classic) 을 발급받습니다.
   (꼭 ghp_ 로 시작하는 키를 기억해두세요!)

2. 아래의 사진과 같이 권한을 체크해주세요.

3. 리포지토리 Settings -> Secrets and variables -> Actions 로 이동합니다.

4. New repository secret 을 누릅니다.

5. 이름을 GH_TOKEN 으로 하여 아까 저장해둔 ghp_xxxxx 로 시작하는 값을 붙여넣은 후 Add secret 버튼을 눌러 토큰을 저장합니다.

6. profile-card.yml 으로 이동하여 아래와 같이 코드를 수정합니다.

   with:
      username: ${{ github.repository_owner }}
      token: ${{ secrets.GH_TOKEN }} # GITHUB_TOKEN -> GH_TOKEN
      character: 'Juno'

FAQ

Q1. Error: Resource not accessible by integration 오류가 나요!

• 권한 문제입니다. 리포지토리 Settings -> Actions -> General 로 이동해서,
  Workflow permission 항목을 Read and write permissions 로 체크 후 저장해주세요!

Q2. 이미지가 깨져서 나와요!

• 액션이 아직 실행되지 않아 output 브랜치에 파일이 없는 상태입니다.
  Actions 탭에서 Run workflow 를 눌러 수 동으로 실행해주세요!

© Credits

• Art & Code: DevBawky
  
• Font: Press Start 2P (Google Fonts)

EN

This GitHub Action turns your GitHub activity into a FATALDRAW-style wanted poster rendered in pixel art.
Based on your commits, stars, and pull requests, your personal Bounty is calculated and stamped with a matching Danger Rank!

Features

• Bounty System: Your bounty increases with activity, up to $99,999,999.
• Rank System: Ranks are assigned from S+ down to D based on your bounty.
• Vintage Effect: Paper texture and ink-bleed effects are automatically applied.
• Multiple Characters: Choose your preferred character between Juno and Rosalyn.

Characters

Juno	Rosalyn

Quick Start

Get started instantly with minimal setup.

Step 1: Create the workflow file

1. Navigate to the .github/workflows directory in your repository (create it if it does not exist).
2. Create a new file named profile-card.yml and paste the following code.

name: FATALDRAW Profile Card

on:
  schedule:
    - cron: '0 0 * * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    
    steps:
      - uses: actions/checkout@v3

      - name: Generate Wanted Poster
        uses: DevBawky/FATALDRAW_Github_Profile_Card@main
        with:
          username: ${{ github.repository_owner }}
          token: ${{ secrets.GITHUB_TOKEN }} # See Configuration to include private activity
          character: 'Juno' # Choose Character you want (Juno / Rosalyn)

      - name: Move to dist
        run: |
          mkdir -p dist
          mv stats.svg dist/

      - name: Push to Output Branch
        uses: crazy-max/ghaction-github-pages@v3
        with:
          target_branch: output
          build_dir: dist
          keep_history: true
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Step 2: Run the workflow

1. Commit the file.
2. Open the [Actions] tab in your repository.
3. Select FATALDRAW Profile Card from the left menu.
4. Click the Run workflow button to execute it manually.
5. If you see a green checkmark after about 10 seconds, you are good to go!

Step 3: Display the image in your profile (README.md)

Now paste the generated image into your profile README.md
Make sure to replace the GitHub ID and Repository Name in the src attribute.

<div align="center">
  <a href="https://github.com/DevBawky/FATALDRAW_Github_Profile_Details.git">
      <img src="https://github.com/{YOUR_GITHUB_ID}/{YOUR_REPOSITORY_NAME}/raw/output/stats.svg" width="600" alt="FATALDRAW" />
  </a>
</div>

Configuration

Changing the character

You can switch characters by changing the character value in profile-card.yml!

    steps:
      - uses: actions/checkout@v3

      - name: Generate Wanted Poster
        uses: DevBawky/FATALDRAW_Github_Profile_Card@main
        with:
          username: ${{ github.repository_owner }}
          token: ${{ secrets.GITHUB_TOKEN }}
          character: 'Juno' # (Juno / Rosalyn)

Including private activity

By default, secrets.GITHUB_TOKEN only counts activity from public repositories.
If you want to include private commits and see your real bounty, follow the steps below.

1. Go to Personal access tokens (classic)
   Click Generate new token -> Generate new token (classic).
   (Make sure to save the token that starts with ghp_)

2. Enable the permissions as shown in the image below.

3. Navigate to your repository Settings -> Secrets and variables -> Actions.

4. Click New repository secret.

5. Set the name to GH_TOKEN, paste the saved token that starts with ghp_xxxxx,
   then click Add secret.

6. Open profile-card.yml and update it as shown below.

   with:
      username: ${{ github.repository_owner }}
      token: ${{ secrets.GH_TOKEN }} # GITHUB_TOKEN -> GH_TOKEN
      character: 'Juno'

FAQ

Q1. I get the error Error: Resource not accessible by integration

• This is a permission issue.
  Go to Repository Settings -> Actions -> General and set
  Workflow permissions to Read and write permissions, then save.

Q2. The image is broken or not showing up

• The Action has not been executed yet, so the file does not exist in the output branch.
  Go to the Actions tab and manually click Run workflow.

© Credits

• Art & Code: DevBawky
• Font: Press Start 2P (Google Fonts)