TtgcBot

TtgcBot is a bot for Discord made at the beginning for RP (JDR) on The Tale of Great Cosmos universe (French Website here). But, today the bot is having many useful tools and features such as Keeprole system that allow leaving member to keep their roles after joining again your server, warn users that doesn't follow your rules, and more things (list of commands below). The bot is developed in Python 3 using discord.py lib and use also a postgresql database.

Invite link

you can invit him from a server with command /invite
Also available on The Tale of Great Cosmos discord

Please note this version is currently in alpha to fit discord API requirements, some bugs may still occurs and the stable release will be available later.

---

Table of content

1. Contribute to translation
2. Command Help
    2.1. How it works
    2.2. Basic commands
    2.3. Fun commands
    2.4. Moderation commands
    2.5. NSFW commands (NSFW channels only)
    2.6. RP/JDR commands
     2.6.1. Main commands
     2.6.2. Character commands
     2.6.3. Global commands
     2.6.4. GM/MJ commands
     2.6.5. Skill commands
     2.6.6. Pet commands
     2.6.7. Map commands
     2.6.8. Inventory commands
     2.6.9. Finalize commands
    2.7. Bot Management (Bot Manager only)

---

Contribute to translation

TtgcBot supports currently only two languages (English and French), if you want that the bot support more languages you can contribute by creating your own translation in a language file ! Follow the steps and rules given below to contribute to translation :

1. Create a new file named as following : the language code in uppercasse (EN for English for example) and with the extension .lang
2. Begin to write your file and respect coding rules below :
   • # is used to defined a comment line and must only placed at the beginning of the line to work
   • A line is equal to a key/value couple corresponding at a single message of the bot
   • Here is the correct format of a line : key=value
   • Write only translation as value for each key existing in other languages files (use EN.lang file as reference for having all the keys)
   • Use \n as new line character and you can also keep discord formatting
   • Use brackets {} to define a missing value that will be replaced by a result during execution of the command. For example : Who are you ? I'm {} means that the {} will be replaced by the name of a person when the command would be executed.
   • Put the same number of {} for a value as the number of {} for the same value in the reference file (EN.lang)
3. Commit and put the language file in the Lang directory
4. Wait for validation....
5. You have successful contributed to bot translation ! Congratulations !

---

Command Help

How it works

The commands work following this example : /example <arg> [optional] [opt1/opt2]
The / refers to the prefix on your server by default /, but if you have changed it, use your own prefix
<arg> is an argument and must be provided (without < and >) when you call the command
[optional] is an optional argument and could be or not provided (without [ and ])
[opt1|opt2] is an optional argument and if it's provided, it could only be one of the 2 options (opt1 or opt2)
(name1|name2) same as above, but used for commands group names instead. You can use the name1 or name2 for each subcommands.
[,...] means that you can pass as many as you want parameters of the same type
✔️ indicates the command supports discord slash command
There are also some features (commands) reserved for some users, it will be precised for each of them.
Each commands must be used on servers only, else they won't work.
Bot is casse insensitive, you can use uppercasse like lowercase for calling commands
For some commands there are alliases avalaible wich will be given for each commands having it

Basic commands

• /help [command]
  Show the help message. If a command, or group of command is provided, show detailled information about it.
• /invite ✔️
  Get the invitation link of the bot.
  Alias : invit
• /setlang <language> ✔️
  Set your language for bot messages, language represents the code of your language and there are currently only two languages supported : EN for English and FR for French
  NB : language code is case insensitive so you can precise it in upper or lower case as you wish Alias : setlanguage
• /ping ✔️
  pong ! 🏓

Fun commands

• /pi ✔️
  Display the first decimals of pi
• /yay ✔️
  Use the power of yay
• /choquedecu ✔️
  #ChoquéEtDéçu
• /onichan ✔️
  Because you want to have a little sister who loves you ❤️
• /tell <msg> ✔️
  The bot will tell your message and erase the command input (all tell commands are saved in logs)
• /ttstell <msg> ✔️
  Same as the tell command but the bot will use tts
  Alias : telltts

Moderation commands

