add files

Author: AlphaMSq

.gitignore

@@ -0,0 +1,129 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+.vscode/
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+dconf.json

CreateBot.md

@@ -0,0 +1,23 @@
+Для использования вам нужно зарегистрировать приложение в Discord Developer Portal [ТЫК](https://discord.com/developers/applications)
+
+<img src ="./assets/Screenshot_1.png">
+
+После создания приложения переходим ко вкладке "Bot".
+
+<img src ="./assets/Screenshot_2.png">
+
+Далее создаём бота нажав на кнопку "Add Bot" и подтверждаем создание.
+
+<img src ="./assets/Screenshot_3.png">
+
+<img src ="./assets/Screenshot_4.png">
+
+Далее получаем токен бота нажав на "Reset Token". После получения токена сохраните его в надёжном месте (не в чате Discord :D ).
+
+<img src ="./assets/Screenshot_5.png">
+
+Далее включаем интенты бота (нужно спуститься вниз и включить 3 переключателя).
+
+<img src ="./assets/Screenshot_6.png">
+
+Всё готово! Теперь мы можем использовать нашего бота!

README.md

@@ -1,2 +1,52 @@
-# DiscordRewardSystem
-Система поощрений игроков для Discord серверов от MineServ
+# MineServ Discord Rewards - крутой бот от мониторинга для вашего Discord сервера!
+
+MineServ Discord Rewards - это хороший способ наградить игроков вашего сервера за голосование на мониторинге MineServ.
+
+Данный бот добавит на ваш Discord сервер систему баллов, за которые ваши игроки смогут купить роли на сервере, которые настраиваются в конфиге.
+
+Функционал данного бота со временем будет только расширяться и будут добавляться новые способы наградить игроков внутри вашего Discord сервера.
+
+Настройка бота -
+
+Гайд о том, как создать бота в Discord [тык](./CreateBot.md)
+
+Пример конфигурации -
+    
+```json
+    {
+        "Discord":{
+            "token": "",//Токен бота.
+            "prefix": "!"//Префикс бота на Discord сервере.
+        },
+
+        "Rewards": {
+            "WebServerPort": "80",//Порт веб сервера, на который будет отправлять запросы MineServ (обязательно открытый).
+            "SecretKey":"",//Секретный ключ, который можно посмотреть на странице редактирования проекта.
+            "Reward": "100",//Колличество баллов, которое будет выдаваться игроку за 1 голос.
+
+            "Role1": {
+                "Price": "0",//ID первой роли, которую можно будет купить за баллы.
+                "RoleID": "null"//Цена первой роли, оторую можно будет купить за баллы. Если стоит null, то бот не будет учитывать данную роль!
+            },
+            "Role2": {
+                "Price": "0",//ID второй роли, которую можно будет купить за баллы.
+                "RoleID": "null"//Цена второй роли, оторую можно будет купить за баллы. Если стоит null, то бот не будет учитывать данную роль!
+            },
+            "Role3": {
+                "Price": "0",//ID третьей роли, которую можно будет купить за баллы.
+                "RoleID": "null"//Цена третьей роли, оторую можно будет купить за баллы. Если стоит null, то бот не будет учитывать данную роль!
+            },
+            "Role4": {
+                "Price": "0",//ID четвёртой роли, которую можно будет купить за баллы.
+                "RoleID": "null"//Цена четвёртой роли, оторую можно будет купить за баллы. Если стоит null, то бот не будет учитывать данную роль!
+            },
+            "Role5": {
+                "Price": "0",//ID пятой роли, которую можно будет купить за баллы.
+                "RoleID": "null"//Цена пятой роли, оторую можно будет купить за баллы. Если стоит null, то бот не будет учитывать данную роль!
+            }
+        },
+
+        "thumbImage": "https://media.discordapp.net/attachments/1057078822375264349/1066034808523866223/WoWqWgf5J4U.png",
+        "footerText": "MineServ.top | Rewards"
+    }
+```