docu update

Committer: Lord255

On branch docu_update
Changes to be committed:
	modified:   QuoteEngine/QuoteEngine-settings.sample.tcl
	modified:   QuoteEngine/README.md
	modified:   QuoteEngine/sql/quotes.sql

QuoteEngine/QuoteEngine-settings.sample.tcl

@@ -4,14 +4,14 @@
 # your eggdrop's scripts/ directory
 
 # The mysql hostname to connect to
-set quote_db(host) "localhost"
+set quote_db(host) "127.0.0.1"
 
 # The mysql account to connect as
-set quote_db(user) "bot"
-set quote_db(password) "verysecret"
+set quote_db(user) "<botnick>"
+set quote_db(password) "<botpwhere>"
 
 # The name of the database to use
-set quote_db(database) "quotes"
+set quote_db(database) "quotesdb"
 
 # The URL of the webpage
 # If you're not using it, set this to ""

QuoteEngine/README.md

@@ -1,30 +1,138 @@
-Quick start, because I can't be arsed writing a full one ;)
+Hello!
 
-SQL setup
----------
 
-1. Create a user and database in your mysql server for the bot to use
-2. Populate the database using the .sql script
+Steps you need to do (or packages you should have) before downloading the script:
+1. Install all necessary packages for eggdrop to make use of mysql (also packages which you need to have are included).
+   For example for ubuntu 18.04 these would be the packages: tcl, tcl-dev, tcllib, tcl-tls, zlibc, zlib1g, tcl-trf, mysqltcl
+2. Install mysql-server and phpmyadmin (phpmyadmin is not really needed, but it helps to manage databases).
+   For example for ubuntu 18.04 these would be the packages: mysql-server, mysql-client, phpmyadmin
+      For phpmyadmin you need the following packages: apache2, php <- install those first. :)
+3. Install eggdrop. Check out here: https://www.eggheads.org/downloads
 
-Note: Give the SQL user minimum permissions, restrict it to just the host the bot runs on, etc.
+In case you have a running bot, you can continue.
 
-TCL setup
----------
 
-1. Install mysqltcl package
-2. Put the QuoteEngine.tcl file in your eggdrop's scripts/ directory
-3. Edit the QuoteEngine-settings.sample.tcl file and save it as
-   QuoteEngine-settings.tcl in your scripts/ directory
-4. Put `source scripts/QuoteEngine.tcl` in your bot's config file
+Database setup, first steps
+---------------------------------------------
+
+1. Create admin user for mysql if you don't have it yet.
+   
+   // In case you have an admin user for your mysql server other than the "root" user, you can skip this. //
+
+   With root user enter the following command in your shell:
+   # mysql -u root
+      This will let you to login to mysql, so you can make changes on/in it.
+ 
+   Create a new admin user (so you can login to phpmyadmin later on):
+   mysql> CREATE USER '<user>'@'%' IDENTIFIED BY '<pwhere>';
+      This will create the <user> with the given password.
+      
+   Grant all right to the user:
+   mysql> GRANT ALL PRIVILEGES ON *.* TO '<user>'@'%' WITH GRANT OPTION;
+      This command allows you to login from any host/ip and gives you unlimited control over all databases.
+   
+   Check if you did everything well, so the user exists:
+   mysql> SHOW GRANTS FOR '<user>'@'%';
+   
+   mysql> exit
+      This will exit you out from the mysql console.
+   
+2. Create a user and database in your mysql server for the bot to use.
+   
+   You have two options now:
+   a, Use phpmyadmin, where you can log in with the user which you created in point one and there
+      create a new database and a new user, then grant that user rights over the database ..
+   
+   OR
+   
+   b, Use the following commands:
+   
+   With your shell user, login to mysql with the previously created user:
+   $ mysql -u <user> -p
+      Here you will need to enter the password which you have given previous (<pwhere>).
+   
+   mysql> CREATE DATABASE quotesdb;
+      This will create a database, named "quotesdb".
+   
+   Now we need to create an other user for the bot.
+   mysql> CREATE USER '<botnick>'@'localhost' IDENTIFIED BY '<botpwhere>';
+      This will create a user named "botnick". We will use this user,
+      to connect to mysql and make changes in database named "quotesdb".
+      For that, we need to set rights.
+      
+   mysql> GRANT ALL PRIVILEGES ON quotesdb.* TO '<botnick>'@'localhost';
+      This will grant all right on db "quotesdb" to "botnick" user, connecting from localhost.
+    
+    
+   Now we are ready to move on to the next step. :)
+   
+   
+2. Now, you have to create the tables into the database which you made.
+   For this, you can download the pre-made script - you can find it in the sql folder, named "quotes.sql".
+   Download it (example: wget) and run the following command with your shell user:
+      $ mysql -u <user> -p quotesdb < quotes.sql
+         The <user> is what you have created at point 1. :)
+
+
+   At this point you are ready with the preparations and you can move to the next chapter. :)
+
+
+Setting up the tcl script, edit the config(s)
+---------------------------------------------
+
+1. Download the script (QuoteEngine.tcl) and put that into the eggdrop's  scripts directory.
+2. Download the settings file (QuoteEngine-settings.sample.tcl) rename it to "QuoteEngine-settings.tcl" and edit it!
+   The settings file needs to be edited. If you followed the guide, you won't have any problems to fill it out. :)
+3. Open your bot's configuraton file and put the following like to the end of the file:
+      'source "scripts/QuoteEngine.tcl"'
+   (Obviously without the '' signs. :))
+4. Telnet to your bot (or use dcc chat), or however you go to your bot's console and rehash your bot.
+   You need to see this line in the console:
+      "QuoteEngine 1.3 loaded"
+   In case you cannot see it, you did something wrong. Check again the guide. :) 
+
+
+Usage
+---------------------------------------------
+
+1. You have to set "+quoteengine" flag to the channel where you want to enable to use the commands provided by the script.
+   You can do this via the bot's console with command:
+      .chanset <#channelname_here> +quoteengine
+2. If you did everything right, now you will be able to use commands as:
+
+
+!addquote <text>        -- add a quote
+!getquote <#number>     -- get the quote of #
+!randquote              -- get a random quote
+!delquote <#number>     -- delete a quote
+!quotehelp              -- list of all available command
+
+
+Note: some of the commands are limited bot owners, masters, etc.. Check QuoteEngine.tcl for further details.
+   (
+    You need to check the "bind pub" lines. :)
+    m,f,o,v are flags (rights) which you can have in the bot
+   )
+
 
 Webpage setup
