Skip to content

Latest commit

 

History

History
106 lines (80 loc) · 4.34 KB

README.md

File metadata and controls

106 lines (80 loc) · 4.34 KB
Raw

🐬 WoF Pwnagotchi plugin

Discord server GitHub Release GitHub issues GitHub License

Simple plugin to show data from Wall Of Flippers on Pwnagotchi's screen. Display total number of Flippers met and the name of the last Flipper that is online. When a new Flipper is met, shows a custom status message with the Flipper's name.

If Wall of Flippers is not running, it will still display the total number of Flippers met.

demo

✅ Prerequisites

Before installing this plugin on your Pwnagotchi, you need to have Wall of Flippers installed. To install it, follow the installation steps on the Github's repository of my version of Wall of Flippers.

🚀 Installation

Important

If you install the plugin using pwnagotchi plugins command, make sure to add also wof_assets directory to the directory where plugins are stored, otherwise the icon and other resources will not be rendered.

  1. Login inside your pwnagotchi using SSH:
ssh [email protected]
  1. Go to custom_plugins directory where all custom plugins of your Pwnagotchi are stored:
cd /path/to/custom_plugins/directory
  1. Download the plugin zipped file:
wget https://github.com/cyberartemio/wof-pwnagotchi-plugin/archive/main.zip
  1. Extract files and remove useless files:
unzip main.zip &&
mv wof-pwnagotchi-plugin-main/wof.py . &&
mv wof-pwnagotchi-plugin-main/wof_assets .&&
rm -r wof-pwnagotchi-plugin-main main.zip
  1. Edit your configuration file (/etc/pwnagotchi/config.toml) and add the following:
# Enable the plugin
main.plugins.wof.enabled = true

# Show the flipper icon on screen instead of the label "[wof]"
main.plugins.wof.icon = true

# Set to true for black background, false for white background
main.plugins.wof.icon_reverse = false

# Display coordinates for text position
main.plugins.wof.position.x = 5
main.plugins.wof.position.y = 84

# File system path where Flipper.json file is located
main.plugins.wof.wof_file = "/root/Wall-of-Flippers/Flipper.json"

# A flipper is considered online if its last seen time is within this timespan
main.plugins.wof.online_timespan = 30 # in seconds
  1. Restart daemon service:
sudo systemctl restart pwnagotchi

Done! Now the plugin is installed and is working.

Note

If you don't specify any values for wof.icon, wof.icon_reverse, wof.position.x, wof.position.y, wof.wof_file and wof.online_timespan, the plugin will use the following default values:

  • wof.icon: true
  • wof.icon_reverse: false
  • wof.position.x: 5
  • wof.position.y: 82
  • wof.wof_file: /root/Wall-of-Flippers/Flipper.json
  • wof.online_timespan: 120 - 2 minutes

✨ Web UI

This plugin comes also with a web UI that shows all Flippers met with additional data. You can use it by opening http://10.0.0.2/plugins/wof inside your browser (note: you need to be connected to your Pwnagotchi).

Inside the web UI you'll find:

  • current status of wof systemd daemon
  • buttons to start/stop and restart wof systemd daemon
  • total count of online and offline flippers
  • list of all the flippers met with some data
  • if you click on a flipper, a modal will pop up with all its data
  • auto refresh of data every 60 seconds

Here you can find a preview of what the UI will look like:

webui

❤️ Contribution

If you need help or you want to suggest new ideas, you can open an issue here or you can join my Discord server using this invite.

If you want to contribute, you can fork the project and then open a pull request.

🥇 Credits

  • Wall of Flippers by K3YOMI (Github)
  • rai68 for Flipper icon (Github)