Giter Site home page Giter Site logo

vidhanio / checkpoint Goto Github PK

View Code? Open in Web Editor NEW
9.0 2.0 1.0 124 KB

A discord verification bot for servers in the Peel District School Board.

License: GNU Affero General Public License v3.0

Go 99.16% Shell 0.09% Dockerfile 0.75%
discord discordgo discord-bot go golang

checkpoint's Introduction

Woodlands Checkpoint

Basic Setup

  1. Add Woodlands Checkpoint to your server (requires manage roles and manage nicknames permissions)
  2. Create to role be given to verified members (e.g. @Verified)
  3. Create a channel for non-verified members to verify themselves in (e.g. #verification)
  4. Set up permissons for the role so that only the verified members can see the normal channels
  5. Set up the verification channel so only non-verified members can see it (verified members cannot see it)
  6. Use /config set verified with the roles you made earlier (e.g. /config set verified role:@Verified)
  7. Woodlands Checkpoint should be set up! ๐Ÿ˜„

Fixes to Try

  • In both channel settings and role settings, make sure you are allowed to use application commands
  • Make sure that the @Woodlands Checkpoint role is higher than your verified role
  • The bot will not nickname you if your highest role is higher than the @Woodlands Checkpoint role

Advanced Setup

Grades

  1. Create grade roles for the grades your server will choose to support (e.g. @Grade 9)
  2. For each grade role, use /config add grade with the grade and role (e.g. /config add grade grade:9 role:@Grade 9)
  3. When members use /verify, they will now receive their grade role! ๐Ÿ˜„

Pronouns

  1. Create pronoun roles for the pronouns your server will choose to support (e.g. @He/Him)
  2. For each pronoun role, use /config add pronoun with the role (e.g. /config add pronoun role:@He/Him)
  3. Members can now use /set pronouns to set their pronouns! ๐Ÿ˜„

Self-Hosting

  1. Make copies of students.example.json, guilds.example.json, and example.env
  2. Remove the .example from each of the filenames
  3. Fill students.json with student information*
  4. Put your Discord bot token in the .env
  5. Run go run ./cmd/bot

*DM me on Discord (vidhan#7555) if you are interested in doing this step yourself.

checkpoint's People

Contributors

dependabot[bot] avatar nathan13888 avatar vidhanio avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

checkpoint's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.