Skip to content

First steps

Jump to bottom
V0rT3x edited this page Nov 14, 2024 · 11 revisions

Configuration

  • Auto-Configuration: Fancygotchi primarily auto-configures itself, adding default settings to /etc/pwnagotchi/config.toml. You can customize the rotation and theme settings here:
main.plugins.Fancygotchi.enabled = false # or true is you want to enable directly on the next start
main.plugins.Fancygotchi.rotation = 0
main.plugins.Fancygotchi.theme = "" # The empty bracket will load the default theme
main.plugins.Fancygotchi.fancyserver = false # Fancyserver is used for FancyMenu and for additional control. It is disabled by default.

Memory Mounts: Ensure that certain memory mounts are disabled to prevent conflicts, especially with zram, which may lead to errors. Adjust the settings as follows:

fs.memory.mounts.data.enabled = false
fs.memory.mounts.data.zram = false
  • If you choose to use zram and the size is set too low, Fancygotchi will automatically adjust it to 50M to prevent potential issues. Here's how to set the size:
fs.memory.mounts.data.size = "50M"
  • Display Configuration: Configure your display settings for optimal performance. Set a higher frames per second (fps) and enable the display:
ui.fps = 1 #<-- Set fps higher than 0

ui.display.enabled = true # Enable display (can be set to false for headless mode)
ui.display.rotation = 0
ui.display.type = "displayhatmini" # Select your display type

Install steps

The general installation:

Online

  • Download the last Fancygotchi version with the terminal. Ensure to specify the correct path for your custom plugins folder (the default one is generally /usr/local/share/pwnagotchi/custom-plugins/):
curl -o /usr/local/share/pwnagotchi/custom-plugins/Fancygotchi.py -JL https://raw.githubusercontent.com/V0r-T3x/Fancygotchi/main/Fancygotchi.py

Offline

  • Use an ftp or scp client to connect to the 10.0.0.2.

  • Save Fancygotchi.py into the /home/pi.

  • Transfer the file into the custom plugins folder:

sudo cp /home/pi/Fancygotchi.py /usr/local/share/pwnagotchi/custom-plugins/Fancygotchi.py

Fix for the raspberry pi zero W and a great upgrade for any board version:

Online

  • Download the last Fancygotchi version with the terminal. Ensure to specify the correct path for your python version:
sudo curl -o /usr/local/lib/python3.9/dist-packages/pwnagotchi/plugins/__init__.py -JL https://raw.githubusercontent.com/Sniffleupagus/pwnagotchi-snflpgs/refs/heads/snflpgs/pwnagotchi/plugins/__init__.py
  • Verify if prctl is installed on your build:
apt update
apt install python3-prctl

Offline

  • Use an ftp or scp client to connect to the 10.0.0.2.

  • Save init.py into the /home/pi.

  • Transfer the file into the custom plugins folder. Ensure to specify the correct path for your python version:

sudo cp /home/pi/__init__.py /usr/local/lib/python3.9/dist-packages/pwnagotchi/plugins/__init__.py

Enabling

  • The pwnagotchi need to be restarted to load the plugin.
sudo service pwnagotchi restart

  • Enable Plugin: Access the Pwnagotchi web UI to enable the Fancygotchi plugin. On the first load, Fancygotchi will inject minimal code into the Pwnagotchi core to gain UI control, and Pwnagotchi will restart to apply the modification.

  • Congratulation, Fancygotchi is now installed.

Alternative install

  • Custom Plugin Repo: Add Fancygotchi to the custom plugins repository list in /etc/pwnagotchi/config.toml:
main.custom_plugin_repos = [
 "..."
 "https://github.com/V0r-T3x/Fancygotchi/archive/master.zip",
]
  • Update and Install: Update the plugins list in the terminal, then install Fancygotchi:
sudo pwnagotchi plugins update
  • You can list the plugins with:
sudo pwnagotchi plugins list
  • You can install Fancygotchi with:
sudo pwnagotchi plugins install Fancygotchi
Clone this wiki locally