yamikaitou / tpun

Team Punistic Cogs

Installation

• [p] is your prefix

1. [p]repo add tpun https://github.com/batman202012/tpun

2. [p]cog install tpun <cog-folder-name>

3. [p]load <cog-folder-name>

Cog list

• Private Voice Channels

• Reputation

• Role Buy

• Usergate

• Verifier

• PingEveryone

• ServerHud

• Occupations

• ChatGPT

PVC

Cog for creating private voice channels

top

• [p]vc setup

Creates command channel for pvc and selects the channel's default joinable role (used for lock/unlock)

• [p]vc create <name>

Creates a voice channel in the catergory the pvc command channel is in with name 'name'

• [p]vc delete

Deletes your private voice channel

• [p]vc name

Returns the name of your private voice channel

• [p]vc list

Returns an embed of personal voice channel and owners

• [p]vc rename <name>

Renames your private voice channel to 'name'

• [p]vc region <int>

Changes your private voice channel region to 'int'

The list of avaliable regions are as follow 0=Auto, 1=US West, 2=US East, 3=US South, 4=EU West, 5=EU Central, 6=Brazil, 7=Hong Kong, 8=Brazil, 9=Japan, 10=Russia, 11=Sydney, 12=South Africa

• [p]vc lock

Prevents the roles used in vc setup from joining the channel

• [p]vc unlock

Allows the roles used in vc setup to join the channel

• [p]vc invite <user mention>

Invites a 'user' to join your private voice channel

• [p]vc limit <int>

Sets the user limit as 'int' for your private voice channel, use 0 to set it to uncapped

• [p]vc request <user mention>

Requests to join "user"'s private voice channel, only works when used on the channel's owner

• [p]vc kick <user mention>

Kicks 'user' from your private voice channel and removes their permissions to join

• [p]vc mute <user mention>

Disables "user"'s permissions to speak/stream/use camera/type in vc text chat in your private voice channel

• [p]vc unmute <user mention>

Enables "user"'s permissions to speak/stream/use camera/type in vc text chat in your private voice channel

• [p]vc claim

Claims a private voice channel as yours if the owner is no longer present

• [p]vc transfer <user mention>

Transfers private voice channel ownership to 'user'

• [p]vc setup

Command for setting up private voice channels in the server

Reputation

Gives users +1 rep everytime someone thanks them

top

• [p]repremove <user mention> <amount to remove>

Removes 'amount' of reputation from 'user'

• [p]checkrep <user mention>

Checks the amount of rep 'user' has

Rolebuy

Allows users to buy roles using redbot currency

top

• [p]rb buy <role mention>

Buys 'role' and removes currency from user

• [p]rb add <role mention> <cost>

Adds 'role' to list of buyable roles for 'cost'

• [p]rb remove <role mention>

Removes 'role' from buyable roles

• [p]rb list

Lists the available buyable roles in server

Usergate

Prevents user accounts that are under 'days' old from joining the server

top

• [p]usergate <days>

Sets the number of 'days' a user's account must exist

Verifier

Verifies users as a gender role using a gui

top

• [p]verify <user mention>

Removes 'user' unverified role and gives them their selected (from gui) verified role

• [p]vsetup

set the male, female, non-binary and unverified roles to use for verification

Pingeveryone

Just a simple cog that adds a command to ping @everyone and @here

top

• [p]pingeveryone

Allows users with bot admin perms to ping everyone

• [p]pinghere

Allows users with bot admin perms to ping here

Server Hud

A Cog for creating customizable voice channel stats

top

• [p]serverhud setchannel <type> <channel id>

Sets 'channel id' to be the serverhud 'type'

• [p]serverhud types

Lists the types of avaliable server hud

• [p]serverhud setprefix <type> <prefix>

Sets channel 'type' to have the 'prefix'

• [p]serverhud setsuffix <type> <suffix>

Sets channel 'type' to have the 'suffix'

• [p]serverhud setname <type> <name>

Sets channel 'type' to have the 'name'

• [p]serverhud setstyle <type> <style>

Sets the booster bar to use 'style' for either type: 'empty' or 'full'

ex: full * empty -: with 6 boosts = Lvl1******-

• [p]serverhud test <event>

Tests the serverhud for various events 'join' and 'leave'

Occupations

A Cog for giving your server members jobs, depending on the salary of their job the make money for time spend in vc

This cog uses the Adzuna Api so an app id and api key is required and can be obtained from the dashboard at: https://developer.adzuna.com/login and set using [p]set api adzuna app_id,<app id> api_key,<api key>

The amount made for time spent in vc is

pay = (timespent[in seconds] / 2,592,000[one month in seconds]) * salary[Members Salary] * [Salary Scalar, default=1.0] * 0.27

top

• [p]job board

Displays the job board that gives the user 4 random jobs top choose from

• [p]job current

Displays the user's current job

• [p]job quit

User quits their job

• [p]job maxsalary <salary>

Sets the max salary for the guild to salary

• [p]job chancescalar <scalar>

Sets the chance scalar for the guild to scalar

The closer to 0 the more likely, the higher than 1 the less likely

• [p]job cooldown <cooldown in seconds>

Sets the cooldown for [p]job board for the guild to cooldown

• [p]job settings

Displays current guild settings

ChatGPT

A cog to allow users to communicate with openAI's ChatGPT bot through discord

This cog uses an OpenAI api key which can be obtained from: https://beta.openai.com/account/api-keys and set using [p]set api openai api_key,<api key>

top

• [p]chatgpt chat <query>

Sends text input to chatGPT

• [p]chatgpt set <setting> <value>

Changes settings for chatgpt cog, valid settings are:

*channeladd (adds a channel to whitelist that the bot will respond to every message in)

*channelremove (removes a channel from the whitelist)

*replyRespond (toggles the bot responding in any channel regardless of whitelist status where it is mentioned)

For channeladd/channelremove the value must be the id of the channel.

For replyRespond you may use "true" and "false" or 1 and 0

• [p]chatgpt channellist

Lists the channels currently in the whitelist

• [p]chatGPT model <value>

Changes the model the bot is using. Available values are 0-text-ada-001 1-text-babbage-001 2-text-curie-001 3-text-davinci-002 4-text-davinci-002-render 5-text-davinci-003 current-shows current model

For more information on what this means please check out: https://beta.openai.com/docs/models/gpt-3

• [p]chatGPT tokenlimit <value>

Changes the max amount of tokens used in one query, default is 1000. Token cost is counted as query + response. Every model has a max cost of 2048 with the exception of the davinci models which have a max of 4000

For more information on tokens check out: https://beta.openai.com/docs/models/gpt-3

For token prices also see: https://openai.com/api/pricing/