Help update

2025-10-16 01:11:02 -05:00
parent 501df0ad3d
commit b63cccca7a
2 changed files with 222 additions and 63 deletions
--- a/README.md
+++ b/README.md
@@ -42,6 +42,7 @@ Create/Edit `.env` file in the root directory of the bot and add the following v
 MATRIX_URL="https://matrix.org" (or another homeserver)
 MATRIX_USER=""
 MATRIX_PASS=""
+OPENWEATHER_API_KEY="" # Optional: For weather plugin
 ```

 4. Create systemd.service
@@ -95,57 +96,170 @@ For a complete list of available commands and their descriptions, use the `!comm

 # 🍄 Funguy Bot Commands 🍄

-🃏 **!fortune**
-Returns a random fortune message.
-Executes the `/usr/games/fortune` utility and sends the output as a message to the chat room.

-⏰ **!date**
-Displays the current date and time.
-Fetches the current date and time using Python's `datetime` module and sends it in a formatted message to the chat room.
+## Plugin Documentation

-💻 **!proxy**
-Retrieves a tested/working random SOCKS5 proxy.
-Fetches a list of SOCKS5 proxies, tests their availability, and sends the first working proxy to the chat room.
+### Core Commands

-📶 **!isup <domain/ip>**
-Checks if the specified domain or IP address is reachable.
-Checks if the specified domain or IP address is reachable by attempting to ping it. If DNS resolution is successful, it checks HTTP and HTTPS service availability by sending requests to the domain.
+**🍄 !help**
+Displays comprehensive help documentation for all available commands with usage examples.

-☯ **!karma <user>**
-Retrieves the karma points for the specified user.
-Retrieves the karma points for the specified user from a database and sends them as a message to the chat room.
+**🔌 !plugins**
+Lists all loaded plugins along with their descriptions.

-⇧ **!karma user up**
-Increases the karma points for the specified user by 1.
-Increases the karma points for the specified user by 1 in the database and sends the updated points as a message to the chat room.
+**⏰ !date**
+Displays the current date and time with proper ordinal formatting.

-⇩ **!karma user down**
-Decreases the karma points for the specified user by 1.
-Decreases the karma points for the specified user by 1 in the database and sends the updated points as a message to the chat room.
+**🃏 !fortune**
+Returns a random fortune message using the fortune command.

