Author Topic: module overview, super-admin and some documentation? (yes, im a newbie ;-) (Read 1777 times)

lulifuz · « **on:** April 12, 2006, 06:33:35 am »

Hi there,

I am new to this Bot and after I got it running (which was not so hard after all, al the hints are in this forum) the following questions rise:

Is there some overview of the available modules?
I found many topics saying 'Now, we have !xyz but it would be nice to have !qpr' but I wasn't even able to find !xyz.

What is the super-admin supposed to administrate?
I have not found a command to do some administrative work on the bot. Are there any?

Is there some documentation?
I did not find one, sorry. May by I was just to overwhelmed by seeing my Bot run finally ;-)

Thanks for your answers in advance.

Greetings,

lulifuz

Blondengy · « **Reply #1 on:** April 12, 2006, 09:08:27 am »

"/tell yourbot !help" should give you the avaluable commands.

Then for example "/tell yourbot !help !online" should explain the !online command to you and everything you can pass over to it.

Xenixa · « **Reply #2 on:** April 12, 2006, 06:26:15 pm »

Just an answer to Superadmin rights.
Superadmins are the only one's allowed to set-up others as Admins. For my bot Superadmin is also the only one allowed to issue a restart and set rights to commands using Alreadythere's custom rights management module(s).

Basically anything that deals with the Bot operating you want to leave to the Superadmin(s). Last thing you want is a remote user fouling up access rights or shutting down the bot instead of restarting(happened to me and the remote superadmin couldn't restart the bot, no rights on the machine).

Keep in mind Bebot is still in it's development stage at this point. Alot of us add-on Module makers and Official Module tuners add notes in the php code for functionality desciptions. Sometimes the help files can be a bit lite on info but if you glance through the code you can also glean a bit of info. BTW, don't use Notepad.exe to read the PHP files. It does support Unix style LF's and CR's, use Word Pad if you have nothing else, it'll preserve the formating of the PHP file when opened.

lulifuz · « **Reply #3 on:** April 12, 2006, 07:39:26 pm »

Hi there,

thanks to both of you.
I knew about the !help command.
But I did not find some command dealing with administration, so the question regarding super-admin (except for restart, I think, which I did not see to useful as I can restart the bot itself. Maybe I will learn over time ;-)
The module you mentioned seems worth a closer look.

And thanks also for the reminder that BeBot is still in development. If you got something up and running, working great you tend to forget its version 0.3.something. But you are right, sorry.

But regarding the module overview would that not be a good idea? As by now one has to look through all the posts to find out which modules are hidden there. Think of this, you people do a great job making those modules and a lot of people do not even realize!

Regarding the documentation I realised that the code is the doc. I was looking for something about the big picture. Maybe I should write a kind of a diary regarding my experiences with BeBot ;-) But than, who writes wen he can play ;-)

Thanks anyway.

Greetings,

lulifuz

Xenixa · « **Reply #4 on:** April 12, 2006, 08:03:49 pm »

Ahhh, well heheh, even I'll admit being one of those coders that abhor's writing documentation beyond a help file.

But ya I see were your going. Documenting each module and what it does in a big FAQ like file would be beneficial, but at the same time, it's time consuming(hence the reluctance of coders wanting to write docs in the first place).

Who knows, you could become Bebot's Module documentor or FAQ keeper or what ever you wanna call it. Not alot have volunteer'd to take up that task. I myself leave comments in my code for myself to remind me what a function does(or is supposed to do) and place/update the header comment as needed. And the bad part of all that is I code in Zend Studio which has a PHPDocumentor tool built in. Tools there, I just don't use it. $:-\$