Skip to content

Latest commit

 

History

History
94 lines (67 loc) · 4.25 KB

README.md

File metadata and controls

94 lines (67 loc) · 4.25 KB
Raw
SRMKZILLA Logo
Jack Logo

Meet Jack,a bot of all trades.

crafted with ♥ by your friends on the SRMKZILLA team.

version 1.0.0 license MIT author SRMKZILLA

To make this cool beep bot your own, refer to this Wiki

Commands 🔧

There's only so much Jack can do without you giving him further instructions

  • Common Commands

    • #kzjack help - Get everything what Jack can do
    • #kzjack meme - Jack sends you a crazyyyy meme
    • #kzjack joke - Bored? Wait for jack to send you a joke, perfect joke indeed.
    • #kzjack shrink <URL> <?customCode> - Shrink a looooong URL using KZILLA.XYZ
      • Example: #kzjack shrink https://srmkzilla.net

  • Text Channel Commands

    • #kzjack membercount - Get members count for the channel

  • Moderators Channel Commands

    • #kzjack flush -Flush all cache
    • #kzjack certificate <event-slug> - Start a certificate thread
      • #kzjack certificate my-event
    • #kzjack announce <? here|everyone|@role > <#channel> {<?title>} <description> - Announcements
      • Example: #kzjack announce #announcements {Hello World!} How are you?
      • Example: #kzjack announce here #announcements {Hello World!} How are you?
      • Example: #kzjack announce everyone #announcements {Hello World!} How are you?
    • #kzjack poll create <#channel> {<Some Question>} [[<Option 1>],[<Option 2>],[<Option 3>]] - Start a Poll
      • Example: #kzjack poll create #polls {Who's the best?} [[Jack],[Yvette]]
    • #kzjack poll result <Poll ID> - Get Poll Results
      • Example: #kzjack poll result s3cRe7ID
    • #kzjack checkin <Event Slug> - Start event Checkin Collector
      • Example: #kzjack checkin mozohack

Installation 🔧

Install dependencies and build the server

$ yarn && yarn build

Start the development server

$ yarn dev

Start the server

$ yarn start

Shout outs 💥

Harsh Goel
Harsh Goel

Gita Alekhya Paul
Gita Alekhya Paul

License 📜

Jack is available under the MIT license. See the LICENSE file for more info.

Contributing 🤝

Please read Contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Forking this repo 🚨

Many people have contacted us asking if they can use this code for their own websites. The answer to that question is usually "yes", with attribution. There are some cases, such as using this code for a business or something that is greater than a personal project, that we may be less comfortable saying yes to. If in doubt, please don't hesitate to ask us.

We value keeping this site open source, but as you all know, plagiarism is bad. We spent a non-negligible amount of effort developing, designing, and trying to perfect this iteration of our website, and we are proud of it! All we ask is to not claim this effort as your own.

So, feel free to fork this repo. If you do, please just give us proper credit by linking back to our website, https://srmkzilla.net. Refer to this handy quora post if you're not sure what to do. Thanks!