Beepy is a product manufactured by SQFMI. This repository offers a custom tmux configuration tailored for Beepy.

This configuration allows tmux to start automatically upon system launch and displays the system status via neofetch before the prompt.

Ensure you've installed the necessary screen and keyboard drivers. Instructions can be found on the official documentation

1. Install Tmux and Neofetch

   $ sudo apt install tmux neofetch

2. Clone Fbterm Repository

   $ git clone https://github.com/onokatio/fbterm2.git

3. Install Essential Fonts

   $ sudo apt install xfonts-wqy fonts-terminus-otb fonts-dotgothic16

Follow the steps to customize the neofetch output:

1. Download SQFMI duck ascii file to your directory

   $ mkdir -p ~/.config/neofetch/
   $ wget https://raw.githubusercontent.com/youngoris/beepy-tmux/main/neofetch/sqfmi-duck-w24.ascii -O ~/.config/neofetch/sqfmi-duck-w24.ascii

2. Edit config.conf under the ~/.config/neofetch/ directory

   $ nano ~/.config/neofetch/config.conf

3. Replace the function print_info() with the following code:

   print_info() {
       prin "------------------- "
       prin "BEEPY made by SQFMI "
       info underline
       
       info "OS" distro
       info "Host" model
       info "Kernel" kernel
       info "Uptime" uptime
       info "Packages" packages
       # info "Shell" shell
       info "Resolution" resolution
       info "DE" de
       info "WM" wm
       info "WM Theme" wm_theme
       info "Theme" theme
       info "Icons" icons
       info "Terminal" term
       info "Terminal Font" term_font
       info "CPU" cpu
       # info "GPU" gpu
       info "Memory" memory
   
       # info "GPU Driver" gpu_driver  # Linux/macOS only
       # info "CPU Usage" cpu_usage
       info "Disk" disk
       # info "Battery" battery
       # info "Font" font
       # info "Song" song
       # [[ "$player" ]] && prin "Music Player" "$player"
       # info "Local IP" local_ip
       # info "Public IP" public_ip
       # info "Users" users
       # info "Locale" locale  # This only works on glibc systems.
       info col
   }

   *The uncomment info should not exceed 12 lines, otherwise the beepy will not display a complete duck ascii image.

4. Change image_source value with our duck ASCII file's path, and replace YOUR_NAME with your username.

   image_source="/home/YOUR_NAME/.config/neofetch/sqfmi-duck-w24.ascii"

5. Give more screen space to system information text, toggle off color blocks, and change the gap value to 2 or 1.

   color_blocks="off"
   gap=2

6. Other useful changes

   memory_percent="on"
   disk_percent="on"
   

7. Finnaly, run neofetch you will see our duck appears on your screen.

   $ neofetch
   

Follow these steps to configure tmux:

1. Edit the Configuration File

   nano ~/.tmux.conf

2. Add battery percent and CPU temperature information to the right of the Tmux status bar, and the session number to the left.

   set -g status-left "[#S] "
   set-option -g  status-right "#(cat /sys/firmware/beepy/battery_percent)% #(vcgencmd measure_temp | cut -c6-9|awk '{print int($1)}')C %H:%M %a %d/%b"

3. Set status bar refresh frequency to 30s

   set -g status-interval 30

4. Set keybinds

   bind-key b send-keys C-b
   bind-key C-b last-window
   bind-key \" choose-tree 
   bind-key r source-file ~/.tmux.conf \; display-message "~/.tmux.conf reloaded"

5. If you already running tmux, press the blackberry button + r to reload the configuration. If not, run Tmux in the terminal, you'll see the battery and cpu info appear on the status bar.

   $ tmux

1. Edit the Configuration File

   $ cd fbterm2
   $ nano ./src/fbdev.cpp  

   replace /dev/fb0 with /dev/fb1.

2. Execute the below to compile and install fbterm.

   $ sudo apt-get install libfontconfig1-dev
   $ cd ~/fbterm2
   $ ./configure && make && sudo make install

3. Make sure you execute the below so fbterm can be run by non-root user and can capture shortcut keys

   $ sudo gpasswd -a YOUR_USERNAME video
   $ sudo setcap 'cap_sys_tty_config+ep' /usr/local/bin/fbterm

4. Run fbterm once to create the default fbterm configuration file that we need to edit.

   $ fbterm

   stdin isn't a interactive tty! Ignore this output, it doesn't matter.

   change the following

   font-names=Terminus,WenQuanYi Bitmap Song,DotGothic16
   font-size=14
   font-width=8
   font-height=16
   text-encodings=utf-8
   term=xterm-mono

5. To autostart at system launch, add the following code to your shell configure file

   $ nano ~/.bashrc

   if [ -z "$SSH_CONNECTION" ]; then
    # if in virtual terminal, start fbterm
      if [[ "$(tty)" =~ /dev/tty ]] && type fbterm > /dev/null 2>&1; then
           fbterm 
     # otherwise, start/attach to tmux and start neofetch
      elif [ -z "$TMUX" ] && type tmux >/dev/null 2>&1; then
           tmux new -As "$(basename $(tty))" 'neofetch; bash'
      fi
   fi

6. Solving double prompts issue when quitting tmux with prefix key + d

   $ nano ~/bashrc
   

   Find PS1 setting under the line xterm*|rxvt*):

   PS1="\[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a\]$PS1"
   

   replace it with:

   PS1="\[\e]0\a\]$PS1"
   

All done, now enjoy your beepy!

If you wish to use input methods, you can install and configure fcitx:

1. Install Fcitx

   $ sudo apt install fcitx-frontend-fbterm
   

2. Run fcitx-config-gtk3 under Xorg to enable IMEs or go to ~/.config/fcitx and edit profile (example below enables google pinyin)

   EnabledIMList=fcitx-keyboard-us:True,googlepinyin:True,pinyin:False
   

3. Uncomment and change the following in ~/.fbtermrc,

   input-method=fcitx-fbterm
   

4. Make fcitx start at system launch.

   Create a script to check if fcitx is running in each time we create a new terminal.

   $ nano ~/fcitx-start-check.sh

   fill with the following

   #!/bin/bash
   if ! pgrep -x "fcitx" > /dev/null; then
       echo "fcitx is not running. Starting fcitx..."
       nohup fcitx > /dev/null 2>&1 &
       sleep 1  # wait fcitx to start
   fi
   exit

   make this file executable with the following code

   sudo chmod +x ~/fcitx-start-check.sh
   

   add the below code to your tmux.conf

   #Start fcitx 
   new-session -d -s default "~/fcitx-start-check.sh"
   

5. Reboot to your Tmux terminal, press ctrl(answer call) + space, you will activate the input method( For example: Google Pinyin).

If you have any issues with this repo please let me know, glad to help.

CJK support on Beepy @charlestsai1995

Beepy Package Repository @ardangelo

Getting Started @SQFMI