Lord255 6 лет назад
Родитель
Сommit
89fa197f07
1 измененных файлов с 45 добавлено и 6 удалено
  1. 45 6
      QuoteEngine/README.md

+ 45 - 6
QuoteEngine/README.md

@@ -1,11 +1,14 @@
-Hello!
+**Hello!**
 
 
 
 
 Steps you need to do (or packages you should have) before downloading the 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).
 1. Install all necessary packages for eggdrop to make use of mysql (also packages which you need to have are included).
+   <br>
    For example for ubuntu 18.04 these would be the packages: tcl, tcl-dev, tcllib, tcl-tls, zlibc, zlib1g, tcl-trf, mysqltcl
    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).
 2. Install mysql-server and phpmyadmin (phpmyadmin is not really needed, but it helps to manage databases).
+   <br>
    For example for ubuntu 18.04 these would be the packages: mysql-server, mysql-client, phpmyadmin
    For example for ubuntu 18.04 these would be the packages: mysql-server, mysql-client, phpmyadmin
+      <br>
       For phpmyadmin you need the following packages: apache2, php <- install those first. :)
       For phpmyadmin you need the following packages: apache2, php <- install those first. :)
 3. Install eggdrop. Check out here: https://www.eggheads.org/downloads
 3. Install eggdrop. Check out here: https://www.eggheads.org/downloads
 
 
@@ -20,26 +23,36 @@ Database setup, first steps
    // In case you have an admin user for your mysql server other than the "root" user, you can skip this. //
    // 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:
    With root user enter the following command in your shell:
+   <br>
    ```# mysql -u root```
    ```# mysql -u root```
+      <br>
       This will let you to login to mysql, so you can make changes on/in it.
       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):
    Create a new admin user (so you can login to phpmyadmin later on):
+   <br>
    ```mysql> CREATE USER '<user>'@'%' IDENTIFIED BY '<pwhere>';```
    ```mysql> CREATE USER '<user>'@'%' IDENTIFIED BY '<pwhere>';```
+      <br>
       This will create the <user> with the given password.
       This will create the <user> with the given password.
       
       
    Grant all right to the user:
    Grant all right to the user:
+   <br>
    ```mysql> GRANT ALL PRIVILEGES ON *.* TO '<user>'@'%' WITH GRANT OPTION;```
    ```mysql> GRANT ALL PRIVILEGES ON *.* TO '<user>'@'%' WITH GRANT OPTION;```
+      <br>
       This command allows you to login from any host/ip and gives you unlimited control over all databases.
       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:
    Check if you did everything well, so the user exists:
+   <br>
    ```mysql> SHOW GRANTS FOR '<user>'@'%';```
    ```mysql> SHOW GRANTS FOR '<user>'@'%';```
-   
+   <br>
    ```mysql> exit```
    ```mysql> exit```
+   <br>
       This will exit you out from the mysql console.
       This will exit you out from the mysql console.
    
    
 2. Create a user and database in your mysql server for the bot to use.
 2. Create a user and database in your mysql server for the bot to use.
    
    
    You have two options now:
    You have two options now:
+   <br>
+   <br>
    a, Use phpmyadmin, where you can log in with the user which you created in point one and there
    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 ..
       create a new database and a new user, then grant that user rights over the database ..
    
    
@@ -48,19 +61,28 @@ Database setup, first steps
    b, Use the following commands:
    b, Use the following commands:
    
    
    With your shell user, login to mysql with the previously created user:
    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>).
+   <br>
+   ```$ mysql -u <user> -p```
+   <br>
+      Here you will need to enter the password which you have given previous (`<pwhere>`).
+   <br>
    
    
    ```mysql> CREATE DATABASE quotesdb;```
    ```mysql> CREATE DATABASE quotesdb;```
+   <br>
       This will create a database, named "quotesdb".
       This will create a database, named "quotesdb".
    
    
    Now we need to create an other user for the bot.
    Now we need to create an other user for the bot.
+   <br>
    ```mysql> CREATE USER '<botnick>'@'localhost' IDENTIFIED BY '<botpwhere>';```
    ```mysql> CREATE USER '<botnick>'@'localhost' IDENTIFIED BY '<botpwhere>';```
+   <br>
       This will create a user named "botnick". We will use this user,
       This will create a user named "botnick". We will use this user,
+      <br>
       to connect to mysql and make changes in database named "quotesdb".
       to connect to mysql and make changes in database named "quotesdb".
