README.md

Rustacean

Rustacean is a Discord bot that allows users to execute code snippets.

Made with Rust 🦀❤

Commands

~help: Get a list of commands. Use ~help <command> to get details on a command.

~languages: Get a list of available programming languages.

~stats: Get a list of how many snippets of a language has been executed.

~git: Get a link to the bot's GitHub repository.

~exec: Executes a code snippet. Your message needs to look like this:

~exec
​```language

code...
​```

where language is the language of your choice. For example:

~exec
​```c
printf("Oh hi Discord!");
​```

Getting Started

Prerequisites

prerequisites on Windows

prerequisites on Linux

prerequisites on macOS

How does it work

The bot is supposed to run on a Docker container (recommended), it will save all code it receives with the exec command in a folder snippets/{userid}.
Then the bot will spawn a container with an image corresponding to the language that is supposed to be executed. For example, when executing C code it will launch a container with the rustacean-c image (using a custom-built image for that language) and then execute the given code.

For security purposes, containers will have their ability restrained (not on the main container), they will have no connection to the internet, they will have limited ressources (RAM and CPU usage defined in the config file) and after 10 seconds of code execution the container will be killed and deleted (to prevent infinite loops and to save space on hard drive).
For each language there is a corresponding Docker image that has all the necessary dependencies (enables us to add specific dependencies without granting access to the internet).
When launching the bot all the images will be built, so you must have enough disk space (the bot will automatically prune all unnecessary images after having built everything).

Installing

Docker is required for running the bot (it will spawn container). So you need to install Docker.

For Linux:

user@machine:~$ apt install -y docker.io

For Mac:

user@machine:~$ brew install docker

Create a clone of this project on your development machine:

user@machine:~$ git clone https://github.com/Kryod/rustacean.git

Register a Discord bot here https://discordapp.com/developers/applications/me

Set up your environment:

user@machine:~$ cd rustacean/ # Go to your copy of this repository
user@machine:~/rustacean$ cargo run update-db
user@machine:~/rustacean$ cp config.toml.example config.toml
user@machine:~/rustacean$ nano config.toml # Edit this file to set your Discord bot credentials

Then, you can run the bot:

user@machine:~/rustacean$ cargo run

When the program starts running, an invite link will be printed out to add the bot to your Discord server.

Docker

You can also run Rustacean as a Docker container.

Adding a language

You can do an issue and hope we will have the time to work on it, make a pull request or add it yourself on your fork.

In the two latter choices you need to do this:

First you need to make a Docker image in the images directory following this naming syntax: Dockerfile.{language}. If code runs on your image then the bot will be able to use it.

Then you need to make a Rust source file in src/commands/exec named {language}.rs.
You can copy another file from the same folder, the architecture is pretty much the same.
Take a look at language.rs, it contains the trait that will be implemented by your language struct.
In the get_image_name() function you must put the name of the image that will be built, must be like rustacean-{language}.
Everything else is self-explanatory, if your language is interpreted then you need to tell what the interpreter is, if you have a special command for the execution you have to specify it in get_execution_command()...
One thing to note is that you must have the exact name between the image name after the "-" (rustacean-{language}), the Dockerfile extension (Dockerfile.{language}) and the name in the function get_lang_name().

After your file is done, you need to add it in mod.rs in the same folder by adding the following lines:

mod {language};
pub use self::{language}::{language};

Now you need to add the names used in the ~exec command that will invoke the language. In src/lang_manager.rs, add the following line:

 mngr.languages.insert(vec![
    "invocation_name_1".into(),
    "invocation_name_2".into()
    ], Arc::new(Box::new({language})));

And now you are done. But if you want your pull request to be merged you need to add a test for your language, it is in the src/test.rs file. After your PR is validated by Travis we will happily merge it.