Documentation
Readme
View as plain text
��A l w a y s O n S e r v e r
T h i s i s a " H e a d l e s s S e r v e r " m o d a l l o w i n g t h e h o s t a n d t h u s t h e g a m e w o r l d t o r e m a i n o n l i n e a l w a y s , m u c h t h e w a y M i n e c r a f t a n d o t h e r o n l i n e g a m e s f u n c t i o n . I t a c c o m p l i c h e s t h i s b y a u t o m a t i n g t h e H o s t ' s d a y - t o - d a y a c t i v i t i e s .
S h a m e l e s s P l u g
C r e a t e d a 1 0 0 s l o t 2 4 / 7 s e r v e r u s i n g t h i s m o d . J o i n u s : h t t p s : / / d i s c o r d . g g / Y N 2 s J 9 M
H o w t o U s e :
P r e s t h e " F 9 " b u t t o n o n y o u r k e y b o a r d t o t u r n s e r v e r o n / o f f .
W a r n i n g ! - T h e s e r v e r w i l l n o t c l i c k t h r o u g h t h e " L e v e l - U p " s c r e e n . B e c a u s e o f t h i s , i f y o u ' v e d o n e a n y a c t i v i t y d u r i n g t h e d a y t h a t m i g h t c a u s e y o u t o g a i n X P , i t i s r e c o m m e n d e d y o u g o t o s l e e p f o r t h e n i g h t a n d t u r n t h e s e r v e r o n f i r s t t h i n g i n t h e m o r n i n g .
W a r n i n g ! - T h e s e r v e r w i l l h a n g o n t h e s h i p p i n g m e n u i f t h e g a m e i s m i n i m i z e d i n w i n d o w s . I t d o e s n ' t h a v e t o h a v e f o c u s , y o u c a n g o d o o t h e r t h i n g s , b u t I T C A N N O T B E M I N I M I Z E D !
H o w t o U s e A d d i t i o n a l F e a t u r e s :
Y o u c a n a l s o t y p e " s e r v e r " i n t o t h e S M A P I c o n s o l e t o t o g g l e t h e s e r v e r o n / o f f .
T h e M o d w i l l c r e a t e a " c o n f i g . j s o n " f i l e i n " S t a r d e w V a l l e y \ M o d s \ A l w a y s O n S e r v e r " f o l d e r a f t e r i t i s f i r s t r u n .
��
������Y o u c a n c h a n g e t h e h o t k e y t o s t a r t / s t o p t h e s e r v e r .
����Y o u c a n c h a n g e w h e n t h e h o s t s l e e p s i n m i l i t a r y t i m e .
����Y o u c a n t u r n o n / o f f ( t r u e / f a l s e ) i f t h e h o s t g o e s t o f e s t i v a l s .
����Y o u c a n a l l o w c l i e n t s t o p a u s e a n d u n p a u s e t h e g a m e b y t y p i n g ( ! p a u s e o r ! u n p a u s e ) i n t o t h e c h a t b o x i n g a m e .
����Y o u c a n t u r n o n / o f f ( t r u e / f a l s e ) i f t h e s e r v e r c o p i e s t h e c u r r e n t i n v i t e c o d e t o t h e c l i p b o a r d .
����Y o u c a n a d j u s t ( i n s e c o n d s ) h o w l o n g b e t w e e n t h e s t a r t o f F e s t i v a l s a n d t h e i r e v e n t s .
T h e s e r v e r w i l l c o p y t h e m o s t u p - t o - d a t e i n v i t e c o d e t o t h e c l i p b o a r d ( o n b y d e f a u l t i n t h e c o n f i g . j s o n f i l e ) w h e n e v e r i t c h a n g e s . Y o u c a n t h e n u s e a m a c r o p r o g r a m o f y o u r c h o i c e t o p a s t e t h a t c o d e i n t o t h e c h a t s e r v i c e o f y o u r c h o i c e s o t h a t y o u r n o n - s t e a m f r i e n d s c a n a l w a y s h a v e a c c e s s t o t h e m o s t u p - t o - d a t e i n v i t e c o d e e v e n w h e n y o u a r e n o t t h e r e . F o r y o u r c o n v e n i e n c e I ' v e i n c l u d e d a n A u t o H o t k e y s c r i p t u n d e r t h e F i l e s T a b > O p t i o n a l F i l e s �� h e r e o n N e x u s t h a t y o u c a n u s e . R u n t h e G a m e S e r v e r > R u n t h e A u t o H o t K e y �� S c r i p t > O p e n D i s c o r d o r o t h e r c h a t s e r v i c e a n d c l i c k i n t o t h e c h a t b o x o f t h a t s e r v i c e . T h e c u r r e n t i n v i t e c o d e f o r y o u r g a m e w i l l b e p a s t e d a n d s e n t e v e r y t w o m i n u t e s . D o n o t c l o s e t h e c h a t w i n d o w o f y o u r c h a t s e r v i c e o r c l i c k o u t o f t h e c h a t b o x o r i t w i l l n o t w o r k . W h e n t h e g a m e s e r v e r i s t u r n e d o f f i t w i l l n o l o n g e r c o p y t h e k e y s o b e s u r e t o t u r n o f f A u t o H o t K e y a s w e l l .
T h e s e r v e r w i l l a l s o c o p y t h e i n v i t e c o d e t o a n " I n v i t e C o d e . t x t " f i l e i n t h e s a m e f o l d e r . Y o u c a n u s e t h i s t o m a k e v a r i o u s b o t s t o d i s p l a y y o u r c o d e . I ' m n o t g o i n g t o g o i n t o a t o n o f d e t a i l o n h o w t o d o t h a t h e r e b u t I w i l l p r o v i d e t h i s l i n k �� t o t h e c o d e y o u w i l l n e e d a n d t h i s l i n k t o a y o u t u b e t u t o r i a l �� a b o u t h o w t o c r e a t e y o u r o w n D i s c o r d B o t .
A l s o i n t h e O p t i o n a l F i l e s �� I h a v e a d d e d a S e r v e r R e s e t M o d . I u s e t h i s t o a l l o w m y D i s c o r d a d m i n s ( o n a p r i v a t e c h a n n e l ) t o r e m o t e l y r e s e t t h e s e r v e r c o n n e c t i o n t h r o u g h a D i s c o r d B o t . H e r e i s t h e s o u r c e c o d e f o r t h e D i s c o r d B o t . ��
F e a t u r e s :
O n l y t h e h o s t n e e d s t o i n s t a l l t h e m o d
H o s t T e l e p o r t s t o b e d a n d A u t o - S l e e p s e v e r y d a y a t ~ 6 : 3 0 A . M . i n g a m e ( O r w i t h i n 0 : 3 0 i n - g a m e c l o c k m i n u t e s , ~ 2 1 s e c o n d s , o f t h e " s e r v e r " s t a r t i n g , e x c e p t o n H o l i d a y s ) s o t h a t o t h e r p l a y e r s c a n k e e p p l a y i n g w i t h o u t t h e h o s t h a v i n g t o b e a t t h e i r c o m p u t e r . O t h e r p l a y e r s c a n g o t o b e d w h e n t h e y ' r e r e a d y a n d w o n ' t b e s t u c k w a i t i n g o n t h e h o s t .
C l i c k s " O K " o n t h e e n d o f d a y S h i p p i n g M e n u a l l o w i n g t h e g a m e t o s a v e a n d s y n c w i t h t h e c l i e n t s .
P a u s e s t h e g a m e w h e n a l l c l i e n t s d i s c o n n e c t . R e s u m e s w h e n a t l e a s t 1 c l i e n t r e j o i n s . T h i s p r e v e n t s t h e f a r m f r o m f a l l i n g i n t o d i s r e p a i r a n d y e a r s o f g a m e t i m e p a s s i n g w i t h n o o n e a r o u n d .
F r e e z e s R e l a t i o n s h i p H e a r t L o s s f o r H o s t w h i l e " s e r v e r " i s r u n n i n g
F u l l F e s t i v a l S u p p o r t ! - E v e n t s l i k e E g g H u n t , I c e F i s h i n g , e t c b e g i n 4 m i n u t e s a f t e r f e s t i v a l s t a r t s s o p l a y e r s h a v e s o m e t i m e t o l o o k a r o u n d . H o s t w i l l n o t g o t o s l e e p u n t i l a f t e r F e s t i v a l t i m e w i n d o w i s o v e r . C l i e n t s c a n c h o o s e t o g o t o f e s t i v a l o r n o t , s e r v e r w i l l s t i l l w o r k . A l l c l i e n t s m u s t g o t o f e s t i v a l t o t r i g g e r i t t o s t a r t j u s t l i k e n o r m a l g a m e - p l a y .
F u l l E v e n t S u p p o r t ! - G r a m p a E v a l u a t i o n , K e n t a r r i v a l , e t c e t c w i l l a l l c l i c k t h r o u g h i f t h e y p o p - u p a l l o w i n g t h e s e r v e r t o s t a y o n l i n e a n d n o t g e t l o c k e d u p .
S e r v e r O n / O f f a n d F e s t i v a l a n d E v e n t W a r n i n g s s e n t t o c l i e n t s v i a c h a t .
T u r n s o f f " P a u s e W h e n G a m e W i n d o w I s I n a c t i v e " s o y o u n o l o n g e r h a v e t o .
C o n f i g f i l e f o r t i m i n g a d j u s t m e n t s o f F e s t i v a l E v e n t s a n d c h a n g i n g t h e o n / o f f H o t k e y .
C o p i e s m o s t u p - t o - d a t e I n v i t e C o d e t o c l i p b o a r d
C o p i e s m o s t u p - t o - d a t e I n v i t e C o d e t o " I n v i t e C o d e . t x t " f i l e i n s i d e t h e " A l w a y s O n S e r v e r " m o d f o l d e r
T h i s i s m y f i r s t m o d ! W o o H o o !
H u g e t h a n k s t o Z u b e r i i w h o c o - a u t h o r e d m u c h o f t h e F e s t i v a l a n d E v e n t s c o d e .
S o u r c e C o d e f o r a n y o n e w h o w a n t s t o d i g t h r o u g h m y s p a g h e t t i . I t ' s p r e t t y u g l y . T h i s i s o n e o f t h e f i r s t t h i n g s I ' v e e v e r c o d e d .
R e q u i r e s S M A P I b y P a t h o s c h i l d + a n d S D V 1 . 3 + .