App::B...uggable(3pm)

πŸ“¦
version 1.30 Β· 5 versions
, in ubuntu resolute, ubuntu stonking

πŸ’– App::B...uggable β€” the manual page, but make it bestie πŸ’–

okay so this is the App::B...uggable(3pm) page, and it lives in the User Contributed Perl Documentation section of your manual, so you already know it's the community-made, handcrafted, artisanal kind of docs. sit down, grab a boba, we're doing this πŸ§‹βœ¨


✨ NAME ✨

App::Bot::BasicBot::Pluggable β€” bestie, it's the base class for bot applications. that's the whole vibe. it's the foundation, the blueprint, the main character skeleton that your bot gets built on top of. πŸ’…


🌸 VERSION 🌸

version 1.30 β€” no cap, that's the number. πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

here's the whole thing in action, and yes we are copying it exactly, character for character, because details are sacred:

  my bot = App::Bot::BasicBot::Pluggable( modules => [ 'Karma' ] )
  $bot->run();

look at it go. iconic. 🌈


πŸ’œ DESCRIPTION πŸ’œ

so here's the tea β˜• β€” this module is basically intended as a base class for Bot::BasicBot::Pluggable frontends. it's not out here doing the whole job by itself, it's the supporting structure, the scaffolding, the bones of the operation. 🦴✨

and the way you configure it? its attributes can be set by command line options or a configuration file. that's it, that's the flex. two whole doors into the same room, pick whichever one sparks joy. πŸšͺπŸšͺ


πŸ‘‘ ATTRIBUTES πŸ‘‘

okay so all of the attributes listed right after this are documented in the manpage of bot-basicbot-pluggable. that's the official source of truth, go read it. πŸ“–

and here's the little transformation trick you need: just replace all dashes with underscores. that's the whole conversion. --some-thing becomes some_thing. periodt. πŸ’…

here's the full list, every single one, not skipping a single name because we don't do that here:

  • server
  • nick
  • charset
  • password
  • port
  • list_modules
  • list_stores
  • loglevel
  • logconfig
  • configfile
  • module

that's all eleven. count them. we did not lose one. 🫢


πŸ”₯ METHODS πŸ”₯

🌟 run

so run is the method, and here's exactly how it behaves:

  • if list_modules or list_stores are set to a true value, then the according list gets printed to stdout. that's it, it just shows you the list and you vibe with the information. πŸ“‹βœ¨
  • otherwise β€” and this is the "we're actually doing stuff" branch β€” the run method of the bot specified by the bot_class method is called. yes, run calling run. it's giving recursion-adjacent energy but it's just delegating to the bot class, don't overthink it. πŸ”
lowkey important: that's an either/or. lists out, or the bot runs. not both. pick your lane bestie. πŸ›£οΈ

πŸŽ€ AUTHOR πŸŽ€

Mario Domgoergen <mdom@cpan.org> β€” thank you for your service, king. πŸ‘‘πŸ’–


🌈 LICENSE 🌈

this program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. so like. go forth. share it. remix it. it's free free. πŸ•ŠοΈ


and that's the whole page bestie!! πŸ’– written up against perl v5.40.0, dated 2024-08-24, and yeah the footer name is the same cute little truncated App::B...uggable(3pm) because the manpage header has a character limit and honestly? relatable. we've all been there. 🫢✨ go build a bot, ily, bye!! πŸŒΈπŸ¦‹πŸ’œ

πŸ“¦ where this page comes from