Welcome to DeviantCord’s documentation!¶
Warning
DeviantCord 3’s reaches end of support on December 15th, 2021. V3 will only receive bug fixes until it reaches End of Life. Due to Discord.py being discontinued. Please check the discord server for more information here.
Warning
This documentation has the bare minimum information. If you require assistance. here.
Note
DeviantCord 3 had a short 3 month life span due to Discord.py being discontinued and we did not have a chance to write documentation. This documentation is largely for DeviantCord 2, if you need assistance please use the server link above.
We’d Rather then spend time writing documentation for a version that is discontinued in a couple months. We are focusing on developing V4.
Welcome to the official documentation for DeviantCord 3, a Discord bot that allows the server to stay up to date with their favorite artists.
Unlike DeviantCord 1, you do not need to wait for us to approve your request for the bot to join the server. You can have the bot join the server using this link.
So jump right in!
Should I use the public bot?¶
DeviantCord 2 is a major rewrite of the original DeviantCord discord bot, written specifically for multiserver use and utilizes many server components to the bots advantage. If you are unfamiliar with Linux and Postgres, it is recommended use the public bot that we offer for free.
Getting Started (Public Bot)¶
Getting the bot to join your server¶
Getting the bot to join your server is easy. All you need is:
- Manage Server Permission on the server in question.
- Administrator on the server to set the minimum rank for users of the bot.
Once you confirm you have the necessary permissions, use the link link here. to make the bot join the server.
It should look similiar to the screenshot below
Note
If you do not have the requirements above on the server. The server will not show on this list.
Select the server you want to join the server to join.
Once the bot is in the server proceed to Setting Up Permissions
Getting Support¶
Support will be given only through the official DeviantCord Discord server. Our support team at this time is very small and we plan on expanding it, but we keep support to Discord to allow for others to help out and also allow for others who may be experiencing problems to see solutions staff may have already answered.
You can join the server here.
FAQ¶
How are version upgrades handled?
Bug Fixes will be applied to all server being hosted by us upon the updates being posted to Github* Updates always go through a testing process to make sure everything is functioning properly before a release.* When a new update is finished and released an announcement will be posted in the maintenance text chat
Who will have access to my bots files?
Only Errite Employee’s and certain staff members will be given access outside of server owners in order to fix issues and maintain the bot. Those who are given access are required to have a large amount of experience with Errite or with the team for them to have access to the files. (The organization who maintains the bot).
Are there any backups for our bots data?
All data is backed up daily on another server. Backups are retained for one month before being deleted.
What is Errite?
Errite is an organization based out of Chicago that primarily specializes in Art, Game Development, and software development. Most of the individuals behind the creation of the bot are in this organization.
Is there any difference between the self-hosting and the hosting you provide?
No, there is no major difference at this time in terms of functionality. The files provided on Github are the same ones used on the hosting we provide. The only difference is that we handle the management of the bot from the hosting side of things such as handling maintenance, and upgrading the bot.
Setting Up Permissions¶
Note
DeviantCord’s default prefix is ~ Use that to access the commands. You can change this after setting up permissions
DeviantCord checks a designated role to verify if a user has permissions to use the bot. As such, until you specify a role, no commands besides the help command and setuprole command will work.
The setuprole command, designates the minimum role required to utilize the bots commands. There are two different ways to do this with the setuprole command.
Method 1: Mentioning Role¶
Mentioning the role within the setuprole command is the most straightforward way to designate a role with the setuprole command. However you will need to make sure that you can mention the role, to be able to mention the role on the server
Enabling Role Mentions¶
By default you cannot mention a role, you have to enable on the server manually. To do this first go to the Roles section within Server Settings.
Select the role that you want to enable mentions for and enable the circled section in the image below
After enabling mentions for the role you should then be able to mention the role like below
Using the setuprole command (Mentions)¶
Once you have confirmed that you are able to mention the role you want to designate, execute the command using the example below
~setuprole rolenamehere
Method 2: Numeric Role ID¶
Specifying the RoleID is a great way to specify the role, without pinging the whole group. If you happen to know the roleid. You can use the following replacing roleid with your roleid.
~setuprole roleid
In the instance that you do not have the roleid. It is recommended to use Method 1. The whole purpose of using Method 2 is to avoid pinging the whole group, provided you already have the role id.
To find the roleid, will involve pinging the whole group in question.
If you are having issues with Method 1, contact DeviantCord support.
You can find details on contacting DeviantCord support here Contacting DeviantCord Support
Common Pitfalls¶
Here are some common misconceptions with setting up permissions for DeviantCord.
I specified the roleid, but it still says its invalid!¶
Make sure that you only provide numbers for the roleid.
When you try getting the roleid it might look like this:
<@&576558692904730643>
However, you only need the numbers. Using the roleid above, you would only specify 576558692904730643.
~setuprole 576558692904730643
If you provided only numbers, make sure that the roleid you provided is correct.
Otherwise contact DeviantCord support below Nothing happens when I use the setuprole command! ********************************************* The setuprole command requires that you have Administrator on the server.
Verify that you have Administrator on the server.
Contacting DeviantCord Support¶
You can find details on contacting DeviantCord support here Contacting DeviantCord Support
Setting Up Listeners¶
Note
DeviantCord’s default prefix is ~
Listeners are what DeviantCord uses to check for new Deviations (the term DeviantArt uses for new postings). On DeviantArt all Deviations are put into a folder by an artist.
However, there are a few things you should note.
Things to Note:¶
Note
To view your current listners you can use the listfolder command
- Once you create a listener, the bot will only see it exactly as you specified it at the listeners creation.
(Ex: You create a listener for the the Eeveelution Squad folder and specify the foldername as “Eeveelution Squad” but when you try to update the listener, you accidently refer to it in commands as “EeVeelution Squad”. the bot will not recognize it. The foldername and artist name must be exact.
- The same goes for Artist Names as specified above regarding foldernames.
- Folder names, and artistnames should be in quotes
- The addallfolder command, adds the artists All Folder on DeviantArt. Meaning the listener will post notifications regarding any deviations the artist posts.
- The addfolder command adds a listener that will post notifications of new deviations in that folder only.
Folder Properties¶
Artists can choose where in the folder they place their deviations at. Some put their newest deviations at the top, while some post it to the bottom. DeviantCord cannot automatically detect whether artists post their newer deviations at the top, or bottom.
To solve this, DeviantCord uses Folder Properties that server staff use to designate where deviations need to be found and whether to filter certain content.
You will use these properties with the addfolder and addallfolder command and answer the properties as either true or false
Properties
Inverse: Listeners that should only check for new deviations at the top of the folder
Hybrid: Listeners that should also check for the opposite of what inverse is set to
Example: Inverse is set to true and hybrid is set to true. Due to Hybrid being true the bottom deviations will also be checked.
Mature: Whether Deviations flagged as mature in DeviantArt should be posted. If you set this flag to true
Note
If your listener has the mature property set to true. The channel must be set to NSFW. Per Discord’s ToS
Designating channels¶
In any commands for DeviantCord referring to TextChannels, you just mention it like below
Ex: #general
Correct Arguments¶
The Help command says that the usage for the addfolder and addallfolder commmand is :
~addfolder <artist_username> <folder> #channelname <inverted> <hybrid> <mature>
~addallfolder <artist_username> #channelname <mature>
If we looked at an artists page, such as the one below
Example image from Zander-The-Artist (With Permission) see his work here
Looking above at the example image, and using it as an example you should note the following
The addartist command should have the artist name and in this case it would be “zander-the-artist” not “zander the artist”
The artist username field should be the same as the yellow highlighted area in the picture above.
The folder field for the Hope in Friends Comic folder should be the exactly what it is in the sidebar on the left. In this case the folder for the comic Hope In Friends should be “Hope In Friends Comic” not “Hope in Friends”
To add this folder we would use the following (replacing channelname with the text channel you want to use ~addartist “zander-the-artist” “Hope In Friends Comic” #channelname false false false
Removing Folders¶
Removing a listener uses the same logic as the section above, if you haven’t read the section it is suggested that you read it first.
However there are some differences you should note. As there is only a remove folder listener command. This was done to prevent accidentally deleting a whole artist from the folder as multiple folders can be stored under an artist.
As a result you can only delete one listener at a time. The command is as follows
~deletefolder <artist_username> <folder> #channelname
This will delete the listener from the database and no more notifications will be posted to Discord for that folder unless you readd it.
Additionally if you are having trouble remembering what folders are currently being listened for new deviations you can use the listfolders command
~listfolders
Contacting DeviantCord Support¶
Currently, support will be given only through the official DeviantCord Discord server. Our support team at this time is very small and we plan on expanding it, but we keep support to Discord to allow for others to help out and also allow for others who may be experiencing problems to see solutions staff may have already answered.
You can join the server here.
Additional Information¶
erriteCommands¶
Warning
This is only regarding the Public DeviantCord bot hosted by us not the self hosted bot.
Starting with bt-1.3.0 we added the ability to remove the public DeviantCord bot hosted by us from any Discord server. This is the sole duty of the erriteCommands that can be seen when reloading DeviantCord on the public bot. It cannot run any other command not related to forcefully removing a bot from a server. The reason we implemented this was incase a situation arose where we needed to forcefully remove our bot from a server. Primarily in the instance that the bot is being abused or violating Discord’s ToS/Community Guidelines. We will also use this if staff members of a particular server repeatedly come on the DeviantCord Discord server and break the rules in regards to support. In this case we will always reach out to staff members/owner on the server and give them plenty of options and warning that if the behavior continues that they will lose access to the DeviantCord public bot. This only used a last resort and only Michael (Lead Developer of DeviantCord) can forcefully make the the bot leave a server.
Note
Normally, there would be a section for self hosting here. However, due to the extensive changes in DeviantCord 2 and The Self Hosting documentation is delayed. The Self Hosting documentation will be posted soon.
Indices and tables¶
Note
The API docs, are outdated and will be updated shortly.