ihrz/README.md

iHrz in ts!

# 🌐 Official iHorizon Repo  

# How to using this packages ?

## Step 1: Install the package

```
npm install ihrz
```

Create a new file called `ihrz.js` in your project's root directory and add the following

```js
const { iHorizonBuilder } = require("ihrz");

new iHorizonBuilder(
    {
        discord: {

            token: "",
            // The Discord Bot Token

            phonePresence: false,
            // If the bot have Bot Activity Presence

            messageCommandsMention: false,
			/* If is in true, the message commands (prefix commands) are trigerable with @Bot-Mention,
			else, change propriety defaultMessageCommandsPrefix bellow for your default-prefix
			*/

            defaultMessageCommandsPrefix: "-"
			// The message commands prefix if your choose to use prefix instead of bot mention as prefix
        },

        core: {
            blacklistPictureInEmbed: "",
			// The image of the blacklist's Embed (When blacklisted user attempt to interact with the bot)

            guildLogsChannelID: "",
            // The channel where the robot informs of the arrival on a server or when it leaves.

            reportChannelID: "",
            // The channel where the robot informs of a bug reported by a user of the bot.
        },

        command: {

            alway100: []
            /*
            For love command, if you want for specific couple of user, 
            always show 100% for their love, adding it to the array
            Format: {USER_ID_ONE}x{USER_ID_TWO}
            */

        },

        owner: {

            ownerid1: "",

            ownerid2: "",
            /*
            This owners have different permissions than the others in the db,
            
            * They are allowed to use /eval command everywhere.
            * They can't be unowner by owner who are in the Database.
            * They can't be blacklisted by owner who are in the Database.
            * They can't be banned by owner who are in the Database.
            */

            owners: []
			// OPTIONAL CONFIG FIELD
        },

        console: {

            emojis: {

                OK: "✅", ERROR: "❌", HOST: "💻", KISA: "👩", LOAD: "🔄"

            }

        },
    }
).start()
```

**iHorizon** is a powerful **Discord bot** written in [TypeScript](https://www.typescriptlang.org/) using [discord.js](https://npmjs.com/discord.js)!  
It offers a **large variety of features**, including:  

✅ Moderation  
✅ Invite management  
✅ Guild configuration  
✅ Fun commands  
✅ Music playback  
✅ Giveaways  
✅ Backups  
... and much more!  

![GitHub Release](https://img.shields.io/github/v/release/ihrz/ihrz)  
![GitHub Repo stars](https://img.shields.io/github/stars/ihrz/ihrz)  

---  

## 🌍 Supported Languages  

- 🇪🇬 Arabic Egyptian  
- 🇬🇧 English  
- 🇫🇷 French  
- 🤬 Rude French (Troll)  
- 🇮🇹 Italian  
- 🇩🇪 German  
- 🇯🇵 Japanese  
- 🇪🇸 Spanish  
- 🇷🇺 Russian  
- 🇵🇹 Portuguese  

---  

## 🏆 Contributor's Wall  

| Contributor | GitHub | Pronouns |
|------------|--------|----------|
| **Kisakay** | [GitLab](https://gitlab.com/Kisakay) | She/Her |
| **IrisWeb** | [GitHub](https://github.com/irisihrz) | She/Her |
| **Noémie** | [GitHub](https://github.com/name-shitty-github-profile) | She/Her |
| **Wyene** | [GitHub](https://github.com/tryedandcatched) | He/Him |

---  

## 📜 Origin  

🚀 The bot was **developed by Kisakay** and was first released in **September 2020** using `discord.js` v12.  
🎉 It now runs on the **latest version** of `discord.js`, featuring a strong and modular architecture!  

---  

## 🆓 Is it Free?  

**iHorizon** is licensed under [`CC BY-NC-SA 4.0`](https://creativecommons.org/licenses/by-nc-sa/4.0/).  

### ✅ Allowed:  
✔ **Share** — Copy and redistribute in any medium or format  
✔ **Adapt** — Remix, transform, and build upon it  

### ❌ Not Allowed:  
❌ **Attribution** — You must give proper credit & indicate changes  
❌ **NonCommercial** — No commercial use allowed  
❌ **ShareAlike** — Derivatives must keep the same license  
❌ **No additional restrictions** — No legal or technological barriers  

---  

## 🛠 How to Self-Host?  

### 📌 Requirements  
- [Bun](https://bun.sh)

⚠ **Windows users**: iHorizon **can't be hosted directly** on Windows 10/11.  
👉 Use **[WSL](https://learn.microsoft.com/en-us/windows/wsl/install)** (Windows Subsystem for Linux) instead!  

### ⚙ Bot Configuration  
1️⃣ Open [`config.example.ts`](https://gitlab.com/ihrz/ihrz/blob/dev/src/files/config.example.ts)  
2️⃣ Enter your details  
3️⃣ Rename the file to `config.ts`  

### 🚀 Running on Linux & macOS  

```bash
bun i

# If you see an error, install bun and resource your terminal.

bun .
```

## 🚀 NpmJS Method  

Working: [See more](https://npmjs.com/ihrz)  

# 🔥 About the Bot  

🔹 Trusted by more than 330,000 users  
🔹 Used in 1,000+ servers 🎉  
<br>
🔹 Certified by Discord and growing fast!  

📌 Join the official iHorizon Discord support server:  
🌍 [Official Server](http://discord.ihorizon.org/) | 🔗 [Backup Link](https://discord.gg/ZpBPGNsAsu)  

📌 Invite iHorizon to your server:  
🤖 [Click Here](https://discord.com/api/oauth2/authorize?client_id=945202900907470899&permissions=8&scope=bot)  

📌 Need help? Contact the owner via Discord:  
👤 `kisakay` and `irisbylolirock`

# 👤 About the Owner  

💖 **Kisakay** has not changed their identity but embraced who they truly are.  
💜 She now goes by she/her pronouns.  

📜 In the `LICENSE` files, the name `Anaïs Saraiva` appears as the owner.  
<br>
🇨🇦 Noémie : She is even prettier than most :D

🎀 Camille : She is really pretty.

## ❗ Remarks  

🚨 Any form of hate towards contributors will not be tolerated.<br>
🚨 Regardless of the type or level of hate.  

✨ Thank you for using iHorizon!🚀