/[sudobot]/trunk/README.md

Diff of /trunk/README.md

Parent Directory | Revision Log | View Patch Patch

-revision 414 by rakin,
Mon Jul 29 17:30:07 2024 UTC
+revision 572 by rakinar2,
Mon Jul 29 17:51:37 2024 UTC
 Line 1
  <p align="center">
- <img src="https://res.cloudinary.com/rakinar2/image/upload/v1659628446/SudoBot-new_cvwphw.png" height="200px" width="200px">
+ <a href="https://www.sudobot.org" title="Official Website of SudoBot" target="_blank">
+ <!--
+ <img src="https://res.cloudinary.com/rakinar2/image/upload/v1720629036/nnanzhwwmpa2k3ebw0yg.png" height="114px" width="348px">
+ -->
+ <img src="https://res.cloudinary.com/rakinar2/image/upload/v1720629036/ku8wq70utgbrbyhzdl9a.png" height="114px" width="348px">
+ </a>
  </p>
- <h1 align="center">SudoBot</h1>
+ <br />
  <p align="center">
- <a href="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml"><img src="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml/badge.svg" alt="Build"></a>
+ <a href="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml"><img src="https://img.shields.io/github/actions/workflow/status/onesoft-sudo/sudobot/build.yml?branch=main&event=push&style=flat&logo=github&logoColor=%23fff&label=Build&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60"></a>
- <img src="https://img.shields.io/github/license/onesoft-sudo/sudobot?label=License" alt="GitHub">
+ <a href="https://gnu.org/licenses/agpl-3.0.html"><img src="https://img.shields.io/github/license/onesoft-sudo/sudobot?style=flat&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2C77u%2FPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhRE9DVFlQRSBzdmcgUFVCTElDICItLy9XM0MvL0RURCBTVkcgMS4xLy9FTiINCgkiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj4NCjxzdmcgd2lkdGg9IjE5N3B4IiBoZWlnaHQ9IjE5N3B4IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSI%2BDQoJPGNpcmNsZSBjeD0iOTgiIGN5PSI5OCIgcj0iOTgiIGZpbGw9ImJsYWNrIi8%2BDQoJPGNpcmNsZSBjeD0iOTgiIGN5PSI5OCIgcj0iNzgiIGZpbGw9IndoaXRlIi8%2BDQoJPGNpcmNsZSBjeD0iOTgiIGN5PSI5OCIgcj0iNTUiIGZpbGw9ImJsYWNrIi8%2BDQoJPGNpcmNsZSBjeD0iOTgiIGN5PSI5OCIgcj0iMzAiIGZpbGw9IndoaXRlIi8%2BDQoJPHJlY3QgeD0iMTE1IiB5PSI4NSIgd2lkdGg9IjQ1IiBoZWlnaHQ9IjI1IiBmaWxsPSJ3aGl0ZSIvPg0KPC9zdmc%2B&logoColor=%23fff&label=License&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60" /></a>
- <img src="https://img.shields.io/github/package-json/v/onesoft-sudo/sudobot?label=Version" alt="GitHub package.json version">
+ <a href="https://www.codefactor.io/repository/github/onesoft-sudo/sudobot"><img alt="CodeFactor Grade" src="https://img.shields.io/codefactor/grade/github/onesoft-sudo/sudobot?style=flat&logo=codefactor&logoColor=%23fff&label=Codefactor&labelColor=%23000&cacheSeconds=60&link=https%3A%2F%2Fwww.codefactor.io%2Frepository%2Fgithub%2Fonesoft-sudo%2Fsudobot"></a>
- <img src="https://img.shields.io/github/commit-activity/w/onesoft-sudo/sudobot?label=Commit%20Activity" alt="GitHub commit activity">
+ <a href="https://github.com/onesoft-sudo/sudobot/releases/latest"><img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/onesoft-sudo/sudobot?style=flat&logo=npm&logoColor=white&label=Version&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60"></a>
- <a href="https://discord.gg/892GWhTzgs"><img src="https://img.shields.io/discord/964969362073198652?label=Support+Chat" alt="Discord"></a>
+ <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/w/onesoft-sudo/sudobot?style=flat&logo=git&logoColor=white&label=Commits&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60">
+ <a href="https://discord.gg/892GWhTzgs"><img alt="Dynamic JSON Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Fguilds%2F964969362073198652%2Fwidget.json&query=presence_count&suffix=%20online&style=flat&logo=discord&logoColor=white&label=Discord&labelColor=%23000&color=rgb(50%2C%2050%2C%2050)&cacheSeconds=60&link=https%3A%2F%2Fdiscord.gg%2F892GWhTzgs" alt="Discord" /></a>
  </p>
  <p align="center">
- A Discord bot for moderation purposes.
+ A free and open source Discord bot for moderation purposes. <a href="https://docs.sudobot.org/features/screenshots/">Click here</a> to see the screenshots.
  </p>
