mirror of
https://github.com/keanuplayz/TravBot-v3.git
synced 2024-08-15 02:33:12 +00:00
6.4 KiB
6.4 KiB
Table of Contents
- Structure
- Version Numbers
- Message Subcommand Type
- Command Menu
- Command Metadata
- Command Var String
- Utility Functions
Structure
src
: Contains all the code for the bot itself. Code directly in this folder is for the starting index file as well as commonly accessed utility files.core
: This is currently where the command handler is. Try to keep it as isolated as possible, it might split off to become its own module.commands
: Where all the dynamically loaded commands are stored. You can use a subfolder to specify the command category. Specify amodules
folder to create files that are ignored by the command loader.modules
: This is where mostly single-purpose blocks of code go. (This is not the same as amodules
folder undercommands
.)defs
: Contains static definitions.
dist
: This is where the runnable code insrc
compiles to. (The directory structure mirrorssrc
.)data
: Holds all the dynamic/private data used by the bot. This folder is not meant to hold definitions.docs
: Information for developers who want to contribute.
Version Numbers
When a new version is ready to be declared...
- ...update the changelog.
- ...update the version numbers in package.json and package-lock.json.
Naming Versions
Because versions are assigned to batches of changes rather than single changes (or even single commits), versioning is used a bit differently in order to avoid wasting version numbers.
<prototype>.<major>.<minor>-<patch>
<prototype>
is a defined as the overarching version group of TravBot. TravBot-v2 went by2.x.x
and all versions of TravBot-v3 will go by3.x.x
.<major>
includes any big overhauls or revisions of the entire codebase.<minor>
includes any feature additions in a specific area of the codebase.<patch>
will be pretty much for any very small changes like a quick bug fix or typos. Note: Normally, these would probably get grouped up, but if there hasn't been a proper version in a while, this will get pushed as a patch.
Note: This system doesn't retroactively apply to TravBot-v2, which is why this version naming system won't make sense for v2's changelog.
Message Subcommand Type
https://discord.com/channels/<id>/<id>/<id>
comes from theCopy Message Link
button.<id>-<id>
comes from holdingShift
on the desktop application and clicking on theCopy ID
button.
Command Menu
args
: A list of arguments in the command. It's relative to the subcommand, so if you do$test this 5
,5
becomes$.args[0]
ifthis
is a subcommand. Args are already converted, so anumber
subcommand would return a number rather than a string.client
:message.client
message
:message
channel
:message.channel
guild
:message.guild
author
:message.author
member
:message.member
Command Metadata
description
: The command description that'll appear in the help menu.endpoint
: Whether or not any arguments are allowed after the command.usage
: Defines a custom usage when showing the command in the help menu.permission
: (Inherits) -1 (default) indicates to inherit, 0 is the lowest rank, 1 is second lowest rank, and so on.nsfw
: (Inherits) Whether or not the command is restricted to NSFW channels and DM channels.channelType
: (Inherits) Whether the command is restricted to guild channels, DM channels, or has no restriction. Uses theCHANNEL_TYPE
enum provided by the command handler.
Command Var String
%author%
- A user mention of the person who called the command.%prefix%
- The prefix of the current guild.
Utility Functions
src/core (libd) - Utility functions specific for working with Discord
paginate()
const pages = ['one', 'two', 'three'];
const msg = await channel.send(pages[0]);
paginate(msg, author.id, pages.length, (page) => {
msg.edit(pages[page]);
});
prompt()
const msg = await channel.send('Are you sure you want to delete this?');
prompt(msg, author.id, () => {
//...
});
callMemberByUsername()
callMemberByUsername(message, args.join(" "), (member) => {
channel.send(`Your nickname is ${member.nickname}.`);
});
src/lib - General utility functions
parseArgs()
: Turnscall test "args with spaces" "even more spaces"
into["call", "test", "args with spaces", "even more spaces"]
, inspired by the command line.parseVars()
: Replaces all%
args in a string with stuff you specify. For example, you can replace allnop
withasm
, andregister %nop%
will turn intoregister asm
. Useful for storing strings with variables in one place them accessing them in another place.isType()
: Used for type-checking. Useful for testingany
types.select()
: Checks if a variable matches a certain type and uses the fallback value if not. (Warning: Type checking is based on the fallback's type. Be sure that the "type" parameter is accurate to this!)Random
: An object of functions containing stuff related to randomness.Random.num
is a random decimal,Random.int
is a random integer,Random.chance
takes a number ranging from0
to1
as a percentage.Random.sign
takes a number and has a 50-50 chance to be negative or positive.Random.deviation
takes a number and a magnitude and produces a random number within those confines.(5, 2)
would produce any number between3
and7
.pluralise()
: A substitute for not having to doamount === 1 ? "singular" : "plural"
. For example,pluralise(x, "credit", "s")
will return"1 credit"
and/or"5 credits"
respectively.pluraliseSigned()
: This builds onpluralise()
and adds a sign at the beginning for marking changes/differences.pluraliseSigned(0, "credit", "s")
will return"+0 credits"
.replaceAll()
: A non-regex alternative to replacing everything in a string.replaceAll("test", "t", "z")
="zesz"
.toTitleCase()
: Capitalizes the first letter of each word.toTitleCase("this is some text")
="This Is Some Text"
.random()
: Returns a random element from an array.random([1,2,3])
could be any one of those elements.split()
: Splits an array into different arrays by a specified length.split([1,2,3,4,5,6,7,8,9,10], 3)
=[[1,2,3],[4,5,6],[7,8,9],[10]]
.