+      <br>
       For that, we need to set rights.
       For that, we need to set rights.
       
       
    ```mysql> GRANT ALL PRIVILEGES ON quotesdb.* TO '<botnick>'@'localhost';```
    ```mysql> GRANT ALL PRIVILEGES ON quotesdb.* TO '<botnick>'@'localhost';```
+   <br>
       This will grant all right on db "quotesdb" to "botnick" user, connecting from localhost.
       This will grant all right on db "quotesdb" to "botnick" user, connecting from localhost.
     
     
     
     
@@ -68,9 +90,12 @@ Database setup, first steps
    
    
    
    
 2. Now, you have to create the tables into the database which you made.
 2. Now, you have to create the tables into the database which you made.
+   <br>
    For this, you can download the pre-made script - you can find it in the sql folder, named "quotes.sql".
    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:
    Download it (example: wget) and run the following command with your shell user:
+   <br>
       ```$ mysql -u <user> -p quotesdb < quotes.sql```
       ```$ mysql -u <user> -p quotesdb < quotes.sql```
+      <br>
          The <user> is what you have created at point 1. :)
          The <user> is what you have created at point 1. :)
 
 
 
 
@@ -82,12 +107,17 @@ Setting up the tcl script, edit the config(s)
 
 
 1. Download the script (QuoteEngine.tcl) and put that into the eggdrop's  scripts directory.
 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!
 2. Download the settings file (QuoteEngine-settings.sample.tcl) rename it to "QuoteEngine-settings.tcl" and edit it!
+   <br>
    The settings file needs to be edited. If you followed the guide, you won't have any problems to fill it out. :)
    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:
 3. Open your bot's configuraton file and put the following like to the end of the file:
+     <br>
       ```source "scripts/QuoteEngine.tcl"```
       ```source "scripts/QuoteEngine.tcl"```
+      <br>
 4. Telnet to your bot (or use dcc chat), or however you go to your bot's console and rehash your bot.
 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:
    You need to see this line in the console:
+   <br>
       `"QuoteEngine 1.3 loaded"`
       `"QuoteEngine 1.3 loaded"`
+    <br>
    In case you cannot see it, you did something wrong. Check again the guide. :) 
    In case you cannot see it, you did something wrong. Check again the guide. :) 
 
 
 
 
@@ -95,8 +125,10 @@ Usage
 ---------------------------------------------
 ---------------------------------------------
 
 
 1. You have to set "+quoteengine" flag to the channel where you want to enable to use the commands provided by the script.
 1. You have to set "+quoteengine" flag to the channel where you want to enable to use the commands provided by the script.
+   <br>
    You can do this via the bot's console with command:
    You can do this via the bot's console with command:
-      .chanset <#channelname_here> +quoteengine
+      ```.chanset <#channelname_here> +quoteengine```
+      <br>
 2. If you did everything right, now you will be able to use commands as:
 2. If you did everything right, now you will be able to use commands as:
 
 
 ```
 ```
@@ -108,7 +140,9 @@ Usage
 ```
 ```
 
 
 
 
-Note: some of the commands are limited bot owners, masters, etc.. Check QuoteEngine.tcl for further details.
+Note: some of the commands are limited bot owners, masters, etc..
+<br>
+Check QuoteEngine.tcl for further details.
    (
    (
     You need to check the "bind pub" lines. :)
     You need to check the "bind pub" lines. :)
     m,f,o,v are flags (rights) which you can have in the bot
     m,f,o,v are flags (rights) which you can have in the bot
@@ -119,10 +153,15 @@ Webpage setup
 ---------------------------------------------
 ---------------------------------------------
 
 
 !! The php part - so the webiste - won't work, because the code is for php5, so on php7 it wont work.
 !! The php part - so the webiste - won't work, because the code is for php5, so on php7 it wont work.
+<br>
 !! I don't recommend anyone to install php5 anymore.
 !! I don't recommend anyone to install php5 anymore.
+<br>
 !! In case you are into coding and have free time, feel free to contribute to this project,
 !! In case you are into coding and have free time, feel free to contribute to this project,
+<br>
 !! rewrite the code and open a pull request!
 !! rewrite the code and open a pull request!
+<br>
 !! Help is much appreciated! :)
 !! Help is much appreciated! :)
+<br>
 !! Thanks in advance!
 !! Thanks in advance!