- ### Features
+ <!--
+ <p align="center">
- - Strong automoderation system with tools like anti-spam and anti-raid
+ <a href="https://github.com/onesoft-sudo/sudobot/releases/latest"><img alt="Download from GitHub" src="https://res.cloudinary.com/rakinar2/image/upload/v1702811535/kh7v7c5jb4v3na1e67mg.png" width="276" height="48"></a>
- - Useful moderation tools
+ <a href="https://sourceforge.net/projects/sudobot/files/latest/download"><img alt="Download from SourceForge" src="https://a.fsdn.com/con/app/sf-download-button" width="276" height="48" srcset="https://a.fsdn.com/con/app/sf-download-button?button_size=2x 2x"></a>
- - Secure
+ </p> -->
- - Fun commands
- ### Getting started
- You can request an invite for SudoBot [here](https://sudobot.everything-server.ml/).
- Alternatively, you can create your own Discord API application and then host SudoBot.
- ### Setup for Custom Hosting
- First, download the latest release or clone the repo by running:
- ```
+ ## ❗ Need Contributors
- git clone https://github.com/onesoft-sudo/sudobot
- ```
- Then go inside the project directory, and run the following command:
+ This project needs more contributors. Please look at the [Todos](https://github.com/onesoft-sudo/sudobot/blob/main/TODO.md) to see what you can do to help us. Of course you can add new features and/or fix/improve something that isn't listed in the todos! We'll be really thankful if you contribute.
- ```
+ If you like the bot, then please make sure to star this repository! And also if possible, you could help us by donating. As an open source project development team, we don't earn anything after all these hard work. Even a small donation of $1 can help us a lot.
- npm install -D
- ```
- Then open up the `config/config.json` file and change at least the following:
+ ### Features
- ```json
+ -   Strong auto moderation system with tools like anti-spam and anti-raid ([Click here](https://docs.sudobot.org/automoderation/#what-can-the-bot-do) to see the full list)
- {
+ -   Useful moderation tools and utilities
-     "global": {
+ -   Secure
-         "id": "set your home guild id",
+ -   Fun commands
-         "owners": ["set owner user ids here"],
+ -   Active development & support
-         ...
-     },
-     "guild id here": {
-        "prefix": "-",
-        "mod_role": "the mod role, users having it will be able to use the bot",
-        "gen_role": "general role id, which all users have",
-        "mute_role": "the muted role id",
-        "admin": "the admin role id. users having it will be immune to sudobot.",
-        ...
-     }
- }
- ```
- **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
+ ### Getting started
- Then copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed.
+ You can request an invitation for SudoBot [here](https://discord.gg/pazm3tqYh5), it's completely free, and you can ask us for help anytime.
+ Alternatively, you can create your own Discord API application and then host SudoBot.
- Build the project:
+ ### Setup for Custom Hosting
- ```
+ Please look at [this page](https://docs.sudobot.org/getting-started) of the documentation.
- npm run build
- ```
- Deploy slash commands globally:
+ ### Contributors [A-Z]
- ```
+ Thanks to all the active and indirect contributors!
- node deploy-commands.js
- ```
- Start the bot:
+ -   [Ar Rakin](https://github.com/virtual-designer) (Maintainer)
+ -   [dicoderin](https://github.com/dicoderin)
+ -   [GuynnR](https://github.com/GuynnR)
+ -   Hana (A Discord User)
+ -   [Kars](https://github.com/kars1996) (Contributed by giving away a domain to us)
+ -   [killerclaws12](https://github.com/killerclaws12)
+ -   [MonzterDev](https://github.com/MonzterDev)
+ -   [ninsaccplayzyt](https://github.com/ninsaccplayzyt)
+ -   [Ryanmello07](https://github.com/Ryanmello07) (Contributed by giving away a hosting server and by giving a lot of suggestions/ideas to us)
- ```
+ ### License
- npm start
- ```
- And if everything was configured correctly, you should not see an error and the bot should say `Logged in as [tag]!`.
+ SudoBot is licensed under the [GNU Affero General Public License v3.0](https://gnu.org/licenses/agpl-3.0.html). You can find the full license text in the [LICENSE](./LICENSE) file distributed in this repository.
- Then you can run the following command in Discord to make sure everything is working:
- ```
+ #### Exceptions
- -about
- ```
- That should show the bot information.
+ - [The emojis](https://www.onesoftnet.eu.org/downloads/sudo/emojis/) are licensed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).
- Congratulations! You've successfully set up your own instance of SudoBot!
+ - [The SudoBot Logo](https://res.cloudinary.com/rakinar2/image/upload/v1720629036/ku8wq70utgbrbyhzdl9a.png) is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+ - [The documentation website of SudoBot](https://docs.sudobot.org) is dual-licensed under the [GNU Affero General Public License v3.0](https://gnu.org/licenses/agpl-3.0.html) and the [GNU Free Documentation License v1.3](https://gnu.org/licenses/fdl-1.3.html).<br />Read the [README.md](./docs/README.md) file in the `docs` directory for more information.
+ - [BlazeBuild](./blazebuild), the build tool that SudoBot uses, is licensed under the [GNU General Public License v3.0](https://gnu.org/licenses/gpl-3.0.html).
  ### Support
- - **Email**: [email protected]
+ -   **Email**: [email protected]
- - **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)
+ -   **Website**: https://www.sudobot.org
+ -   **Discord Servers**: [OneSoftNet Server](https://discord.gg/892GWhTzgs)
+ ### Extra
+ -   **Download Emojis**: https://www.onesoftnet.eu.org/downloads/sudo/emojis/ <br />
+     Note that not all emojis are present there. You'll find the missing one's at [emoji.gg](https://emoji.gg).
+ -   **Dashboard**: https://github.com/onesoft-sudo/sudobot-dashboard <br />
+     The dashboard of SudoBot. Note that the dashboard is not complete yet.
+ Copyright © 2022-2024 OSN and all the contributors of SudoBot.

 Legend:



Removed from v.414
 


changed lines


 
Added in v.572
 Legend:



Removed from v.414
 


changed lines


 
Added in v.572
-Removed from v.414
+Added in v.572

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26