-📄 **!trigger [prompt]**
-An AI large language model designed to serve as a chatbot within a vibrant and diverse community chat room hosted on the Matrix platform.
-(Currently loaded model: **TheBloke_Mistral-7B-Instruct-v0.2-GPTQ**
+### Utility Commands

-Triggers: !tech, !music, !eth, !seo, !eng, !intv, !pron, !spk, !trv, !plag, !char, !adv, !story, !foot, !comic, !motiv, !debate, !write, !script, !author, !crit, !rel, !poem, !rap, !speak, !phil, !math, !tutor, !design, !sec, !recruit, !coach, !etymo, !com, !magic, !counsel, !behavior, !fit, !mh, !realest, !log, !dental, !web, !health, !acc, !chef, !auto, !art, !fin, !invest, !tea, !interior, !florist, !selfhelp, !gnome, !aph, !adv, !advgame, !esc, !title, !stats, !prompt, !teach, !diet, !psych, !domain, !tech, !review, !devrel, !acad, !arch, !insane, !manip, !logic, !review, !diy, !influencer, !philos, !socrat, !edu, !meditate, !writer, !smm, !eloc, !viz, !nav, !hypno, !hist, !astro, !critic, !comp, !journo, !curation, !pscoach, !makeup, !childcare, !writing, !art, !py, !syn, !shop, !dining, !telemed, !cook, !law, !fashion, !ml, !trans, !design, !it, !chess, !prompt, !dev, !math, !regex, !time, !dream, !coach, !r, !comm, !trans, !php, !emergency, !worksheet, !test, !game, !security, !create, !browse, !dev, !search, !startup, !guide, !langdet, !sales, !msg, !ceo, !diag, !coach, !therapy, !legal, !gen, !mgmt, !drunk, !hist, !rec, !write, !techtrans, !ai, !game, !proof, !spirit, !spirit, !chem, !friend, !py, !chat, !wiki, !kanji, !note, !litcrit, !enhance, !travel, !data, !gaming
+**💻 !proxy**
+Retrieves and tests random SOCKS5 proxies from public sources, showing latency and caching working proxies.

-🎝 **!music [prompt]**
-Your music expert! Try it out.
+**📶 !isup [domain/ip]**
+Checks if a website or server is reachable, including DNS resolution and HTTP/HTTPS service checks.

-🌧️ **!weather New York**
-Get Weather information
+**☯ !karma [user] [up/down]**
+Manages karma points for users. View karma with `!karma user`, increase with `!karma user up`, decrease with `!karma user down`.

-🃏 **!sd <prompt>**
-Stable Diffusion Generator
+**🌧️ !weather [location]**
+Fetches current weather information for any location using OpenWeatherMap API.
+*Requires OPENWEATHER_API_KEY environment variable*

-📄 **!ud <term>**
-Get Urban Dictionary Definition
+**📖 !ud [term] [index]**
+Fetches definitions from Urban Dictionary. Use without arguments for random definition, or specify term and optional index.

-# 🌟 Funguy Bot Credits 🌟
+### AI & Generation Commands

-🧙‍♂️ Creator & Developer:
-   - Eggzy Gallahad is the author of 🍄Funguy Bot🍄.
+**🤖 AI Commands (!tech, !music, !eth, etc.)**
+Multiple AI model commands that interface with local AI API. Each command uses specialized prompts for different domains:
+- `!tech` - Technology assistance
+- `!music` - Music knowledge and recommendations
+- `!weather` - Weather information
+- And 100+ other specialized AI commands

-# Join our Matrix Room:
+**📸 !sd [prompt] [options]**
+Generates images using self-hosted Stable Diffusion with customizable parameters:
+- `--steps` - Number of generation steps (default: 4)
+- `--cfg` - CFG scale (default: 2)
+- `--h` - Image height (default: 512)
+- `--w` - Image width (default: 512)
+- `--neg` - Negative prompt
+- `--sampler` - Sampler name (default: DPM++ SDE)

-[Self-hosting | Security | Sysadmin | Homelab | Programming](https://chat.mozilla.org/#/room/#selfhosting:mozilla.org)
+**📄 !text [prompt] [options]**
+Generates text using Ollama's Mistral 7B Instruct model:
+- `--max_tokens` - Maximum tokens to generate (default: 512)
+- `--temperature` - Sampling temperature (default: 0.7)
+
+### Media & Search Commands
+
+**🎬 YouTube Commands**
+- Automatic preview when YouTube links are posted
+- `!yt [search terms]` - Search for YouTube videos
+- Shows video info, description, and attempts to fetch lyrics
+
+**📰 !xkcd**
+Fetches and displays a random XKCD comic.
+
+### Administration Commands
+*Admin only - requires admin_user configuration*
+
+**🔧 !set [option] [value]**
+Set configuration options (admin_user, prefix)
+
+**🔍 !get [option]**
+Get configuration values
+
+**💾 !saveconf**
+Save current configuration
+
+**📥 !loadconf**
+Load saved configuration
+
+**👁️ !show**
+Display current configuration
+
+**🔄 !reset**
+Reset configuration to defaults
+
+**📤 !load [plugin]**
+Load a plugin
+
+**📥 !unload [plugin]**
+Unload a plugin
+
+**🔄 !reload**
+Reload all plugins
+
+**🚫 !disable [plugin] [room_id]**
+Disable a plugin for specific room
+
+**✅ !enable [plugin] [room_id]**
+Enable a plugin for specific room
+
+**⚙️ !rehash**
+Reload configuration
+
+### Cron System
+
+**⏱️ !cron [add|remove] [room_id] [cron_entry] [command]**
+Schedule automated commands using cron syntax:
+- `add` - Add a new cron job
+- `remove` - Remove an existing cron job
+
+## Full AI Command List
+
+The bot includes over 100 specialized AI commands covering various domains:
+
+**Creative & Writing**: !write, !script, !author, !poem, !rap, !story, !comic, !motiv, !debate
+
+**Technical**: !tech, !dev, !py, !php, !regex, !math, !web, !it, !security, !ai, !ml, !data, !game
+
+**Professional**: !seo, !recruit, !coach, !devrel, !sales, !ceo, !mgmt, !startup, !invest, !fin
+
+**Educational**: !tutor, !teach, !edu, !acad, !hist, !astro, !chem, !math, !psych
+
+**Lifestyle**: !fit, !health, !diet, !cook, !travel, !art, !music, !film, !gaming
+
+**Specialized**: !legal, !medical, !realest, !auto, !fashion, !design, !interior
+
+And many more! Use `!help` in chat to see the complete list with descriptions.
+
+## Configuration
+
+The bot uses a TOML configuration file (`funguy.conf`) for settings:
+- `admin_user` - Matrix user ID with admin privileges
+- `prefix` - Command prefix (default: "!")
+- Plugin-specific settings in `plugins/ai.json` for AI commands
+
+## Dependencies
+
+- Python 3.7+
+- simplematrixbotlib
+- Various AI/ML services (Stable Diffusion, Ollama, etc.)
+- Database support (SQLite)
+- External APIs (OpenWeatherMap, Urban Dictionary, YouTube)
+
+## Troubleshooting
+
+- Ensure all environment variables are set correctly
+- Check that required services are running (Stable Diffusion API, Ollama, etc.)
+- Verify plugin permissions and whitelist settings
+- Check logs for detailed error information
+
+## Support
+
+Join our Matrix room for support and community:
+[Self-hosting | Security | Sysadmin | Homelab | Programming](https://matrix.to/#/#selfhosting:mozilla.org)
+
+## Credits
+
+**🧙‍♂️ Creator & Developer**: HB (@hashborgir:mozilla.org)
+**🍄 Funguy Bot** - Created during recovery from cervical spinal surgery
+
+---
+
+*Note: This bot was created rapidly and may contain bugs. Please report issues and contribute improvements!*
--- a/plugins/help.py
+++ b/plugins/help.py
@@ -25,68 +25,113 @@ async def handle_command(room,  message,  bot,  prefix,  config):
        commands_message = """
 <details><summary><strong>🍄 Funguy Bot Commands 🍄</strong></summary>
 <p>
+<details><summary>📖 <strong>!help</strong></summary>
+<p>Displays comprehensive help documentation for all available commands with usage examples.</p>
+</details>
+
+<details><summary>🔌 <strong>!plugins</strong></summary>
+<p>Lists all loaded plugins along with their descriptions in alphabetical order.</p>
+</details>
+
 <details><summary>🃏 <strong>!fortune</strong></summary>
 <p>Returns a random fortune message. Executes the `/usr/games/fortune` utility and sends the output as a message to the chat room.</p>
 </details>

 <details><summary>⏰ <strong>!date</strong></summary>
-<p>Displays the current date and time. Fetches the current date and time using Python's `datetime` module and sends it in a formatted message to the chat room.</p>
+<p>Displays the current date and time. Fetches the current date and time using Python's `datetime` module and sends it in a formatted message with proper ordinal suffixes to the chat room.</p>
 </details>

 <details><summary>💻 <strong>!proxy</strong></summary>
-<p>Retrieves a tested/working random SOCKS5 proxy. Fetches a list of SOCKS5 proxies,  tests their availability,  and sends the first working proxy to the chat room.</p>
+<p>Retrieves a tested/working random SOCKS5 proxy. Fetches a list of SOCKS5 proxies from public sources, tests their availability, and sends the first working proxy with latency information to the chat room. Caches working proxies for faster access.</p>
 </details>

 <details><summary>📶 <strong>!isup [domain/ip]</strong></summary>
-<p>Checks if the specified domain or IP address is reachable. Checks if the specified domain or IP address is reachable by attempting to ping it. If DNS resolution is successful,  it checks HTTP and HTTPS service availability by sending requests to the domain.</p>
+<p>Checks if the specified domain or IP address is reachable. Performs DNS resolution and checks HTTP/HTTPS service availability. Reports successful DNS resolution and service status.</p>
 </details>

 <details><summary>☯ <strong>!karma [user]</strong></summary>
-<p>Retrieves the karma points for the specified user. Retrieves the karma points for the specified user from a database and sends them as a message to the chat room.</p>
+<p>Retrieves the karma points for the specified user. Retrieves the karma points for the specified user from a SQLite database and sends them as a message to the chat room.</p>
 </details>

 <details><summary>⇧ <strong>!karma [user] up</strong></summary>
-<p>Increases the karma points for the specified user by 1. Increases the karma points for the specified user by 1 in the database and sends the updated points as a message to the chat room.</p>
+<p>Increases the karma points for the specified user by 1. Increases the karma points for the specified user by 1 in the database and sends the updated points as a message to the chat room. Users cannot modify their own karma.</p>
 </details>

 <details><summary>⇩ <strong>!karma [user] down</strong></summary>
-<p>Decreases the karma points for the specified user by 1. Decreases the karma points for the specified user by 1 in the database and sends the updated points as a message to the chat room.</p>
+<p>Decreases the karma points for the specified user by 1. Decreases the karma points for the specified user by 1 in the database and sends the updated points as a message to the chat room. Users cannot modify their own karma.</p>
+</details>
+
+<details><summary>🌧️ <strong>!weather [location]</strong></summary>
+<p>Fetches current weather information for any location using OpenWeatherMap API. Shows temperature (Celsius/Fahrenheit), conditions, humidity, wind speed, and weather emojis. Requires OPENWEATHER_API_KEY environment variable.</p>
+</details>
+
+<details><summary>📖 <strong>!ud [term] [index]</strong></summary>
+<p>Fetches definitions from Urban Dictionary. Use without arguments for random definition, or specify term and optional index number. Shows definition, example, author, votes, and permalink.</p>
 </details>

 <details><summary>📸 <strong>!sd [prompt]</strong></summary>
-<p>Generates images using self-hosted Stable Diffusion. See available options using just '!sd'.</p>
+<p>Generates images using self-hosted Stable Diffusion. Supports options: --steps, --cfg, --h, --w, --neg, --sampler. Uses queuing system to handle multiple requests. See available options using just '!sd'.</p>
 </details>

-<details><summary>💡 <strong>!enable</strong></summary>
-<p>Enables a disabled command. Use '!enable plugin room' to enable a specific command.</p>
+<details><summary>📄 <strong>!text [prompt]</strong></summary>
+<p>Generates text using Ollama's Mistral 7B Instruct model. Options: --max_tokens, --temperature. Uses queuing system for sequential processing.</p>
 </details>

-<details><summary>🚫 <strong>!disable</strong></summary>
-<p>Disables a command. Use '!disable plugin room' to disable a specific command.</p>
+<details><summary>📰 <strong>!xkcd</strong></summary>
+<p>Fetches and displays a random XKCD comic. Downloads comic image and sends it directly to the chat room.</p>
 </details>

-<details><summary>📸 <strong>!xkcd</strong></summary>
-<p>Get random xkcd image.</p>
+<details><summary>🎬 <strong>YouTube Features</strong></summary>
+<p>Automatic preview when YouTube links are posted. Shows video info, description, and attempts to fetch lyrics. Also supports !yt [search terms] for direct YouTube searching.</p>
 </details>

-<details><summary>📸 <strong>!weather</strong></summary>
-<p>Get weather info</p>
+<details><summary>⏱️ <strong>!cron [add|remove] [room_id] [cron_entry] [command]</strong></summary>
+<p>Schedule automated commands using cron syntax. Add or remove cron jobs for specific rooms and commands.</p>
 </details>

-<details><summary>📸 <strong>!ud</strong></summary>
-<p>Get Urban Dictionary definition.</p>
-</details>
-
-<details><summary>🌟 <strong>Funguy Bot Credits</strong> 🌟</summary>
-<p>🧙‍♂️ Creator & Developer: HB is the author of 🍄Funguy Bot🍄. (@hashborgir:mozilla.org)</p>
-<p>Join our Matrix Room: [Self-hosting | Security | Sysadmin | Homelab | Programming](https://matrix.to/#/#selfhosting:mozilla.org)</p>
+<details><summary>🔧 <strong>Admin Commands</strong></summary>
+<p>
+<strong>!set [option] [value]</strong> - Set configuration options (admin_user, prefix)<br>
+<strong>!get [option]</strong> - Get configuration values<br>
+<strong>!saveconf</strong> - Save current configuration<br>
+<strong>!loadconf</strong> - Load saved configuration<br>
+<strong>!show</strong> - Display current configuration<br>
+<strong>!reset</strong> - Reset configuration to defaults<br>
+<strong>!load [plugin]</strong> - Load a plugin<br>
+<strong>!unload [plugin]</strong> - Unload a plugin<br>
+<strong>!reload</strong> - Reload all plugins<br>
+<strong>!disable [plugin] [room_id]</strong> - Disable a plugin for specific room<br>
+<strong>!enable [plugin] [room_id]</strong> - Enable a plugin for specific room<br>
+<strong>!rehash</strong> - Reload configuration<br>
+<em>Note: Admin commands require admin_user privileges</em>
+</p>
 </details>
 </p>
 </details>
-<hr>
-<details><summary>📸 <strong>Funguy Bot AI Commands</strong> 🌟</summary>
+
+<details><summary><strong>🤖 Funguy Bot AI Commands</strong></summary>
 <p>
-!tech, !music, !eth, !seo, !eng, !intv, !pron, !spk, !trv, !plag, !char, !adv, !story, !foot, !comic, !motiv, !debate, !write, !script, !author, !crit, !rel, !poem, !rap, !speak, !phil, !math, !tutor, !design, !sec, !recruit, !coach, !etymo, !com, !magic, !counsel, !behavior, !fit, !mh, !realest, !log, !dental, !web, !health, !acc, !chef, !auto, !art, !fin, !invest, !tea, !interior, !florist, !selfhelp, !gnome, !aph, !adv, !advgame, !esc, !title, !stats, !prompt, !teach, !diet, !psych, !domain, !tech, !review, !devrel, !acad, !arch, !insane, !manip, !logic, !review, !diy, !influencer, !philos, !socrat, !edu, !meditate, !writer, !smm, !eloc, !viz, !nav, !hypno, !hist, !astro, !critic, !comp, !journo, !curation, !pscoach, !makeup, !childcare, !writing, !art, !py, !syn, !shop, !dining, !telemed, !cook, !law, !fashion, !ml, !trans, !design, !it, !chess, !prompt, !dev, !math, !regex, !time, !dream, !coach, !r, !comm, !trans, !php, !emergency, !worksheet, !test, !game, !security, !create, !browse, !dev, !search, !startup, !guide, !langdet, !sales, !msg, !ceo, !diag, !coach, !therapy, !legal, !gen, !mgmt, !drunk, !hist, !rec, !write, !techtrans, !ai, !game, !proof, !spirit, !spirit, !chem, !friend, !py, !chat, !wiki, !kanji, !note, !litcrit, !enhance, !travel, !data, !gaming
+<strong>Creative & Writing</strong>: !write, !script, !author, !poem, !rap, !story, !comic, !motiv, !debate, !crit, !litcrit<br>
+<strong>Technical</strong>: !tech, !dev, !py, !php, !regex, !math, !web, !it, !security, !ai, !ml, !data, !game, !gaming<br>
+<strong>Professional</strong>: !seo, !recruit, !coach, !devrel, !sales, !ceo, !mgmt, !startup, !invest, !fin, !acad<br>
+<strong>Educational</strong>: !tutor, !teach, !edu, !hist, !astro, !chem, !psych, !meditate, !socrat, !philos<br>
+<strong>Lifestyle</strong>: !fit, !health, !diet, !cook, !travel, !art, !music, !film, !selfhelp<br>
+<strong>Specialized</strong>: !legal, !medical, !realest, !auto, !fashion, !design, !interior, !florist<br>
+<strong>Communication</strong>: !pron, !spk, !speak, !eloc, !comm, !msg, !langdet<br>
+<strong>Business</strong>: !eth, !browse, !search, !create, !review, !curation, !domain<br>
+<strong>Entertainment</strong>: !char, !adv, !advgame, !esc, !title, !stats, !prompt<br>
+<strong>Technical Specialties</strong>: !intv, !plag, !trv, !foot, !rel, !etymo, !magic, !counsel, !behavior, !mh, !log, !dental, !acc, !chef, !tea, !telemed, !law, !trans, !chess, !time, !dream, !r, !emergency, !worksheet, !test, !create, !guide, !diag, !therapy, !gen, !drunk, !rec, !techtrans, !proof, !spirit, !friend, !chat, !wiki, !kanji, !note, !enhance, !nav, !hypno, !critic, !comp, !journo, !pscoach, !makeup, !childcare, !writing, !syn, !shop, !dining<br>
+
+<em>Each AI command uses specialized prompts optimized for different domains and interfaces with local AI models.</em>
+</p>
+</details>
+
+<details><summary>🌟 <strong>Funguy Bot Credits</strong></summary>
+<p>
+<strong>🧙‍♂️ Creator & Developer</strong>: HB is the author of 🍄Funguy Bot🍄. (@hashborgir:mozilla.org)<br>
+<strong>🚀 Development Context</strong>: Created during recovery from two-level cervical spinal surgery (CDA Cervical Discectomy and Disc Arthroplasty)<br>
+<br>
+<strong>Join our Matrix Room</strong>: <a href="https://matrix.to/#/#selfhosting:mozilla.org">Self-hosting | Security | Sysadmin | Homelab | Programming</a>
 </p>
 </details>
 """