• /setprefix <newprefix> (Administrator only)
  Change the prefix of the bot on the current server
  Alias : prefix
• /setadminrole <role> (Administrator only)
  Set the admin role for your server
  Alias : adminrole

NSFW commands (NSFW channels only)

• /nsfwjoke [language]
  Same as joke, but will display a nsfw joke (always in french)
• /hentai
  Do I need to explain what it does ?
• /rule34
  Rule 34 of the internet : if it exists, there is porn on it
  Just give a link to rule34 website

RP/JDR commands

Main commands

• /roll <expression> ✔️
  Roll dice and perform operations (supported symbols and operations : *,+,-,/,()) if given in the expression field. For rolling a dice, you have to use the litteral expression xdy where x is the number of dice rolled, d the letter d and y the number of side of the dice (1d100 will roll 1 dice with 100 sides for example). You can also roll special dice with your own values by writing them between brackets as following : 1d{red,blue,yellow,green}.
  Full example : /roll (10+1d100)*(2d10-5d8) will return the result of the following expression : (10+(1 dice with 100 sides))*((2 dice with 10 sides)-(5 dice with 8 sides))
  Special dice example : /roll 1d{1,2,3,4,5,6,7,8,9,10,Jack,Queen,King}+1d{Clubs,Diamonds,Hearts,Spades} will return a single card with its value and its color (example : Queen of Spades)
  Aliases : rolldice, r
• /setmjrole <role> (Administrator only)
  Set the role that every user need on your server to create JDR and use GM/MJ commands after (the role have to be mentionned)
  Aliases : setgmrole
• /apart [mention[,...]] (GM/MJ only and RP/JDR channel only)
  Mute and deafen all the players that are not mentionned by the command. If there is no single mention, the bot will unmute and undeafen all the players. (Spectators and GM/MJ will not be affected by this)
• /wiki <topic> ✔️
  Search on the wiki the given topic, if found a summary will be displayed with the link to the page
• /randomfact ✔️
  Get a random fact about TTGC
  Aliases : rf, rdmfact, randomwiki, rw, rdmwiki
• /jointhegame
  provide an invite link to the official discord of TTGC game (French discord)
  Aliases : jointtgc, ttgc
• /(jdr|rp) start <channel> (GM/MJ only)
  Start a RP/JDR in the mentionned channel
  Alias : create
• /(jdr|rp) delete <channel> (Administrator only)
  Delete a RP/JDR in the mentionned channel, this cannot be undone
• /(jdr|rp) copy <from> <to> (Administrator and GM/MJ only)
  Copy a RP/JDR from a mentionned channel to an other. if the destination channel has already a RP/JDR, this will be totally replaced by the copy (no merging)
• /(jdr|rp) extend <from> <to> (Administrator and GM/MJ only)
  Extend a RP/JDR through an other channel, the two channel will work with the same database and commands executed in one will affect the two channels. If a RP/JDR exists in the destination channel, it will be deleted.
• /(jdr|rp) unextend <from> <to> (Administrator only)
  Unextend a RP/JDR through the precised channel, only source channel will contain the data after using that
• /(jdr|rp) unextendall <from> (Administrator only)
  Unextend the RP/JDR in all the channel where there were extended, only source channel will contain data after using that
