Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 36 additions & 56 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,29 @@
### `Read this page before asking any questions`
> **[Important Guides](https://github.com/OSL-Works/Discord-Channel-Moderator#important-links)**<br>
*Read this page before asking any questions*
> **[Important Links](#important-links)**

<p align="center">
<img width="600" height="100" src="https://discordapp.com/assets/e4923594e694a21542a489471ecffa50.svg">
<img width="600" height="100" src="https://discordapp.com/assets/e4923594e694a21542a489471ecffa50.svg">
</p>

<h1 align= "center"><b>
About
</b>
</h1>
<h1 align= "center">About</h1>

<p align= "center">
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.
<hr>
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.
</p>

---

<p align= "center">
<img src="https://img.shields.io/github/package-json/v/Refloow/Discord-Channel-Moderator.svg" alt="GitHub package version">
</a>
<a href="https://github.com/Refloow/Discord-Channel-Moderator/network">
<img src="https://img.shields.io/github/forks/Refloow/Discord-Channel-Moderator.svg?style=plastic" alt="GitHub forks">
<img src="https://img.shields.io/github/forks/Refloow/Discord-Channel-Moderator.svg" alt="GitHub forks">
</a>
<a href="https://github.com/Refloow/Discord-Channel-Moderator/stargazers">
<img src="https://img.shields.io/github/stars/Refloow/Discord-Channel-Moderator.svg?style=plastic" alt="GitHub stars">
<img src="https://img.shields.io/github/stars/Refloow/Discord-Channel-Moderator.svg" alt="GitHub stars">
</a>
<a href="https://raw.githubusercontent.com/Refloow/Discord-Channel-Moderator/master/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue.svg?style=plastic" alt="GitHub license">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="GitHub license">
</a>
<a href="https://discord.gg/XxvjjPs">
<img src="https://img.shields.io/discord/690327113039085600" alt="Support">
Expand All @@ -42,8 +39,6 @@ An free open source, discord moderation bot that helps you restrict certain thin
</a>
</p>



<p align= "center">
<a href="https://refloow.com/cdonate" target="_blank">
<img src="https://img.shields.io/badge/-CRYPTO%20Donations-red">
Expand All @@ -55,86 +50,71 @@ An free open source, discord moderation bot that helps you restrict certain thin
- This project will receive constant updates and new features added !
- Make sure to leave an star on the projects repo!

# Note:
## Note:

<hr>
To everyone who plan to sell our project by stating that they coded it or that they sell edited version:

**To everyone who plan to sell our project by stating that they coded it or that they sell edited version.**<br>
**Project is licensed under the MIT license**<br>
**Project is licensed under the MIT license**

### "`The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.`"<br>
> `The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.`

<br>
This means that if you plan to sell our project to make quick buck please keep the copyright notice and copy of original license.

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>
**In case of breaking licensing terms we may take legal charges against you.**

Project is made open source and **free for all.**<br>
**We cant prohibit reselling of our project but if you do please follow the licensing terms.**<br>
Project is made open source and **free for all.**

<br>
<hr>
**We cant prohibit reselling of our project but if you do please follow the licensing terms.**

# Important Links
## Important Links

<hr>

### `Setup Guide`
### Setup Guide
> **[Step By Step Setup Guide](https://github.com/OSL-Works/Discord-Channel-Moderator/wiki)**(currenty writing)<br>
### `Troubleshooting Guide`
### Troubleshooting Guide
> **[List of common user made errors and how to solve them](https://refloow.com/Open-Source-Projects/troubleshooting)**<br>
### `Contributions`
### Contributions
> **[Want to contribute? Read how](https://github.com/OSL-Works/Discord-Channel-Moderator/blob/master/.github/CONTRIBUTING.md)**<br>
### `Features`
### Features
> **[See list of features](https://github.com/OSL-Works/Discord-Channel-Moderator/blob/master/.github/FEATURES.md)**<br>
> **[See version changelogs](https://github.com/OSL-Works/Discord-Channel-Moderator/blob/master/.github/changelog.md)**<br>
### `FAQ`
> **[Frequently Asked Questions]()**(currenty writing)<br>

<hr>
### FAQ
> **[Frequently Asked Questions]()** (currenty writing)



# DISCORD Support Server
## Discord Support Server

**https://discord.gg/XxvjjPs**

<hr>

# Support the project
## Support the project
- **If you like the project and the fact that is free you can support us by giving an donation.**
- We are accepting donations:

1. Crypto: https://refloow.com/cdonate
2. Steam: https://steamcommunity.com/tradeoffer/new/?partner=994828078&token=XEUdbqp6

<hr>
## Want Improvements ?

# Want Improvements ?
If you have some private requests feel free to contact main dev : https://steamcommunity.com/id/MajokingGames/ or mail at refloowlibrarycontact@gmail.com

If you have some private requests feel free to contact main dev : https://steamcommunity.com/id/MajokingGames/<br>
Or mail at refloowlibrarycontact@gmail.com <br>
**Note that we wont add any platform breaking TOS Modifications to any of our existing or requested projects**

<hr>

# How to setup bot ?
## How to setup the bot ?

- Setup bots profile at https://discordapp.com/developers/applications
- Enter bots token in configuration (Discord-Channel-Moderator/Settings/config.js)
- Finish configuration how you like
- Invite bot to your server

- How bot operate:
## How the bot operate

- 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
- 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)
- In the channels where you want commands to take place set bots TEXT PREMISSIONS - Read Messages & Manage Messages to false

*Check images in (Discord-Channel-Moderator/Settings/Server Setup Images) for visual guide*

- 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
- 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)
- In the channels where you want commands to take place set bots TEXT PREMISSIONS - Read Messages & Manage Messages to false

Check images in (Discord-Channel-Moderator/Settings/Server Setup Images) for visual guide


## Stars over time
## Stargazers over time

[![Stargazers over time](https://starchart.cc/Refloow/Discord-Channel-Moderator.svg)](https://starchart.cc/Refloow/Discord-Channel-Moderator)