ASCII Terminal Greeter

A simple and fun ASCII art greeter that displays a random ASCII art and welcome message every time you open your terminal.

한국어 사용법 보기 (Korean Usage Guide)

Screen.Recording.2025-06-27.at.1.53.35.PM.mov

Prerequisites

• Python 3.12 (tested) but will work in general with Python 3.6+
• Zsh or Bash shell
• UTF-8 terminal support
• Tested on:
  • macOS (ARM)
  • Ubuntu

Quick Start

git clone https://github.com/kyleok/dyu-ganadi-terminal.git
cd dyu-ganadi-terminal
sh install.sh
source ~/.zshrc  # or ~/.bashrc for Bash users

Note: If you encounter permission issues, run chmod +x install.sh first.
Alternative: Instead of the source command, you can simply close and reopen your terminal.

Features

• Random ASCII art display from text files
• Easy installation and uninstallation scripts
• Custom ASCII art support

Installation

1. Clone this repository:

   git clone https://github.com/kyleok/dyu-ganadi-terminal.git
   cd dyu-ganadi-terminal

2. Run the installation script:

   sh install.sh

   Note: If you encounter permission issues, first run: chmod +x install.sh

   This will:

   • Create ~/.ascii_greeter directory
   • Copy all necessary files there
   • Add the greeter to your shell's rc file (between #ASCII_START and #ASCII_END markers)

3. Source folder cleanup prompt: After installation, you'll be asked whether to delete the source folder:

   • Choose 'n' (No) if you plan to:
     • Contribute to the project
     • Modify or customize the code
     • Keep the repository for updates
     • Study the source code
   • Choose 'y' (Yes) if you:
     • Just want to use the greeter as-is
     • Don't need the source code anymore
     • Want to save disk space

   Note: The actual running version is installed in ~/.ascii_greeter, so deleting the source folder won't affect the greeter's functionality.

4. Restart your terminal or source your shell's rc file:

   # For Zsh
   source ~/.zshrc
   
   # For Bash
   source ~/.bashrc

   더 쉬운 방법: 위 명령어 대신 터미널을 완전히 종료하고 다시 열어도 됩니다.

Customization

Adding Your Own ASCII Art

You can add your own ASCII art by creating new .txt files in subdirectories within ~/.ascii_greeter/ascii_arts/:

1. Create new .txt files in subdirectories within ~/.ascii_greeter/ascii_arts/
2. Each file should contain a single ASCII art design
3. The greeter will automatically pick up any new files you add from subdirectories
4. Make sure your ASCII art files are saved with UTF-8 encoding

Generating ASCII Art

For creating your own ASCII art, you can use online tools like:

• Braille ASCII Art Generator - Convert images into braille-based ASCII art (the one used for sample art)
• Text to ASCII Art Generator (TAAG) - Convert text into ASCII art
• ASCII Art Generator - Convert images into ASCII art

When using these tools:

1. Generate your desired ASCII art
2. Save the output as a .txt file
3. Place the file in a subdirectory under ~/.ascii_greeter/ascii_arts/
4. Ensure the file is saved with UTF-8 encoding

Configuring ASCII Art Directories

You can enable or disable specific ASCII art subdirectories using the configuration utility via the ascii-config command:

# List all available ASCII art directories
ascii-config list

# Show current configuration status
ascii-config status

# Enable specific directories
ascii-config enable ganadi

# Disable specific directories
ascii-config disable ganadi

# Enable all directories (default)
ascii-config enable all

# Get help information
ascii-config help

Note: Editing files in the original repository directory won't affect the installed greeter. All customizations should be made in the ~/.ascii_greeter directory, as this is where the actual running version is located.

To modify the greeting message or behavior, edit ~/.ascii_greeter/ascii_greeter.py.

Uninstallation

The easiest way to uninstall is to use the provided uninstall script:

sh uninstall.sh

Note: If you encounter permission issues, first run: chmod +x uninstall.sh

This will:

• Remove the ASCII greeter section from your .zshrc and .bashrc files
• Delete the ~/.ascii_greeter directory
• Clean up everything automatically

Alternatively, you can manually:

1. Remove the ASCII greeter section from your rc files (between #ASCII_START and #ASCII_END)
2. Delete the installation directory: rm -rf ~/.ascii_greeter

License

This project is licensed under the MIT License - see the LICENSE file for details.

ASCII Art Attribution

The provided ASCII arts are based on @bdemgmr's artwork and we have received permission to use them. Special thanks to @bdemgmr for creating such beautiful art and allowing us to include it in this project!

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

기본 사용법 (Basic Usage in Korean)

📖 이 프로그램에 대해

터미널에서 만나는 가나디

🔧 필요한 것들

• Python 3.12 (테스트됨) 또는 Python 3.6 이상
• macOS 또는 Linux 운영체제
• 터미널 앱 (macOS의 기본 터미널 또는 Linux 터미널)

📥 설치 방법

1단계: 프로그램 다운로드

git clone https://github.com/kyleok/dyu-ganadi-terminal.git
cd dyu-ganadi-terminal

2단계: 설치 실행

sh install.sh

참고: 권한 문제가 발생하면 먼저 chmod +x install.sh를 실행하세요.

설치가 완료되면 소스 폴더 삭제 여부를 묻습니다:

• 'n' (아니오) 선택: 프로그램을 수정하거나 기여하고 싶은 경우
• 'y' (예) 선택: 그냥 사용만 하고 싶은 경우 (용량 절약)

3단계: 터미널 설정 새로고침

source ~/.zshrc   # Zsh 사용자 (macOS 기본)
source ~/.bashrc  # Bash 사용자 (Linux)

더 쉬운 방법: 위 명령어 대신 터미널을 완전히 종료하고 다시 열어도 됩니다.

🎨 사용자 정의하기

ASCII 아트 설정 관리:

ascii-config list      # 사용 가능한 아트 카테고리 보기
ascii-config status    # 현재 설정 상태 확인
ascii-config enable ganadi    # 특정 카테고리 활성화
ascii-config disable ganadi   # 특정 카테고리 비활성화
ascii-config enable all       # 모든 카테고리 활성화 (기본값)

나만의 ASCII 아트 추가:

1. ~/.ascii_greeter/custom_ascii/ 폴더에 .txt 파일 생성
2. 파일에 원하는 ASCII 아트 저장
3. 자동으로 랜덤하게 표시됩니다

🗑️ 제거 방법

sh uninstall.sh

참고: 권한 문제가 발생하면 먼저 chmod +x uninstall.sh를 실행하세요.

모든 설정과 파일이 자동으로 깨끗하게 제거됩니다.

❓ 문제 해결

• 터미널에 아무것도 나타나지 않는 경우: 터미널을 완전히 종료하고 다시 열어보세요
• 글자가 깨져 보이는 경우: 터미널 설정에서 UTF-8 인코딩이 활성화되어 있는지 확인하세요
• 설치 오류: Python이 올바르게 설치되어 있는지 확인하세요 (python3 --version 명령어로 확인)

💡 추가 정보

• 설치된 파일들은 ~/.ascii_greeter 폴더에 저장됩니다
• 터미널 설정 파일(.zshrc 또는 .bashrc)에 자동으로 추가됩니다
• 원본 소스 코드를 삭제해도 프로그램은 정상 작동합니다