OSIS Discord Assistant

A Discord bot created for OSIS Sekolah Djuwita Batam, written on top of DSharpPlus. Developed by the Information Technology Division. Events manager, automated deadline reminder and server policing. All you need for your student council's Discord server under one bot.

Contributing

Contributions are open to everyone! Please read the contributions guideline for more information.

Requirements

Setting Up

Once you have installed all of the requirements listed above, you need to set your environment up properly before running the bot.

Step One: PostgreSQL

You will need to log into your PostgreSQL server via psql utility.

Proceed to execute the SQL scripts inside the postgres folder. Do note that you must change the username to which the table gets assigned to in each scripts, if the owner name is not default aka postgres.

Step Two: Configuration

Create a new file named config.json in the bot's directory. Fill that file with the following format.

{
    "Token": "",
    "Prefix": [""],
    "DbConnectionString": "",
    "BotAdministratorId": "",
    "MainGuildId": "",
    "StatusActivityType": ,
    "CustomStatusDisplay": [""],
    "EventChannelId": "",
    "ProposalChannelId": "",
    "VerificationRequestsProcessingChannelId": "",
    "MaxPendingVerificationWaitingDay": "",
    "VerificationInfoChannelId": "",
    "RolesChannelId": "",
    "ErrorChannelId": "",
    "AccessRoleId": "",
    "MainGuildRoles": [
        {
            "RoleId": "",
            "RoleName": "",
            "RoleEmoji": ""
        }
    ],
    "MainGuildInviteLink": ""
}

For the Token property, add your bot's token obtained from Discord Developer Portal. If you do not know how to obtain that, you'll need to create a new application then click on the Bot section. Click Add User and copy the token.
For the Prefix property, add your desired command prefix between the quotation marks.
For the DbConnectionString property, add your database's connection string. A typical PostgreSQL connection string would look like this: Host=host;Username=username;Password=password;Database=database Change these values according to your database.
For the BotAdministratorId property, add the user ID of the bot administrator's Discord account.
For the MainGuildId property, add the guild ID that you want the event and proposal submission reminders to be sent to.
For the StatusActivityType property, add the desired ActivityType enum number as specified in the D#+ documentation.
For the CustomStatusDisplay property, add the array of strings to be set as the bot's custom status which is updated on a minute basis.
For the EventChannelId property, add the channel ID that you want the event reminders to be sent to.
For the ProposalChannelId property, add the channel ID that you want the proposal submission reminders to be sent to.
For the VerificationRequestsProcessingChannelId property, add the ID of the channel to be set as the verification requests processing channel ID (where verification request embeds are sent to).
For the MaxPendingVerificationWaitingDay property, add the number of days which a pending verification is retained before being removed automatically by the verification cleanup task.
For the VerificationInfoChannelId, add the ID of the channel that contains the verification info embed.
For the RolesChannelId property, add the ID of the channel to be used to point newly verified members to self-assign their divisional roles via the provided select menu.
For the ErrorChannelId property, add the channel ID that you want the error(s) related to event and proposal submissions reminders background task to be sent to.
For the AccessRoleId property, add the ID of the role that serves as the OSIS role in the main guild.
For the MainGuildRoles array, add the array of divisional roles as needed.
For the MainGuildInviteLink property, add the invite link of the main guild which will be displayed if a command restricted for the main guild only is used outside of the guild.

Make sure you have saved your changes before proceeding.

Step Three: Running Your Bot

Once you have done all of the steps above, you are ready to run your bot! Ensure that config.json is in the same directory which the bot is located in.

Self-Hosting

Assuming that you want to run your bot in a Docker container, self-hosting should be straightforward by executing docker-compose up from the docker-compose.yml file. Upon first launch, you may encounter some errors either because you have not completed step one or the config.json file is missing from the bot's directory. These issues should not persist once they have been resolved, therefore allowing you to launch the bot by only executing docker-compose up without hassle.

Feel free to hit me up on Discord (RedStar#9271) for questions / support.

redstarxx / OSISDiscordAssistant

readme