|
| 1 | +### `Read this page before asking any questions` |
| 2 | +> **[Important Guides](https://github.com/Refloow/Discord-Channel-Moderator#important-links)**<br> |
| 3 | +> **[Join our DISCORD](discord.gg/4enDY8yhuS)**<br> |
| 4 | +
|
| 5 | +> [!IMPORTANT] |
| 6 | +> [Make sure to read this readme to the end]([https://store.steampowered.com/account/notificationsettings](https://github.com/Refloow/Discord-Channel-Moderator#important-links)) |
| 7 | +
|
| 8 | +> [!CAUTION] |
| 9 | +> [Join our discord server <3](discord.gg/4enDY8yhuS) |
| 10 | +
|
| 11 | +<img width="614" height="409" alt="discord-channel-moderatorbannerpng" src="https://github.com/user-attachments/assets/ff6b2239-1076-4914-b21a-68c907dfca74" /> |
| 12 | + |
| 13 | +<h1 align= "center"><b> |
| 14 | + About |
| 15 | + </b> |
| 16 | +</h1> |
| 17 | + |
| 18 | +<p align= "center"> |
| 19 | +An free open source, discord moderation bot that helps you restrict certain things such as commands, links or filter words in channels where they were not allowed. |
| 20 | + <hr> |
| 21 | +</p> |
| 22 | + |
| 23 | + |
| 24 | +<p align= "center"> |
| 25 | + <img src="https://img.shields.io/github/package-json/v/Refloow/Discord-Channel-Moderator.svg" alt="GitHub package version"> |
| 26 | + </a> |
| 27 | + <a href="https://github.com/Refloow/Discord-Channel-Moderator/network"> |
| 28 | + <img src="https://img.shields.io/github/forks/Refloow/Discord-Channel-Moderator.svg?style=plastic" alt="GitHub forks"> |
| 29 | + </a> |
| 30 | + <a href="https://github.com/Refloow/Discord-Channel-Moderator/stargazers"> |
| 31 | + <img src="https://img.shields.io/github/stars/Refloow/Discord-Channel-Moderator.svg?style=plastic" alt="GitHub stars"> |
| 32 | + </a> |
| 33 | + <a href="https://raw.githubusercontent.com/Refloow/Discord-Channel-Moderator/master/LICENSE"> |
| 34 | + <img src="https://img.shields.io/badge/license-MIT-blue.svg?style=plastic" alt="GitHub license"> |
| 35 | + </a> |
| 36 | + <a href="https://discord.gg/XxvjjPs"> |
| 37 | + <img src="https://img.shields.io/discord/690327113039085600" alt="Support"> |
| 38 | + </a> |
| 39 | + <a href="https://en.wikipedia.org/wiki/Node.js"> |
| 40 | + <img src="https://img.shields.io/badge/Uses-Node.js-green" alt="Language"> |
| 41 | + </a> |
| 42 | + <a href="https://en.wikipedia.org/wiki/JavaScript"> |
| 43 | + <img src="https://img.shields.io/badge/language-JavaScript-yellow.svg" alt="Language"> |
| 44 | + </a> |
| 45 | + <a href="https://steamcommunity.com/tradeoffer/new/?partner=392773011&token=CncehZti"> |
| 46 | + <img src="https://img.shields.io/badge/steam-donate-yellow.svg" alt="Steam"> |
| 47 | + </a> |
| 48 | +</p> |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +<p align= "center"> |
| 53 | + <a href="https://refloow.com/cdonate" target="_blank"> |
| 54 | + <img src="https://img.shields.io/badge/-CRYPTO%20Donations-red"> |
| 55 | + </a> |
| 56 | +</p> |
| 57 | + |
| 58 | +<h3 align= "center"> Leave a star, we push updates based on activity </h3> |
| 59 | + |
| 60 | +- This project will receive constant updates and new features added ! |
| 61 | +- Make sure to leave an star on the projects repo! |
| 62 | + |
| 63 | +# Note: |
| 64 | + |
| 65 | +<hr> |
| 66 | + |
| 67 | +**To everyone who plan to sell our project by stating that they coded it or that they sell edited version.**<br> |
| 68 | +**Project is licensed under the MIT license**<br> |
| 69 | + |
| 70 | +### "`The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.`"<br> |
| 71 | + |
| 72 | +<br> |
| 73 | + |
| 74 | +This means that if you plan to sell our project to make quick buck please keep the copyright notice and copy of original license. <br> |
| 75 | +**In case of breaking licensing terms we may take legal charges against you.** |
| 76 | + |
| 77 | +Project is made open source and **free for all.**<br> |
| 78 | +**We cant prohibit reselling of our project but if you do please follow the licensing terms.**<br> |
| 79 | + |
| 80 | +<hr> |
| 81 | + |
| 82 | +# Important Links |
| 83 | + |
| 84 | +<hr> |
| 85 | + |
| 86 | +### `Setup Guide` |
| 87 | +> **[Step By Step Setup Guide](https://github.com/Refloow/Discord-Channel-Moderator/wiki)**(currenty writing)<br> |
| 88 | +### `Troubleshooting Guide` |
| 89 | +> **[List of common user made errors and how to solve them](https://refloow.com/Open-Source-Projects/troubleshooting)**<br> |
| 90 | +### `Contributions` |
| 91 | +> **[Want to contribute? Read how](https://github.com/Refloow/Discord-Channel-Moderator/blob/master/.github/CONTRIBUTING.md)**<br> |
| 92 | +### `Features` |
| 93 | +> **[See list of features](https://github.com/Refloow/Discord-Channel-Moderator/blob/master/.github/FEATURES.md)**<br> |
| 94 | +> **[See version changelogs](https://github.com/Refloow/Discord-Channel-Moderator/blob/master/.github/changelog.md)**<br> |
| 95 | +### `FAQ` |
| 96 | +> **[Frequently Asked Questions]()**(currenty writing)<br> |
| 97 | +
|
| 98 | +<hr> |
| 99 | + |
| 100 | + |
| 101 | + |
| 102 | +# DISCORD Support Server |
| 103 | + |
| 104 | +**https://discord.gg/XxvjjPs** |
| 105 | + |
| 106 | +<hr> |
| 107 | + |
| 108 | +# Support the project |
| 109 | +- **If you like the project and the fact that is free you can support us by giving an donation.** |
| 110 | +- We are accepting donations: |
| 111 | + |
| 112 | +1. Crypto: https://refloow.com/cdonate |
| 113 | +2. Steam: https://steamcommunity.com/tradeoffer/new/?partner=392773011&token=CncehZti |
| 114 | + |
| 115 | +<hr> |
| 116 | + |
| 117 | +# Want Improvements ? |
| 118 | + |
| 119 | +If you have some private requests feel free to contact main dev : https://steamcommunity.com/id/MajokingGames/<br> |
| 120 | +**Note that we wont add any platform breaking TOS Modifications to any of our existing or requested projects** |
| 121 | + |
| 122 | +<hr> |
| 123 | + |
| 124 | +# How to setup bot ? |
| 125 | + |
| 126 | +- Setup bots profile at https://discordapp.com/developers/applications |
| 127 | +- Enter bots token in configuration (Discord-Channel-Moderator/Settings/config.js) |
| 128 | +- Finish configuration how you like |
| 129 | +- Invite bot to your server |
| 130 | + |
| 131 | +- How bot operate: |
| 132 | + |
| 133 | + - To prevent other bots responding on commands in wrong channel add them to roles/members in channel where you want to restrict them and disable Text Premission - Send Messages & Read Messages |
| 134 | + - Add your bot that you host script on and set his TEXT PREMISSIONS - Read Messages & Manage Messages to true in channel you want bot to operate (Number of channels is not limited) |
| 135 | + - In the channels where you want commands to take place set bots TEXT PREMISSIONS - Read Messages & Manage Messages to false |
| 136 | + |
| 137 | + Check images in (Discord-Channel-Moderator/Settings/Server Setup Images) for visual guide |
| 138 | + |
| 139 | + |
| 140 | +## Stars over time |
| 141 | + |
| 142 | +[](https://starchart.cc/Refloow/Discord-Channel-Moderator) |
| 143 | + |
0 commit comments