- You need Java 11 run Source.
- You need Gradle to compile source.
- If you do not have Gradle installed, it is recommended to compile using an IDE with support for Gradle projects.
- Compile Source on your local machine:
git clone git@github.com:TheSourceCodeLLC/Source.gitcd Sourcegradle install
- Binary files (Main JAR & Modules) are located in the
target/binfolder
NOTE: It is recommended to let Source have full reign over a separate mongodb instance!
Source needs the ability to create and delete databases at will as to separate guild data!
If you do not have the option to do this, Source may be a poor choice for you!
NOTE: Source uses privileged gateway intents.
You will need to activate the two privileged Gateway Intents for Source to function.
To do this, you will need to activate to the Discord Developers Portal, under the 'Bot' section.
- Start the bot:
- Windows:
java -DuseJansi=true -jar Source.jar - Unix:
java -jar Source.jar
If you need to configure the bot, the program will terminate after generating a default config.
- Windows:
Members that permissions do not apply to:
- Members in a server that have
ADMINISTRATORpermissions - Global Admins as defined in the
config.json
Global Admins are the ONLY people who may use commands marked as global.
Command Breakdown:
permissions:
<user|role>: The type of entity to modify
<target>: The entity to modify
set: Set a permission for this entity
<toSet>: The permission node to set
<flag>: The flag for the new node
(context): An optional context to set in
unset: Unset a permission for this entity
<toUnset>: The permission node to unset
(context): An optional context to unset from
info: Get permission info for this entity
check:
<toCheck>: The permission node to check
(context): An optional context to check in
clear: Clear this entity's permissions
(context): An optional context to clear in