• /(jdr|rp) list (Administrator only)
  Show the list of all RP/JDR existing in your server (extension won't be shown)

Character commands

• /(character|char) create <race> <class> <namekey> (MJ only and JDR channel only)
  Create a new character with the given race and class and referenced by the namekey given. The race and class is the exact name of the race and class (french names), go to the website to know all existing classes. Use _ instead of space character for race and class name. The namekey is not the same things as the name of the character, the namekey is just the unique identifier of the character and will be needed each time you will want to perform commands on this character
  Alias : +
• /(character|char) delete <namekey> (MJ only and JDR channel only)
  Delete a character (this cannot be undone once performed)
  Aliases : del, -
• /(character|char) link <charkey> <member> (MJ only and JDR channel only)
  Link a character to a discord account (only for the channel and server). An account can only be linked one time per JDR
  Alias : assign
• /(character|char) unlink [charkey] (MJ only and JDR channel only)
  Unlink a character previously linked with character link command, if not provided, unlink the character linked to you (and selected)
  Alias : unassign
• /(character|char) select <charkey> (PJ only)
  Select an other character. For selecting a character, you'll need to be linked first to this character with the link command. character select allow you to switch from a character to an other.
  Alias : switch
• /(character|char) roll <stat> [<+|-> <expression>] (PJ only)
  Roll a dice in the given statistic and adding bonus or substracting malus if provided, the bonus/malus is formatted as for classical roll command and can be a complex expression such as 1d10-1d8+.... The result will tell you if the action is a success or not, according to the rules of TTGC game.
  Alias : r
• /(character|char) pilot <type> <dice> [other_characters] [<+|-> <expression>] (PJ only)
  Roll a pilot dice with given sides. You can provide other characters to be included in piloting action and any expression to add to or substract from the max value allowed for the roll to be a success. Type can only be astral or planet.
  Aliases : p, piloting, pilotage
  Aliases for astral type : interplanetaire, a
  Aliases for planet type : planetaire, p
• /(character|char) hybrid <charkey> <race> (MJ only and JDR channel only)
  Set a character as an hybrid, giving him a secondary race and inherit all race's skills. This won't work if the character is already an hybrid
  Aliases : transgenic, transgenique, hybride
• /(character|char) symbiont <charkey> [symbiont]
  Attach a symbiont to a character, if no symbiont is provided clear any symbiont from this character.
  Aliases : symbiote, symb, sb
• /(character|char) set <item> <charkey> <value> (MJ only and JDR channel only)
  Set a property of a character to the given value. The following properties can be set with this command :
  

name - (text) Set the name of the character
hp/pv - (positive integer) Set the max HP of the character
mp/pm - (positive integer) Set the max Mana points of the character
force/str/strength - (integer between 1 and 100) Set the strength
esprit/spr/spirit - (integer between 1 and 100) Set the spirit
charisme/cha/charisma - (integer between 1 and 100) Set the charisma
agilite/furtivite/agi/agility - (integer between 1 and 100) Set the agility
prec/precision - (integer between 1 and 100) Set the precision
luck/chance - (integer between 1 and 100) Set the luck
lp/lightpt/lightpoint - (integer) Set the number of light point of the character
dp/darkpt/darkpoint - (integer) Same as lp but for the dark points
defaultmod/dmod - (offensiv/defensiv) Set the default mod of the character
defaultkarma/dkar/dkarma - (integer between -10 and 10) Set the default karma
intuition/int/instinct - (integer between 1 and 6) Set the intuition
pilotastral/pa - (integer) Set the astral piloting value (negative value = disable astral piloting)
pilotplanet/pp - (integer) Set the planet piloting value (negative value = disable planet piloting)

• /(character|char) damage <charkey> <amount> (MJ only and JDR channel only)
  Damage a character, he will lose the number of HP given in the command
  Alias : dmg
• /(character|char) heal <charkey> <amount> (MJ only and JDR channel only)
  Heal a character with the number of points given
• /(character|char) getpm <charkey> <amount> (MJ only and JDR channel only)
  Restore the given amount of mana points provided, if the amount is negative, the character will lose mana points
  Alias : getmp
• /(character|char) setkarma <charkey> <amount> (MJ only and JDR channel only)
  Add or substract karma points to the current karma of the character
  Aliases : addkarma, getkarma
• /(character|char) reset <charkey> (MJ only and JDR channel only)
  Restore fully Health and Mana points, set the karma to its default value and set the mod to its default value for a character
• /(character|char) clear <charkey> (MJ only and JDR channel only)
  Clear current gamemod when currently using light or dark point. This will restore default gamemod and won't reset anything else.
  Alias : clr
• /(character|char) pay <amount> (PJ only)
  Pay the amount given
• /(character|char) earnmoney <charkey> <amount> (MJ only and JDR channel only)
  Give to the character the amount of money provided
  Alias : earnpo
• /(character|char) info (PJ only)
  Display all the current informations of your character
• /(character|char) stat (PJ only)
  Display statistics about dice rolled for your character
• /(character|char) use <item> (PJ only)
  Consume an item from your inventory
• /(character|char) use lightpt (PJ only)
  Consume a light point from your current character
  Aliases : lp, lightpoint
• /(character|char) use darkpt (PJ only)
  Consume a dark point from your current character
  Aliases : dp, darkpoint
• /(character|char) switchmod (PJ only)
  Switch your current mod between offensive and defensive mods
  Alias : switchmode
• /(character|char) setmental [+|-] <amount> (PJ only)
  Set the mental health of your character with the given value, if + or - is provided in the command, the amount will be added respectivly substracted to your mental health
• /(character|char) lvlup <charkey> (MJ only and JDR channel only)
  Give one more level to the character and announce the bonus for this level
  Alias : levelup
• /(character|char) kill <charkey> (MJ only and JDR channel only)
  Kill definitively a character, this will unlink it from its owner and the character wont be playable anymore
• /(character|char) export <charkey> [language] (MJ only and JDR channel only) (DISABLED)
  Export a character to PDF format using LaTeX technology, and send the generated file through discord. By default, the generated PDF is in french, use EN value for language to output in english your character.
• /(character|char) xp <charkey> <amount> [allowlevelup] (MJ only and JDR channel only)
  Give XP to a character. XP is printed on exported PDF from the character, but it can also be used by the level system. if allowlevelup is true, then every 100 XP, the character will automatically earn one level. It is highly recomended to use all the time the same value for allowlevelup parameter to avoid xp to level conversion errors.
  Alias : exp
• /(character|char) affiliate <charkey> [organization] (MJ only and JDR channel only)
  Affiliate the character with the specified organization, the organization should exists. This will automatically include all skills related to the organization. If no organization is provided, then the current character's affiliation will be removed.
  Aliases : organization, organisation, org
• /(character|char) list (MJ only and JDR channel only)
  Display the list of all characters existing in the current game channel

Global commands

• /global damage [char[,...]] <amount> (MJ only and JDR channel only)
  Damage all the characters precised (or everyone if no one is precised) with the number of points given
  Alias : dmg
• /global heal [char[,...]] <amount> (MJ only and JDR channel only)
  Heal all the characters precised (or everyone if no one is precised) with the number of points given
• /global getpm [char[,...]] <amount> (MJ only and JDR channel only)
  Add the given amount of mana points to all the characters precised (or everyone if no one is precised), if the amount is negative, the characters will lose mana points.
  Alias : getmp
• /global stat (JDR channel only)
  Display statistics about dice rolled for the group
• /global fight [char[,...]] [other_entities[,...]] (MJ only and JDR channel only)
  Start a fight round, determine order of all actions for each entities depending on agility values. In case of equality between two entities, nothing special is made and those entities will be ordered following an arbitrary order. Chars is the list of characters to consider, if no one is precised, then all characters will be considered. Entities is an external entity list following the format : tag:agility (for example : boss:75).
  Alias : battle

GM/MJ commands

• /mj transfer <member> (MJ only and JDR channel only)
  transfer ownership of a JDR to the mentionned user, this user need to have the MJ role and to accept the request
• /mj ... (MJ only and JDR channel only)
  Use a PJ command when you are MJ, theese commands works exactly as the same character commands. The mj prefix replace the character or char prefix and the commands work with sames arguments, the result will also be the same. For example /mj info will produce same result as /character info but you will have to precise for wich character this commands must be used for as the following : /mj info <charkey>. Refers to the PJ commands' doc to know result and how arguments works for each commands
  The following commands can be used :
  

/mj (info|charinfo|characterinfo) <charkey>
/mj (switchmod|switchmode) <charkey>
/mj pay <charkey> <amount>
/mj setmental <charkey> [+|-] <amount>
/mj (roll|r) <charkey> <stat> [<+|-> <expression>]
/mj (pilot|p|piloting|pilotage) (astral|interplanetaire|a|planet|planetaire|p) <dice> <characters> [<+|-> <expression>]
/mj pet (roll|r) <charkey> <petkey> <stat> [<+|-> <expression>]
/mj pet (switchmod|switchmode) <charkey> <petkey>
/mj pet info <charkey> <petkey>
/mj (inventory|inv) <charkey>

Skill commands

• /skill (PJ only)
  Show the list of skills of your character
  Alias : sk
• /(skill|sk) info <query> (JDR channel only)
  Search skills in the database with their names. Use quotes or underscore for searching skills wich contains several words.
• /(skill|sk) assign <charkey> <skill> (MJ only and JDR channel only)
  Assign a skill to a character. Prefer using ID instead of name to avoid conflict between skills with similar names. To get a skill ID, you can use skill info command.

Pet commands

• /pet add <charkey> <petkey> (MJ only and JDR channel only)
  Pet are linked to a single character and cannot be shared, they allow the owner of the character to execute standard PJ commands for pets. A character can have multiple pet and each of them have an unique identifier the petkey such as the charkey for characters.
  This command add a new pet to a character
  Alias : +
• /pet remove <charkey> <petkey> (MJ only and JDR channel only)
  Remove and delete completly a pet, this cannot be undone and have no confirmation message
  Aliases : -, delete, del, rm
• /pet set <item> <charkey> <petkey> <value> (MJ only and JDR channel only)
  Such as character set set a value of a pet. The same shortcuts as for character set are still avalaible. Only the following attributes are avalaible :
  

name
species
hp/pm
strength/spirit/charisma/agility
instinct (replace intuition)
defaultmod

• /pet switchmod <petkey> (PJ only)
  Switchmod for a pet
  Alias : switchmode
• /pet lvlup <charkey> <petkey> (MJ only and JDR channel only)
  Levels are not linked between characters and their pets. So to level up a pet you have to use this commands
  Alias : levelup
• /pet roll <petkey> <stat> [+bonus/-malus] (PJ only)
  Roll the dice for your pet, same rules as for classical roll command
  Alias : r
• /pet info <petkey> (PJ only)
  Show informations about your pet such as character info
• /pet setkarma <charkey> <petkey> <value> (MJ only and JDR channel only)
  Equivalent of setkarma for pets
• /pet stat <petkey> (PJ only)
  Show all stat of a pet you have (such as /stat for characters)
• /pet damage <charkey> <petkey> <amount> (MJ only and JDR channel only)
  Inflict damages to a pet
  Alias : dmg
• /pet heal <charkey> <petkey> <amount> (MJ only and JDR channel only)
  Heal a pet
  Alias : cure
• /pet getpm <charkey> <petkey> <amount> (MJ only and JDR channel only)
  Manage MP for a pet such as getPM for a character
  Alias : getmp

Map commands

• /map (MJ only and JDR channel only)
  Display the world map of Terae

Inventory commands

• /(inventory|inv) (PJ only)
  Show your current inventory
• /(inventory|inv) add <charkey> <item> [number] [weight] (MJ only and JDR channel only)
  Add the number of item to the inventory of the character, by default number is equal to 1 and weight to 1.0. The item name must not contains space char or need to be escaped with "" (write "healing potion" instead of healing potion)
  Aliases : +, append
• /(inventory|inv) remove <charkey> <item> [number] (MJ only and JDR channel only)
  Remove the number of item from the inventory of the character, by default number is equal to 1. Item name must not contains spaces like for inventory add command
  Aliases : rm, delete, del, -

Finalize commands

• /finalize (MJ only and JDR channel only)
  This command will start the finalizing operation displaying credits with some random informations of your game and also your own finalize fields. After that, the JDR will be fully deleted from the database.
• /finalize set <title> (MJ only and JDR channel only)
  Set the finalize field with the given title (if it doesn't exists, it will be created)
• /finalize delete <title> (MJ only and JDR channel only)
  Delete the finalize field given
  Aliases : del, -, remove, rm

Bot Management (Bot Manager only)

• /blacklist <user_id> | <reason> (Bot manager only)
  Blacklist a user, he won't be able to use any commands of this bot by blacklisting him
• /unblacklist <user_id> (Bot manager only)
  Unblacklist someone
• /purgeserver <days> (Bot manager only)
  Delete servers from the database that have kicked the bot at least number of days given ago