jean_racine_bot

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

jean_racine_bot

★ 22 Open GitHub ↗

Discord Root-Me bot - built with Discord.js

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Jean Racine

### RootMe bot

Root-Me Discord bot using `Discord.js` and Slash Commands.  
built by [@kernoeb](https://www.root-me.org/kernoeb).

### Features

- Add user / Remove user
- Scoreboard with auto update / refresh
- Notifications (new challenge added or succeed, new validation, new solution)
- Search a user or a challenge id
- Information about a challenge or a user
- Chart (leaderboard)

### Commands

`/adduser <id>` : Add a user (id)  
`/challenge <id_or_name>` : Information about a challenge  
`/chart` : Leaderboard chart  
`/createglobalscoreboard` : Create a global scoreboard  
`/deluser <id>` : Delete a user (id)  
`/getlastchallenges` : Get the last challenges   
`/help` : Help  
`/init` : Initialize the bot in the channel  
`/ping` : Ping pong  
`/scoreboard <category>` : Scoreboard (with optional category)  
`/searchuser <name>` : Search a user by name  
`/user <id_or_name>` : Information about a user (id or name)  
`/topctftime <locale>` : CTFTime TOP 10 (global / country)  
`/nextctf <numberctf>` : Next CTF of week (CTFTime)  
`/pickctf <id>` : Vote for a specific CTF (CTFTime)

---

## Prerequisites

- Docker > 20
- Create a Discord bot and invite it : https://discord.com/api/oauth2/authorize?client_id=xxxx&permissions=2684472384&scope=applications.commands%20bot (replace xxxx with the bot client id)

> I'm using Docker version 20.10.x and Docker Compose (not docker-compose)

## Installation

- Clone the repository, or only download `.env.example`, `docker-compose.yml` and `update.sh` :

```bash
mkdir -p ./jean_racine && cd ./jean_racine
curl https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/update.sh -o update.sh
curl https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/docker-compose.yml -o docker-compose.yml
curl https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/.env.example -o .env.example
chmod u+x update.sh
```

You can also add the Dockerfile if you want to build the image by yourself

- Get an API Key on Root-Me [here](https://www.root-me.org/?page=preferences)
- Copy `.env.example` to `.env` and replace variables

> API_KEY is the main Root-Me API Key (premium is better!).  
> API_KEY_FIRST can be used to get all non-premium challenges, to avoid a lot of requests on your account  
> You can use an api key or a cookie

```bash
mkdir -p /opt/jeanracine
chown -R 1001 /opt/jeanracine
./update.sh
```

- Wait for the bot to load all the challenges (it can take a long time)

> Please note that registering the slash commands in Discord can take a **long time**. You can force it by using **Routes.applicationGuildCommands**, located in the register_slash_commands file

If this does not work -> `kernoeb#7737` on Discord, [@kernoeb](https://t.me/kernoeb) on Telegram :)

### Crontab

You can also add a cron to automatically update the bot ([crontab.guru](https://crontab.guru/) is a good tool)

Something like `0 0 * * * cd /path/to/jeanracine/ && ./update.sh`

#### Optional :

Add this to your `.bashrc` :

```
function jeanracinelogs() {
  if [ $# -eq 0 ]
  then
      docker logs jean_racine_bot-rootme_node-1 --tail 20 -f
  else
      docker logs jean_racine_bot-rootme_node-1 --tail $1 -f
  fi
}
```

Open a new terminal, then try `jeanracinelogs`.

### Force registering slash commands

```bash
docker exec -it <name-of-jean-racine-container> register_slash_commands
```

---

## Captures

**Global Scoreboard**

![Global Scoreboard](https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/images/global_scoreboard.png)

**Notifications**

![Notifications 1](https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/images/notifications_1.png)

![Notifications 2](https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/images/notifications_2.png)

**Information about a user**

![User info](https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/images/img4.png)

**Information about a challenge**

![Challenge info](https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/images/challenge.png)

**Scoreboard with arrows**

![Arrow scoreboard](https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/images/arrow_scoreboard.png)

**Last challenges**

![Last challenges](https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/images/last_challenges.png)

**Charts**

![img.png](https://raw.githubusercontent.com/kernoeb/jean_racine_bot/main/images/chart.png)

## Contributors

Thanks to [Antabuse](https://www.root-me.org/Antabuse) for his help for the CTFTime part of the bot !

---

### Similar projects

- [RootMeBotV2](https://github.com/slowerzs/RootMeBotV2/) - [Slowerzs](https://www.root-me.org/Slowerzs)

jean_racine_bot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README