# Aboutme

<figure><img src="https://4142029210-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpMJjR6n9iM9JkgxePTuN%2Fuploads%2FBLOeleKB03C0qTBV4k29%2Flucycircle.png?alt=media&#x26;token=90f45c80-003c-47c3-9427-5430cb682e72" alt="" width="188"><figcaption><p>LUCY HEARTFILIA</p></figcaption></figure>

Admin, AutoMod, Anime, Economy, Fun, Giveaway, Image, Invite, Information, Moderation, Music, Owner, Social, Statistics, Suggestion, Ticket, Utility and More...

### 🔗 Resource Links

* 🤖 Demo Bot:[ Invite Here](https://discord.com/api/oauth2/authorize?client_id=928966154817523723\&permissions=8\&scope=bot%20applications.commands)
* 🤝 Support Server: [Join Here](https://discord.gg/WFfjrQxnfH)
* 📂 Documentation URL: [Visit Here](https://lrmn.gitbook.io/lucy/additional/guides)
* 🐳 Docker Image: [Hub](https://hub.docker.com/r/hai-lucy/lucy)
* 🚀 Hoosted: [Hop.io](https://hop.io)
* 🌌 Dashboard: [Dashboard](https://lucy.hop.sh/selector)

### 📦 Prerequisites

* [Node.js](https://nodejs.org/en/) v16.11.0 or higher
* [Git](https://git-scm.com/downloads)
* [MongoDB](https://www.mongodb.com)

### 🚀 Getting Started

* Open the terminal and run the following commands

```
git clone https://github.com/Hai-Lucy/lucy.git
cd lucy
npm install
```

* Wait for all the dependencies to be installed
* Rename `.env.example` to `.env` and fill the values
* Optionally edit `config.js`
* Type `npm run start` to start the bot

If you need any additional help, make sure to read our guides here

\\

## ✨ Features ✨

#### 📡 **Advanced Dashboard**

* Manage your servers and make your server-specific settings!
* Make custom adjustments easy!

#### 🛑 **Powerful Moderation:**

* **Moderation Commands.**\
  \&#xNAN;*Commands:* `ban`, `unban`, `timeout`, `voice moderation`, `deafen`, `move`, `warn`, `setnick`, ...
* **Multi-Function Purge Commands.**\
  \&#xNAN;*Commands:* `purge`, `purge attach`, `purge bots`, `purge links`, `purge token`, `purge user`, ...

#### 🤖 **Auto Moderation:**

* **Anti system**\
  \&#xNAN;*Commands:* `anti ghostping`, `anti spam`, `anti massmention`, ...
* **Auto Delete system**\
  \&#xNAN;*Commands:* `autodelete attachments`, `autodelete invites`, `autodelete links`, `autodelete maxlines`, ...
* **AutoMod system**\
  \&#xNAN;*Commands:* `automod status`, `automod strikes`, `automod action`, `automod debug`, `automod whitelist`, ...

#### ⚙️ **Admin Configuration:**

* **Let a bot be the server's assistant!**\
  \&#xNAN;*Commands:* `autorole`, `farewell`, `welcome`, `counters`, `flag translation`, `reaction roles`, ...
* **Make custom settings for your own server.**\
  \&#xNAN;*Commands:* `setprefix`, `maxwarns`, `modlog`...

#### 💁 **Information Gathering:**

* **User Context Interactions**
* **Advanced Information** Get deep information about a user, channel, role, etc.

#### 🎵 **Music:**

* **LossLess Music!** Enjoy high quality lossless music
* **Multi-Platform** Play music from YouTube, SoundCloud, Spotify, and more
* **Filters** Apply filters to your music and spice it up

#### 🎉 **Giveaways:**

* **Easy to use** Create giveaways with ease
* **Role specific** giveaways
* **Customizable** Customize the giveaway to your liking
* **Limitless** Create unlimited giveaways

#### 🫂 **Social Content:**

* **You Have A CV In Each Server-Specific Bot!**\
  \&#xNAN;*Commands:* `rep`, `rep view`...
* **Do You Love Someone?**\
  \&#xNAN;*Commands:* `rep give`...

#### 🎟 **Ticket System:**

* **Make Supporting Members A Breeze With Tickets!**\
  Highly customizable ticket system with staff roles
* **Multiple Categories**\
  Don't Want The Tickets To Be Everywhere? Categorize them using select menus

#### 📉 **Stats Tracking:**

* **Levelling** Track your server's activity with a level system
* **Leaderboards** See who is the most active user in your server
* **Customizable System** Configure the levelup message, rank cards to your liking

#### 🙋‍♂️ **Suggestions:**

* **Get Suggestions From Server Members To Help Your Server Become The Best!**\
  \&#xNAN;*Commands:* `suggest`, `suggestion`...
* **Accept Or Decline The Suggestions And Customize Them To The Max!**\
  \&#xNAN;*Commands:* `suggestion status`, `suggestion channel`, `suggestion appch`, `suggestion rejch`, `suggestion approve`, `suggestion staffadd`, `suggestion staffremove`...

#### ⚒️ **Utility Commands:**

* **Need Some Help With Something? Use The Utility Commands To Find Out The Answer To It**\
  \&#xNAN;*Commands:* `bigemoji`, `covid`, `pokedex`, `urban`, `weather`, ...
* **Need Help With Some More Stuff?**\
  \&#xNAN;*Commands:* `help`, `proxies`, `translate`, `paste`, ...

#### ⭐ **Anime Content:**

* **Love Anime? Express You Love To Someone Using The React Commands**\
  \&#xNAN;*Commands:* `react`, `hug`, `kiss`, `cuddle`, `pat`, `poke`, `slap`, `smug`, ...

#### 🪙 **Economy System:**

* **Want To Become Richest? Use The Economy Commands!**\
  \&#xNAN;*Commands:* `bank`, `daily`, `beg`, `gamble`...
* **Give People Money, Check Your Balance, Or Just Flex!**\
  \&#xNAN;*Commands:* `bank balance`, `bank deposit`, `bank withdraw`, `bank transfer`, ...

#### 😁 **Fun Commands:**

* **Have Some Fun In Your Server!**\
  \&#xNAN;*Commands:* `animal`, `facts`, `meme`, `flip`, ...
* **Play Games And Enjoy Yourself**\
  \&#xNAN;*Commands:* `snake`, `together`, `flip coin`, `flip text`, ...

#### 📨 **Invite Tracking:**

* **Track who has been inviting people to your server!**
* **Invite Ranks!** Inviter can get awesome rewards and be recognised
* **Configure these settings and customize them to your liking!**\
  \&#xNAN;*Commands:* `resetinvites`, `addinvites`, `invitesimport`, `inviterank`...

#### 📷 **Image Manipulation:**

* **Customize other peoples avatars**\
  \&#xNAN;*Commands:* `blur`, `greyscale`, `invert`, `pixelate`, `blur`, `sepia`, `sharpen`, `ad`, `affect`, `beautiful`, `color`...
* **Make some images by yourself or make some art**\
  \&#xNAN;*Commands:* `bobross`, `confusedstonk`, `delete`, `facepalm`, `hitler`, `jail`, `jokeoverhead`, `karaba`, `mms`, `notstonk`, `poutine`, `rainbow`, `rip`, `shit`, `stonk`, `tatoo`, `thomas`, `trash`, `wanted`, `wasted`, ...

\\
