https://github.com/wolfstar-project/wolfstar
A multipurpose Discord Bot designed to carry out most of your server's needs with great performance and stability. Fork of https://github.com/skyra-project/skyra
https://github.com/wolfstar-project/wolfstar
bot discord discord-bots discordjs moderation sapphire
Last synced: 13 days ago
JSON representation
A multipurpose Discord Bot designed to carry out most of your server's needs with great performance and stability. Fork of https://github.com/skyra-project/skyra
- Host: GitHub
- URL: https://github.com/wolfstar-project/wolfstar
- Owner: wolfstar-project
- License: apache-2.0
- Created: 2024-05-21T17:30:42.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:19:23.000Z (6 months ago)
- Last Synced: 2024-10-29T16:01:37.256Z (6 months ago)
- Topics: bot, discord, discord-bots, discordjs, moderation, sapphire
- Language: TypeScript
- Homepage: https://wolfstar.rocks
- Size: 4.64 MB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-discord - Wolfstar
- awesome-discord - Wolfstar
README
# WolfStar
# WolfStar
A powerful bot designed to enhance your server experience.
[Official Site][official-site] · [Blog][blog] · [WolfStar Invite Link][invite-link] · [Support Server][discord-link] · [Feedback][github-issues-link]
[![][github-release-shield]][github-release-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][discord-shield]][discord-link]
[![][codecov-shield]][codecov-link]
[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
[![][pr-welcome-shield]][pr-welcome-link]
**Share WolfStar Repository**
[![][share-linkedin-shield]][share-linkedin-link]
[![][share-reddit-shield]][share-reddit-link]
[![][share-telegram-shield]][share-telegram-link]
[![][share-whatsapp-shield]][share-whatsapp-link]
[![][share-x-shield]][share-x-link]
Pioneering the new age of server moderation management. Built for you, the Super Admin.
Table of contents
#### TOC
- [👋🏻 Welcome to WolfStar](#-welcome-to-wolfstar)
- [✨ Features](#-features)
- [🛳 Self-Hosting WolfStar](#-self-hosting-wolfstar)
- [🚀 Self-Hosting WolfStar Requirements](#-self-hosting-wolfstar-requirements)
- [🉑 Translating WolfStar](#-translating-wolfstar)
- [⌨️ Local Development](#️-local-development)
- [🤝 Contributing](#-contributing)
- [❤️ Sponsor](#️-sponsor)
####
## 👋🏻 Welcome to WolfStar
WolfStar is a powerful multi-purpose bot for moderation.
## ✨ Features
- **Role Management**: Easily manage roles and permissions.
- **Moderation**: WolfStar features a large repository of 15 moderation actions plus some automated systems such as no mention spam, caps and attachment filters, and more.
- **Multiple Language**: WolfStar features two languages, English and Spanish (though not completely finished), and will support more languages in the future.
- **Logging**: WolfStar features member logs, moderation logs, message logs, and so on. Alternatively, there is an option to set up a custom greeting and farewell message and channel with placeholders.
## 🚀 Self-Hosting WolfStar Requirements
- **Node.js**: WolfStar is built on Node.js, so you will need to have Node.js installed.
- **PostgreSQL**: WolfStar uses PostgreSQL as its database, so you will need to have a PostgreSQL server running.
- **InfluxDB**: WolfStar uses InfluxDB to keep anonymous metrics on bot usage. This is optional and can be disabled.
- **Sentry**: WolfStar uses Sentry to log errors. This is optional and can be disabled.
## 🛳 Self-Hosting WolfStar
The developer team does not support the idea of other self-hosted instances of WolfStar. The team prides itself on providing the best experience and support for the end-users. As such, an offshoot or unaffiliated mirror of WolfStar may cause ill effects on the reputation and image of WolfStar. If you wish to see new features implemented, please refer to the developing guidelines linked above.
In addition, WolfStar was built with a dependence on many services which need consistent maintenance and oversight in order to function and behave properly. These include, but are not limited to:
- **InfluxDB**: To keep anonymous metrics on bot usage.
- **PostgreSQL**: As database.
- Other external APIs, each requiring their own individual API keys.
With this in mind, it is also worth noting that WolfStar will in no way be capable of running on services such as [Glitch][glitch] or [Heroku][heroku]. A dedicated VPS (Virtual Private Server) is required in order to maintain the proper production environment.
## 🉑 Translating WolfStar 
We use **Crowdin** to translate WolfStar's messages into different languages. If you'd like to help by contributing new translations or improving existing ones, [**click here**](https://translation.wolfstar.rocks). Thanks for any contributions!
## ⌨️ Local Development
Refer to [CONTRIBUTING.md][set-up - refer to contributing.md] for detailed setup instructions.
## 🤝 Contributing
Thank you to all the people who already contributed to WolfStar Project!
## ❤️ Sponsor
If you like WolfStar and want to support the project, consider making a donation. Every contribution helps to maintain and improve the bot.
[][ko-fi-link]
[][patreon-link]
[][github-sponsor-link]
Thank you for your support!
[ko-fi-link]: https://ko-fi.com/redstar071
[patreon-link]: https://www.patreon.com/WolfStarBot
[github-sponsor-link]: https://github.com/sponsors/wolfstar-project
---
[![][back-to-top]](#readme-top)
---
📝 License
Copyright © 2024 [WolfStar][profile-link].
This project is [Apache 2.0](./LICENSE) licensed.
[wolfstar-invite-link]: https://invite.wolfstar.rocks
[glitch]: https://glitch.com
[heroku]: https://heroku.com
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
[blog]: https://blog.wolfstar.rocks
[codecov-link]: https://codecov.io/gh/wolfstar-project/wolfstar
[codecov-shield]: https://img.shields.io/codecov/c/github/wolfstar-project/wolfstar?labelColor=black&style=flat-square&logo=codecov&logoColor=white
[codespaces-link]: https://codespaces.new/wolfstar-project/wolfstar
[codespaces-shield]: https://github.com/codespaces/badge.svg
[discord-link]: https://discord.gg/gqAnRyUXG8
[discord-shield]: https://img.shields.io/discord/830481105261821952?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
[discord-shield-badge]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge
[github-contributors-link]: https://github.com/wolfstar-project/wolfstar/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/wolfstar-project/wolfstar?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/wolfstar-project/wolfstar/network/members
[github-forks-shield]: https://img.shields.io/github/forks/wolfstar-project/wolfstar?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/wolfstar-project/wolfstar/issues
[github-issues-shield]: https://img.shields.io/github/issues/wolfstar-project/wolfstar?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/wolfstar-project/wolfstar/blob/main/LICENSE
[github-license-shield]: https://img.shields.io/badge/license-apache%202.0-white?labelColor=black&style=flat-square
[github-project-link]: https://github.com/wolfstar-project/wolfstar/projects
[github-release-link]: https://github.com/wolfstar-project/wolfstar/releases
[github-release-shield]: https://img.shields.io/github/v/release/wolfstar-project/wolfstar?color=369eff&labelColor=black&logo=github&style=flat-square
[github-releasedate-link]: https://github.com/wolfstar-project/wolfstar/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/wolfstar-project/wolfstar?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/wolfstar-project/wolfstar/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/wolfstar-project/wolfstar?color=ffcb47&labelColor=black&style=flat-square
[issues-link]: https://img.shields.io/github/issues/wolfstar-project/wolfstar.svg?style=flat
[official-site]: https://wolfstar.rocks
[pr-welcome-link]: https://github.com/wolfstar-project/wolfstar/pulls
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[profile-link]: https://github.com/wolfstar
[set-up - refer to contributing.md]: https://github.com/wolfstar-project/.github/blob/main/.github/CONTRIBUTING.md
[share-linkedin-link]: https://linkedin.com/feed
[share-linkedin-shield]: https://img.shields.io/badge/-share%20on%20linkedin-black?labelColor=black&logo=linkedin&logoColor=white&style=flat-square
[share-reddit-link]: https://www.reddit.com/submit?title=Check%20this%20GitHub%20repository%20out%20%F0%9F%A4%AF%20WolfStar%20-%20A%20powerful%20bot%20designed%20to%20enhance%20your%20server%20experience.%20%23bot%20%23server%20%23openAI&url=https%3A%2F%2Fgithub.com%2Fwolfstar-project%2Fwolfstar
[share-reddit-shield]: https://img.shields.io/badge/-share%20on%20reddit-black?labelColor=black&logo=reddit&logoColor=white&style=flat-square
[share-telegram-link]: https://t.me/share/url"?text=Check%20this%20GitHub%20repository%20out%20%F0%9F%A4%AF%20WolfStar%20-%20A%20powerful%20bot%20designed%20to%20enhance%20your%20server%20experience.%20%23bot%20%23server%20%23openAI&url=https%3A%2F%2Fgithub.com%2Fwolfstar-project%2Fwolfstar
[share-telegram-shield]: https://img.shields.io/badge/-share%20on%20telegram-black?labelColor=black&logo=telegram&logoColor=white&style=flat-square
[share-whatsapp-link]: https://api.whatsapp.com/send?text=Check%20this%20GitHub%20repository%20out%20%F0%9F%A4%AF%20WolfStar%20-%20A%20powerful%20bot%20designed%20to%20enhance%20your%20server%20experience.%20https%3A%2F%2Fgithub.com%2Fwolfstar-project%2Fwolfstar%20%23bot%20%23server%20%23openAI
[share-whatsapp-shield]: https://img.shields.io/badge/-share%20on%20whatsapp-black?labelColor=black&logo=whatsapp&logoColor=white&style=flat-square
[share-x-link]: https://x.com/intent/tweet?hashtags=bot%2Cserver%2CopenAI&text=Check%20this%20GitHub%20repository%20out%20%F0%9F%A4%AF%20WolfStar%20-%20A%20powerful%20bot%20designed%20to%20enhance%20your%20server%20experience.&url=https%3A%2F%2Fgithub.com%2Fwolfstar-project%2Fwolfstar
[share-x-shield]: https://img.shields.io/badge/-share%20on%20x-black?labelColor=black&logo=x&logoColor=white&style=flat-square
[invite-link]: https://invite.wolfstar.rocks