Introduction Last updated: 2020-09-30

Thanks for choosing YadPeb, before installing it please be sure to follow the requirements/compatibility bellow to have a fully working bot.

Compatibility

See compatible systems below

# Os Version Status
1 Ubuntu 18.04 ✔ Working
2 Ubuntu 20.04 ✔ Working
3 ArchLinux 2020.09.01 ✔ Working
4 Windows 7 ⚠ Not recommended
5 Windows 8/10 ⚠ Should work | Not recommended

Requirements

For a smooth running bot.

NodeJS version Minimum v12.18.4
Domain name Recommended for the normal webserver installation process
Minimalist Intel Core i5 4250U | 1 GB Storage | 256 Mo Ram
Recommended Intel Core I7-4790 | 1,5Gb SSD storage | 1 Gb Ram (up to 2 for high traffic) .

Installation

⚠ This tutorial has not been made for windows, however some parts might be useful

  1. Create a new directory in /var/www called yadpeb.
  2. Upload the files or clone them with git clone https://github.com/Maxime48/YADPEB.
  3. Install the packages with npm install.
  4. Create a new .env file based on .env.example.
  5. Visit Paypal to get your api keys.
  6. Fill up .env with your infos.

Bot installation

  1. Go to the Discord Developer Portal. Your first step is to browse over to the Discord Developer Portal: https://discordapp.com/developers/applications/ .
  2. If you already have a bot created, click it in the list. If you don’t have any discord bots, click the “New Application” button.
  3. Give Your Bot a Name.
  4. Bring Your Bot to Life With an Icon and Description.
  5. Retrieve Your Token, ( you want to click the blue “Add Bot” button ).
  6. Copy paste the token in DISCORD_TOKEN=""
  7. Put your discord id in DISCORD_OWNER=""
  8. Put the id of a channel where you will log transactions details in DISCORD_LOGS_CHANNEL=""
  9. Put the id of a channel where you will make your giveaways in GIVEWAY_CHANNEL=""
  10. Put the id of a channel where everyone can make giveaways in GIVEWAY_CHANNEL_COMMUNITY=""

Webserver installation

  1. Install Certbot if you don't have it.
  2. Change BASE_URL="" to BASE_URL="http://DOMAIN".
  3. Change STATUS_URL="" to STATUS_URL="http://DOMAIN" (the url you want to get the status from).
  4. Put the channel id for the automatic status report STATUS_CHANNEL="".
  5. Change STEP="" to STEP="install".
  6. Start your bot, with the forever-package ( forever start server.js ).
  7. Execute certbot certonly -n -d YOUR-DOMAIN (can be different on some systems).
  8. Change STEP="install" to STEP="live".
  9. Change BASE_URL="http://DOMAIN" to BASE_URL="https://DOMAIN".
  10. Change SSL_PRIVKEYPEM="" to SSL_PRIVKEYPEM="/etc/letsencrypt/live/DOMAIN/privkey.pem".
  11. Change SSL_CERTPEM="" to SSL_CERTPEM="/etc/letsencrypt/live/DOMAIN/cert.pem".
  12. Restart your bot. ( forever stop server.js / forever start server.js )

Configuration

Each file has fields containing text that can be changed, they mostly are in french but can easily be changed by opening the files.

Most of the webserver related text is in /views/ , it's writen with .pug , unless you know how it works just touch to the translations. If you cant find the text your a looking for, look in server.js

You can modify the rules ( p:rule help ) in /commands/rules.js

To be simple everything can be found in (for now) :

  1. /
  2. /automatic/
  3. /views/
  4. /commands/
  5. /discord.js
  6. /server.js


If you just want some commands, install it completely then, open discord.js and modify the commands to something nobody knows.
Do not forget to modify the help command in the same file to remove unused commands.

Intergrations

Intergrate YadPeb functionalities in your project

Section Item 4.1

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Section Item 4.2

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Section Item 4.3

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Web

Section intro goes here. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque finibus condimentum nisl id vulputate. Praesent aliquet varius eros interdum suscipit. Donec eu purus sed nibh convallis bibendum quis vitae turpis. Duis vestibulum diam lorem, vitae dapibus nibh facilisis a. Fusce in malesuada odio.

Section Item 6.1

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Section Item 6.2

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Section Item 6.3

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Resources

Section intro goes here. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque finibus condimentum nisl id vulputate. Praesent aliquet varius eros interdum suscipit. Donec eu purus sed nibh convallis bibendum quis vitae turpis. Duis vestibulum diam lorem, vitae dapibus nibh facilisis a. Fusce in malesuada odio.

Section Item 8.1

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Section Item 8.2

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

Section Item 8.3

Vivamus efficitur fringilla ullamcorper. Cras condimentum condimentum mauris, vitae facilisis leo. Aliquam sagittis purus nisi, at commodo augue convallis id. Sed interdum turpis quis felis bibendum imperdiet. Mauris pellentesque urna eu leo gravida iaculis. In fringilla odio in felis ultricies porttitor. Donec at purus libero. Vestibulum libero orci, commodo nec arcu sit amet, commodo sollicitudin est. Vestibulum ultricies malesuada tempor.

FAQs

Have a question ? Look here!.

Modifications (FAQ Category One)

Are modifications of any kind authorized?

This project is open source, you can modify and resell it (even if i don't like the idea), for more details about the license visit GitHub.

How do i change the bot language ?

Assuming you are not talking about the programming language, there is no "language config" yet, unfortunately you have to do it by opening the files manually

Selling (FAQ Category Two)

Paypal isnt working!

Be sure you have followed correctly the installation process and that the credentials are correct, PAYPAL_USERNAME is not your litteral password, same thing for PAYPAL_PASSWORD

Can someone use the api credentials to manipulate my account?

Yes and no, DO NOT show the informations of .env to anyone and be sure that .env cannot be accessed by a simple url.

GitHub (FAQ Category Three)

I want to add a feature, how can i?

Start by downloading the bot and create your own version, once you finished create a pull request on GitHub.

How long bibendum sodales?

Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui.

Where dapibus sollicitudin?

Aenean et sodales nisi, vel efficitur sapien. Quisque molestie diam libero, et elementum diam mollis ac. In dignissim aliquam est eget ullamcorper. Sed id sodales tortor, eu finibus leo. Vivamus dapibus sollicitudin justo vel fermentum. Curabitur nec arcu sed urna gravida lobortis. Donec lectus est, imperdiet eu viverra viverra, ultricies nec urna.