--------------
+---------------------------------------------
+
+!! The php part - so the webiste - won't work, because the code is for php5, so on php7 it wont work.
+!! I don't recommend anyone to install php5 anymore.
+!! In case you are into coding and have free time, feel free to contribute to this project,
+!! rewrite the code and open a pull request!
+!! Help is much appreciated! :)
+!! Thanks in advance!
 
+
+For php5 the instructions are:
 1. Put the files in the www directory in the right place in your webserver
 2. Edit settings.sample.inc to have the right details, and rename to settings.inc
 3. Profit
 
+
 3rd Party webpages
-------------------
+---------------------------------------------
 
 * https://github.com/brandon15811/QuoteEngineWeb

QuoteEngine/sql/quotes.sql

@@ -1,8 +1,10 @@
--- MySQL dump 10.11
---
--- Host: localhost    Database: quotes
--- ------------------------------------------------------
--- Server version	5.0.90
+###
+# date: 200325
+# this is a dump file from the database, which you have to import to your databse which you careted during the "install"
+# the table name will be "quotes"
+# if you want to change the table name, overwrite "quotes" with something else in line 20 and 23.
+# unless just import this into your databse.
+###
 
 /*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
 /*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
@@ -15,21 +17,16 @@
 /*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
 /*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
 
---
--- Table structure for table `quotes`
---
-
 DROP TABLE IF EXISTS `quotes`;
 /*!40101 SET @saved_cs_client     = @@character_set_client */;
 /*!40101 SET character_set_client = utf8 */;
 CREATE TABLE `quotes` (
-  `id` bigint(20) NOT NULL auto_increment,
-  `nick` varchar(20) NOT NULL default '',
-  `host` varchar(100) NOT NULL default '',
+  `id` bigint(20) NOT NULL AUTO_INCREMENT,
+  `nick` varchar(20) NOT NULL DEFAULT '',
+  `host` varchar(100) NOT NULL DEFAULT '',
   `quote` text NOT NULL,
-  `channel` varchar(50) NOT NULL default '',
-  `timestamp` bigint(20) default NULL,
-  PRIMARY KEY  (`id`)
-) ENGINE=MyISAM AUTO_INCREMENT DEFAULT CHARSET=latin1;
+  `channel` varchar(50) NOT NULL DEFAULT '',
+  `timestamp` bigint(20) DEFAULT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
 /*!40101 SET character_set_client = @saved_cs_client */;
-