cdc-bot.js
Version:
An easy to learn package to code your own advanced Discord bots.
158 lines • 14.3 kB
Markdown
��# c d c - b o t . j s
[ ! [ D i s c o r d ] ( h t t p s : / / i m g . s h i e l d s . i o / d i s c o r d / 8 4 5 6 9 6 3 5 7 4 0 6 9 9 8 5 8 8 ? c o l o r = b l u e & l a b e l = D i s c o r d & l o g o = d i s c o r d & l o g o C o l o r = w h i t e ) ] ( h t t p s : / / d i s c o r d . g g / d j c S R F P P a N )
* * W e l c o m e t o t h e o p e n s o u r c e G i t H u b r e p o s i t o r y o f o u r [ n p m p a c k a g e ] ( h t t p s : / / n p m j s . o r g / p a c k a g e / c d c - b o t . j s ) ! * *
* * V i s i t o u r d o c u m e n t a t i o n p a g e b y c l i c k i n g [ h e r e ] ( h t t p s : / / c d c - b o t . d u t c h m a n - d e v . c o m ) a n d j o i n o u r D i s c o r d S e r v e r b y c l i c k i n g [ h e r e ] ( h t t p s : / / d i s c o r d . g g / d j c S R F P P a N ) . * *
# # T a b l e O f C o n t e n t s :
- [ A b o u t c d c - b o t . j s ] ( # a b o u t - o u r - p a c k a g e )
- [ H o w t o i n s t a l l ] ( # i n s t a l l a t i o n )
- [ E x a m p l e s ] ( # e x a m p l e s )
- [ S e t u p y o u r B o t ] ( # b o t - s e t u p )
- [ B o t P r e s e n c e ] ( # b o t - p r e s e n c e )
- [ B o t V a r i a b l e s ] ( # b o t - v a r i a b l e s )
- [ C l i e n t E v e n t s ] ( # d i s c o r d - a p i - e v e n t s )
- [ M o r e f e a t u r e s ] ( # m o r e - f e a t u r e s )
- [ D i s c o r d I n t e r a c t i o n s & S l a s h C o m m a n d s ] ( # d i s c o r d - i n t e r a c t i o n s - - a p p l i c a t i o n - c o m m a n d s )
- [ L i n k s ] ( # l i n k s )
- [ C o n t r i b u t i n g ] ( # c o n t r i b u t i n g )
# # A b o u t o u r p a c k a g e :
c d c - b o t . j s i s a n e a s y t o l e a r n p a c k a g e t h a t m a k e s i t p o s s i b l e f o r y o u t o c o d e y o u r o w n a d v a n c e d D i s c o r d b o t s f a s t a n d u n c o m p l i c a t e d .
W e u s e f u n c t i o n s t h a t m a k e a l l i m a g i n a b l e u s e s f o r y o u r D i s c o r d * b o t s p o s s i b l e . < / b r >
T h e p a c k a g e i s o p e n s o u r c e t h a t a l l o w s a n y o n e t o c o n t r i b u t e t o t h e p a c k a g e d e v e l o p m e n t . T o g e t h e r w e c a n ! < b r >
< / b r >
# # I n s t a l l a t i o n :
* * N o d e . J S v e r s i o n 1 2 . 0 . 0 o r h i g h e r i s r e q u i r e d ! * *
` ` ` s h - s e s s i o n
n p m i n s t a l l c d c - b o t . j s
` ` `
# # E x a m p l e s :
# # # B o t S e t u p :
` ` ` j s
c o n s t c d c = r e q u i r e ( ' c d c - b o t . j s ' )
c o n s t c l i e n t = n e w c d c . B o t ( {
t o k e n : " T O K E N H E R E " , / / p a s t e y o u r s e c r e t b o t u s e r ' s D i s c o r d T o k e n
p r e f i x : " ! " , / / p r e f i x o r a r r a y ( p r e f i x : [ ' ! ' , ' ? ' , ' x y z ' , ' . . . ' ] ) o f p r e f i x e s , o p t i o n a l , d e f a u l t i s " ! "
e x e c u t e C m d O n U p d a t e : t r u e , / / W h e t h e r t o r u n c o m m a n d s w i t h u p d a t e d m e s s a g e s i f t h e y ' r e a c o m m a n d t r i g g e r , o p t i o n a l , d e f a u l t f a l s e
f e t c h I n v i t e s : t r u e , / / W h e t h e r t o c a c h e i n v i t e s d a t a f o r i n v i t e t r a c k i n g s y s t e m o r n o t
r e s p o n d T o D M s : f a l s e , / / W h e t h e r t o r e s p o n d t o m e s s a g e s i n b o t ' s D M S o r n o t , o p t i o n a l , d e f a u l t t r u e
r e s p o n d T o B o t s : f a l s e , / / W h e t h e r t o r e s p o n d t o m e s s a g e s s e n t b y b o t s o r n o t , o p t i o n a l , d e f a u l t t r u e
} )
` ` `
# # # B o t P r e s e n c e :
T h i s i s t h e a c t i v i t y p r e s e n c e t h e b o t ' s u s e r p r o f i l e w i l l s h o w i n i t ' s p r o f i l e a n d i n t h e m e m b e r s l i s t .
Y o u c a n s e t u p a s m a n y p r e s e n c e s a s y o u l i k e b u t t i m e o u t ( u n t i l b o t r e l o a d s t h e p r e s e n c e / c h a n g e s t o n e x t p r e s e n c e ) m u s t b e h i g h e r t h a n 1 2 s e c o n d s ( D i s c o r d R a t e L i m i t )
# # # # S e t t i n g u p b o t ' s p r e s e n c e :
` ` ` j s
c l i e n t . p r e s e n c e ( {
s t a t u s : " o n l i n e " , / / o n l i n e , i d l e , d n d , i n v i s i b l e
n a m e : " w ? h e l p o n $ c l i e n t [ g u i l d _ c o u n t ] s e r v e r s w i t h $ c l i e n t [ u s e r s _ c o u n t ] u s e r s " , / / T e x t t o b e s h o w n
t y p e : " P L A Y I N G " , / / P L A Y I N G , C O M P E T I N G , W A T C H I N G , L I S T E N I N G , S T R E A M I N G
t i m e o u t : 1 2 , / / l e n g t h i n s e c o n d s b e f o r e c h a n g i n g t h e p r e s e n c e a g a i n ( m u s t b e 1 2 o r h i g h e r )
u r l : " h t t p s : / / t w i t c h . t v / d i s c o r d _ d u t c h m a n " / / T w i t c h - C h a n n e l - U R L o r Y o u T u b e - V i d e o - U R L i f t y p e i s S T R E A M I N G
} )
c l i e n t . p r e s e n c e ( {
s t a t u s : " o n l i n e " , / / o n l i n e , i d l e , d n d , i n v i s i b l e
n a m e : " w i t h $ c l i e n t [ g u i l d _ c o u n t ] s e r v e r s " , / / T e x t t o b e s h o w n
t y p e : " P L A Y I N G " , / / P L A Y I N G , C O M P E T I N G , W A T C H I N G , L I S T E N I N G , S T R E A M I N G
t i m e o u t : 1 2 , / / t i m e o u t i n s e c o n d s
} )
` ` `
# # # B o t V a r i a b l e s :
# # # # W h a t a r e v a r i a b l e s ?
I n o u r p a c k a g e w e u s e v a r i a b l e s t o s t o r e d a t a i n t h e b o t ' s d a t a b a s e . T h e d a t a i s b a s e d o n I D s ( e . g . b a s e d o n a s p e c i f i c u s e r I D / c h a n n e l I D / m e s s a g e I D / g u i l d I D ) . T h e s e v a r i a b l e s a r e K e y - V a l u e b a s e d . T h i s c a n b e u s e d a s e x a m p l e t o s t o r e c h a n n e l I D s t h a t a r e d e p e n d i n g o n t h e s e r v e r t h e c o m m a n d w a s u s e d i n . I t ' s a l s o u s a b l e t o s t o r e a u s e r ' s e c o n o m y b a l a n c e b a s e d o n t h e u s e r I D .
# # # # S e t u p t h e v a r i a b l e k e y s :
` ` ` j s
b o t . v a r i a b l e s ( {
V a r i a b l e N a m e 1 : " t r u e " , / / T h i s i s t h e d e f a u l t v a l u e t h a t c a n b e c h a n g e d v i a f u n c t i o n s f o r e a c h u s e r / c h a n n e l / s e r v e r / m e s s a g e d i f f e r e n t l y .
V a r i a b l e N a m e 2 : " f a l s e " / / S e c o n d v a r i a b l e ' s d e f a u l t v a l u e i s " f a l s e " .
} )
` ` `
# # # D i s c o r d A P I E v e n t s
# # # # W h a t a r e t h e s e e v e n t s ?
I t ' s s i m p l e a n d e a s y p r o c e s s , i t e s s e n t i a l l y a l l o w s y o u t o t r i g g e r c o m m a n d s o n s p e c i a l e v e n t s o f t h e D i s c o r d A P I , s u c h a s u s e r j o i n i n g a G u i l d .
T h i s w i l l t r i g g e r a n e v e n t , c a u s i n g c o m m a n d s w i t h s u p p o r t e d t y p e f o r e a c h e v e n t t o b e e x e c u t e d t h e n .
# # # # T h e a v a i l a b l e e v e n t s o u r p a c k a g e c o v e r s :
` ` `
o n C h a n n e l C r e a t e , o n C h a n n e l D e l e t e , o n C h a n n e l P i n s U p d a t e , o n C h a n n e l U p d a t e , o n E m o j i C r e a t e , o n E m o j i U p d a t e , o n E m o j i D e l e t e , o n G u i l d B a n A d d , o n G u i l d B a n R e m o v e , o n G u i l d C r e a t e , o n G u i l d D e l e t e , o n G u i l d M e m b e r A d d , o n G u i l d M e m b e r R e m o v e , o n G u i l d M e m b e r U p d a t e , o n G u i l d U n a v a i l a b l e , o n G u i l d U p d a t e , o n I n v i t e C r e a t e , o n I n v i t e D e l e t e , o n I n t e r a c t i o n C r e a t e , o n M e s s a g e C r e a t e , o n M e s s a g e D e l e t e , o n M e s s a g e D e l e t e B u l k , o n M e s s a g e U p d a t e , o n M e s s a g e R e a c t i o n A d d , o n M e s s a g e R e a c t i o n R e m o v e , o n M e s s a g e R e a c t i o n R e m o v e A l l , o n M e s s a g e R e a c t i o n R e m o v e E m o j i , o n P r e s e n c e U p d a t e , o n R a t e L i m i t , o n R o l e C r e a t e , o n R o l e D e l e t e , o n R o l e U p d a t e , o n T y p i n g S t a r t , o n U s e r U p d a t e , o n V o i c e S t a t e U p d a t e , o n W e b h o o k U p d a t e
` ` `
# # # # E x a m p l e E v e n t - C o m m a n d :
` ` ` j s
b o t . g u i l d M e m b e r C r e a t e C o m m a n d ( {
c h a n n e l : " C h a n n e l I D " , / / E n t e r t h e w e l c o m e - c h a n n e l - I D
c o d e : ` < @ $ u s e r > w e l c o m e t o o u r s e r v e r ! ` / / T y p e i n w h a t e v e r m e s s a g e y o u w o u l d l i k e t o b e s e n d .
} )
` ` `
# # M o r e F e a t u r e s :
# # # D i s c o r d I n t e r a c t i o n s & A p p l i c a t i o n C o m m a n d s :
W i t h e a s y a n d s i m p l e f u n c t i o n s , y o u c a n m a k e S l a s h C o m m a n d s ( a p p l i c a t i o n c o m m a n d t y p e 1 ) a n d M e s s a g e C o n t e x t C o m m a n d s ( a p p l i c a t i o n c o m m a n d t y p e s 2 & 3 ) a n d l e t y o u r b o t r e s p o n d t o t h e i n t e r a c t i o n s q u i c k !
` ` ` j s
/ / E x a m p l e o f c r e a t i n g a s l a s h c o m m a n d
c l i e n t . p r e f i x e d C o m m a n d ( {
n a m e : " s l a s h " ,
c o d e : ` $ c r e a t e A p p l i c a t i o n C o m m a n d [ $ g u i l d ; 1 ; s u p p o r t ; R e t u r n s i n v i t e - l i n k o f o u r s u p p o r t - s e r v e r . ] `
} )
/ / r e s p o n d i n g t o a s l a s h c o m m a n d i n t e r a c t i o n :
c l i e n t . i n t e r a c t i o n C r e a t e C o m m a n d ( {
n a m e : " s u p p o r t " ,
c o d e : ` $ i n t e r a c t i o n R e p l y [ J o i n o u r s e r v e r b y c l i c k i n g [ h e r e ] ( h t t p s : / / d i s c o r d . g g / d j c S R F P P a N ) ] `
} )
/ / r e s p o n d i n g t o a b u t t o n c l i c k :
c l i e n t . i n t e r a c t i o n C r e a t e C o m m a n d ( {
i n t e r a c t i o n : ' c o m p o n e n t ' ,
n a m e : ' c l i c k _ m e ' / / c u s t o m _ i d o f t h e b u t t o n
c o d e : `
$ i n t e r a c t i o n R e p l y [ Y o u c l i c k e d t h e b u t t o n s u c c e s s f u l l y ! ]
`
} )
/ / r e s p o n d i n g t o a s e l e c t m e n u c l i c k :
c l i e n t . i n t e r a c t i o n C r e a t e C o m m a n d ( {
i n t e r a c t i o n : ' c o m p o n e n t ' ,
n a m e : ' c l i c k _ m e ' / / c u s t o m _ i d o f t h e s e l e c t m e n u
c o d e : `
$ i n t e r a c t i o n R e p l y [ Y o u c l i c k e d t h e o n t h e m e n u a n d s e l e c t e d t h e o p t i o n $ i n t e r a c t i o n D a t a [ s e l e c t _ v a l u e s ] ! ]
`
} )
` ` `
M o r e I n f o r m a t i o n i n o u r [ D o c u m e n t a t i o n ] ( h t t p s : / / c d c - b o t . d u t c h m a n - d e v . c o m / g u i d e / a p p l i c a t i o n - c o m m a n d s )
# # L i n k s
c d c - b o t . j s w a s m a d e b y [ D u t c h m a n # 0 0 0 1 ] ( h t t p s : / / d i s c o r d a p p . c o m / u s e r s / 7 0 4 6 7 7 0 7 1 9 2 9 9 9 9 3 9 0 ) .
- [ W e b s i t e ] ( h t t p s : / / c d c - b o t . j s . o r g )
- [ D o c u m e n t a t i o n ] ( h t t p s : / / c d c - b o t . d u t c h m a n - d e v . c o m )
- [ D i s c o r d S e r v e r ] ( h t t p s : / / d i s c o r d . g g / H m t p b r a C n k )
- [ G i t H u b R e p o s i t o r y ] ( h t t p s : / / g i t h u b . c o m / c d c - b o t - j s - n p m / c d c - b o t . j s )
- [ D o c u m e n t a t i o n G i t H u b R e p o s i t o r y ] ( h t t p s : / / g i t h u b . c o m / c d c - b o t - j s - n p m / d o c u m e n t a t i o n )
- [ N P M P a c k a g e ] ( h t t p s : / / n p m j s . o r g / p a c k a g e / c d c - b o t . j s )
# # C o n t r i b u t i n g
Y o u w a n t t o h e l p u s w i t h d e v e l o p i n g t h e p a c k a g e ? Y o u c a n c o n t i b u t e t o t h e p a c k a g e ' s d e v e l o p m e n t . R e a d [ C o n t r i b u t i n g ] ( h t t p s : / / g i t h u b . c o m / c d c - b o t - j s - n p m / c d c - b o t . j s / b l o b / m a i n / . g i t h u b / C O N T R I B U T I N G . m d ) f o r m o r e i n f o r m a t i o n .
* W e ' r e n o t a f f i l i a t e d w i t h D i s c o r d .