Panavia/Manual

From Botdom Wiki
Jump to: navigation, search

Preface

This guide will explain basically everything there is to know about the bot I made. I will even make a section for python developers and learners. I will be showing everything from setting up all the way to using extensions and other misc. things. After reading over this I believe you should have the basic and intermediate knowledge for owning, maintaining, and operating a bot, be it Panavia or another bot model such as Komodo.

Some previous knowledge

Now, let me be honest. Setting up any bot requires Knowledge. You should know how to install basic programs, configure configuration files, and how to unzip a compressed archive file. I get a lot of questions what unzipping an archive is. I hope this will shed some light on it all...

How to extract/Unzip a .zip archive file :

  1. Highlight the .zip file, You can right click on it as well.
  1. A menu will pop up with options like "delete", "copy", "cut", etc...
  2. Select one of the following that may apply: "Extract all", "Extract here", anything with "Extract" in the name is probably what your looking for.
  3. Now if a menu pops up, just hit either "continue", "okay", or "extract" (Just depends on your system) And it will finish extracting the bots' folder from the zip archive.

There appears to also be confusion on what extracting does. Extracting will "Extract" A folder from any .Zip File. This means you will be wanting the folder that shows up with the same name as the .zip file. This folder is the bots' Main folder, you can go ahead and delete the .zip file as its no longer needed. DO NOT delete the folder, as this is what you need, the bot is inside that folder.

Starting up

When you first go into Panavias' Folder you may find a LOT of things, folders, files, other misc. things. I included all those for either a well documented bot or a well operational bot. Trust me after reading this it will make some form of sense. As it Cannot be broken down any simpler.

How to start setup for your Panavia On windows:

  1. Inside the bot' Folder, find a file called "Run" or "Run.py"
  1. Start the bot by clicking on the file listed above.
  2. See "Setting up Panavia" Below.

How to start setup for your Panavia On Unix/linux/Mac:

  1. Open up a Terminal window.
  1. cd to the bots folder, you can do this by typing into the terminal: cd 'Path/To/Bots/Folder' Or by typing "cd" into the terminal and dragging the bots' folder into the terminal window. this will copy the location of the bots' folder.
  2. Next type: python3 Run.py into the terminal, and hit enter, this will start the bot up.
  3. See "Setting up Panavia" Below.

Setting up Panavia

When you first run panavia, you will get a notification something like...

<text> Welcome to the setup, this will assist you in setting up the bot So it can join dAmn. Lets begin.

First, would you like to use oAuth to log in? oAuth is more secure, but requires that you are logged in as the bots account under a web browser! If you don't use oAuth, you will log in by putting the username and password in here. Would you like to use oAuth to log in? [Y,N]: </text>

If you use oAuth, you will see something like this.

<text> First, we need to log in. Please log into your web browser under your bots account. Then, go to this address:

       http://127.0.0.1:8080

</text>

You will have to log into a web browser as your bots account, then visit the link posted above. Then you can authenticate the bot ( give it permission ) to run on that account! In order to do this, you will have to click "Authorize app" in the box that shows up.

After that, the bot will log into dA and you will move onto setting up the autojoin!

If you don't use oAuth, you will log in the old way. This requires an account username and password:

<text> What is the bots username: What is the bots password: </text>

After you put in the bots username and password, it will log in and grab an authtoken.

<text>

  • Okay, logging in. This is so we can grab the cookies needed to fetch a token
* * Logged in! now fetching token page and matching token ...
* * * Fetched authtoken!

</text>

Next, you need to set up autojoin, these are the channels the bot will join automatically.

<text> Now input the rooms the bot should join below, these are seperated by spaces. For instance: room1 room2 room3 ... > </text>

Just put in the rooms, seperated by spaces. no # is needed either.

Next you need to input the bots trigger, if you are confused here, see the "What is a trigger" section.

<text> Now input your trigger, this is used to make the bot do commands in a room. This needs to be at least two characters long. > </text>

Next you need to input your username, because you are the owner of the bot. if you are setting up for someone else.. you know the deal. just put in the username that will be owning the bot.

<text> Now we need the owner of the bot, this would be your username. Put your username here > </text>

Next will come the updates checker.

<text> Would you like the bot to check for updates at startup? and notify when a new update comes out? [N,y]: </text>

If you want the bot to check for updates and notify you that there are some at startup, then check 'y', else you can check 'n'

Next it will prompt you for correctness.

<text> Configurations so far:

** Username: username
** Autojoin: [room1][room2]
** Trigger : trigger
** Updates : notify and check

Is this information correct? [Y/n] > </text>

If such information is correct you can check 'Y', else you can check 'N' to restart the set up. So, if you are ready to continue just put in 'Y' and hit enter.

And the bot will restart. It will then join rooms, etc. and you have successfully set up Panavia!

Trigger, What is a trigger?

A trigger is what makes the bot run a command, it is what "triggers" the command. The basic format to run a command goes like this: <text>[Trigger][Command] [arguments]</text>

Now say you want to run the command, "say" and being the command makes the bot say something, you wanted the bot to say "Hello world!"

Also, say your trigger was '$' You would use all this to trigger command "say" by doing the following:

<text> <yourname> $say Hello world! </text>

and the bot will respond something like this:

<text> <botname> Hello world! </text>

This is the basic context to a trigger, and what it does. Now. When setting up a trigger please do not use simple characters like '!', '@', '#', '$', '%', etc... Please use something significant for your bots trigger. This is so your bot wont conflict with other bots using the same trigger as you, that can be a real disconvenience to other users and you. Try using a trigger of At least Two characters, and using a combination of letters, symbols, and numbers.

Using Extensions with panavia.

Panavia comes with Extensions. These are what add commands, events, etc to a bot. For instance, opening up the folder named "Extensions" in Panavias' Main folder will show the extensions used in Panavia. For more information see The extensions page