https://github.com/ppx005/romod

Discord to Roblox remote moderation tool
https://github.com/ppx005/romod

discord-bot discord-js roblox-api roblox-discord-bot

Last synced: 4 months ago
JSON representation

Discord to Roblox remote moderation tool

• Host: GitHub
• URL: https://github.com/ppx005/romod
• Owner: PPX005
• Created: 2024-08-10T15:24:36.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-09-07T11:32:45.000Z (5 months ago)
• Last Synced: 2024-10-12T03:20:18.360Z (4 months ago)
• Topics: discord-bot, discord-js, roblox-api, roblox-discord-bot
• Language: JavaScript
• Homepage:
• Size: 62.5 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# RoMod

![Version](https://img.shields.io/badge/version-1.0.0-brightgreen.svg)

## 📋 Information

Discord to Roblox remote moderation tool that utilizes roblox's cloud API. (MessagingService and Userrestrictions) 

- **Language**: Javascript (node.js) and Luau (roblox side).

### Features

- 🔧 Remote Kick

- 🔧 Remote Ban / Tempban + Unban

- 🔧 Ban checker

## ⚙️ Installation

1. **Clone the repository:**

    ```bash

    git clone https://github.com/PPX005/RoMod.git

    ```

2. **Navigate to the project directory:**

    ```bash

    cd your-path/RoMod

    ```

3. **Install dependencies:**

    Run the following command to install all required dependencies listed in `package.json`:

    ```bash

    npm install

    ```

    

4. **Fill in the `config.json` file**

	```json

	{

	"token": "DISCORD TOKEN https://discord.com/developers/applications",

	"clientId": "Bot's client id",

	"guildId": "Guild (id) where the bot is running (deployment purposes)",

	"UNIVERSE_ID" : "your game's universe id (not the same as the place id) create.roblox.com",

	"OPENCLOUD_KEY": "your cloud api key https://create.roblox.com/dashboard/credentials",

 	"roleId" : "Role ID of the role that will enable users to execute commands"

	}

	```

5. **Paste the `roblox/MSHandler.lua` contents into a **script** in `ServerScriptService` in the game you wish to remotely moderate (Roblox Studio)**

 

6. **Run the bot:**

   Run: (to create the commands in your server)

    ```bash

    node deploy-commands.js

    ```

    And then run: (to start the bot)

    ```bash

    node index.js

    ```

## How to configure the roblox opencloud key:

Make sure these permissions are enabled for the desired game:

![image](https://github.com/user-attachments/assets/d52db85f-6b6e-4846-8b13-e253d8d5049a)

## Demonstration:

[![Discord to Roblox Bot](https://cdn.discordapp.com/attachments/744459730910445690/1281940138682880023/image.png?ex=66dd8b4a&is=66dc39ca&hm=27459f343cb11413dc1d4a2c3d4f1efcb4f3ccada205579747f1a92ce9a9e8b9&)](https://youtu.be/MYVkqKgUPn0)

## Disclamer:

This is the first version of the bot. There will progressively be updates and new features will be added. There might be some issues and bugs which ill be happy to fix if asked politely. Discord: @ppx005