AutoCast - setup

Jan 5, 2018
AutoCast - setup
  • AutoCast is one of the most customizable broadcasting plugins out there. And in this wiki page I'll explain everything in the config, data, and messages.yml

    Config.yml

    Code (Text):
    # AutoCast
    #
    # Welcome to AutoCast, the most customizable AutoBroadcasting plugin on spigot.
    #
    # This is the config.yml, you can edit every setting from the plugin in here.
    # For more information go to: https://www.spigotmc.org/wiki/autocast-plugin/
    #

    BroadcasterSettings:
      Interval: 12000
      RandomOrder: true
      Log: true

    Join:
      MOTD:
        Enabled: true
      JoinMessage:
        Enabled: true
        BeforeMOTD: true
        ClearChatOnJoin: true

    Quit:
      Enabled: true

    RegionMessages:
      Enter: true
      Quit: false

    Permissions:
      Reload: 'autocast.reload'
      Enable:  'autocast.enable'
      Disable: 'autocast.disable'
      Force:  'autocast.force'
      Preview: 'autocast.preview'
      Hide: 'autocast.hide'
     

    • BroadcasterSettings: Contains all settings for the automated broadcasting system
      • Interval: Declares how long it should take in order to send a new message (In ticks)
      • RandomOrder: Declares if the sent messages should be in a random order or not
      • Log: Declares if a sent message should be logged in the console

    • Join: Contains all settings for when a player joins
      • MOTD: All settings from the MOTD
        • Enabled: Declares if the MOTD should be enabled or not
      • JoinMessage: All settings from the joinmessages
        • Enabled: Declares if the custom join message should be enabled or not
        • BeforeMOTD: Declares if the joinmessage should display before the MOTD
        • ClearChatOnJoin: Declares if the chat should be cleared on join

    • Quit: Contains all settings for when a player quits
      • Enabled: Declares if the quit message should be enabled or not

    • RegionMessages: Contains all the settings of the regions
      • Enter: Declares if a message should be sent if you enter a region
      • Quit: Declares if a message should be sent if you leave a region

    • Permissions: Contains all permissions, which are customizable
      • Reload: Permission to reload
      • Enable: Permission to enable the automatic broadcasting
      • Disable: Permission to disable the automatic broadcasting
      • Force: Permission to force a new broadcast
      • Preview: Permission to preview one of the messages.
      • Hide: Permission to hide the messages for yourself

    Messages.yml

    Code (Text):
    # Messages.yml
    #
    # Welcome to the messages file! Everything in this config is customizable.
    # For more information go to: https://www.spigotmc.org/wiki/autocast-plugin/
    #

    Messages:
      1:
        Enabled: true
        Message:
          Text:
            - '&7[&aAutoCast&7]: Thanks for downloading autocast!'
            - '&7Click to see the plugin page!'
          ClickType: 'LINK'
          OnClick: 'https://www.spigotmc.org/resources/43894/'
          Hover: '&cHello %player_name%'
        Sound: 'BLOCK_ANVIL_FALL'
        Particle: 'NONE'
        Permission: 'NONE'
        Other:
          Commands:
            Commands:
              - 'p:me loves autocast!'
              - 'c:give %player% dirt 1'
            Enabled: true
          Title:
            Title:
              - '&cTitle one %player_name%;&aSubtitle one %player_name%'
              - '&aTitle two %player_name%;&cSubtitle two %player_name%'
              - ' ;&cSubtitle only'
              - '&aTitle only; '
            Enabled: true
            Repeat: 0
            Delay: 10
          ActionBar:
            Text:
              - '&cActionBar one %player_name%'
              - '&aActionBar two %player_name%'
            Enabled: true
            Repeat: 0
            Delay: 10
          Book:
            Pages:
              1:
                - '&cPage one %player_name%'
              2:
                - '&aPage two %player_name%'
              3: []
              4:
                - 'The last page was empty!'
            Enabled: false
          Bossbar:
            Text:
              - 'RED;Bossbar one %player_name%'
              - 'GREEN;Bossbar two %player_name%'
            Delay: 10
            Repeat: 5
            Enabled: true

    MOTD:
      FirstJoin:
        Message:
          Text:
            - '&7Welcome %player_name%, you''ve been welcomed by AutoCast'
            - '&7Click to see the rules command'
          ClickType: 'SUGGESTCOMMAND'
          OnClick: '/rules'
          Hover: '&cHello %player_name%'
        Sound: 'BLOCK_ANVIL_FALL'
        Particle: 'NONE'
        Permission: 'NONE'
        Other:
          Commands:
            Commands:
              - 'p:Yay, I joined the server!'
            Enabled: false
          Title:
            Title:
              - 'Welcome!;%player_name%'
            Enabled: true
            Repeat: 0
            Delay: 10
          ActionBar:
            Text:
              - '&cWelcome %player_name%'
              - '&acWelcome %player_name%'
            Enabled: true
            Repeat: 5
            Delay: 10
          Book:
            Pages:
              1:
                - '&cWelcome to the server %player_name%'
              2:
                - '&aRules here'
              3: []
              4:
                - '&cnow leave'
            Enabled: false
          Bossbar:
            Text:
              - 'RED;Welcome %player_name%'
              - 'GREEN;Welcome %player_name%'
            Delay: 10
            Repeat: 5
            Enabled: true
      Rejoin:
        Message:
          Text:
            - '&7Welcome back %player_name%'
            - '&7Click to see your balance!'
          ClickType: 'COMMAND'
          OnClick: 'balance'
          Hover: '&cHello %player_name%'
        Sound: 'BLOCK_ANVIL_FALL'
        Particle: 'NONE'
        Permission: 'NONE'
        Other:
          Commands:
            Commands:
              - 'p:Yay, I joined the server!'
            Enabled: false
          Title:
            Title:
              - 'Welcome back!;%player_name%'
            Enabled: true
            Repeat: 0
            Delay: 10
          ActionBar:
            Text:
              - '&cWelcome back %player_name%'
              - '&acWelcome back %player_name%'
            Enabled: true
            Repeat: 5
            Delay: 10
          Book:
            Pages:
              1:
                - '&cWelcome back %player_name%'
              2:
                - '&aNews here'
              3: []
              4:
                - '&cnow leave'
            Enabled: false
          Bossbar:
            Text:
              - 'RED;Welcome back %player_name%'
              - 'GREEN;Welcome back %player_name%'
            Delay: 10
            Repeat: 5
            Enabled: true

    RegionMessages:
      Enter:
        Spawn:
          Message:
            Text:
              - '&7Welcome to spawn!'
            ClickType: 'NONE'
            OnClick: 'NONE'
            Hover: 'NONE'
          Sound: 'NONE'
          Particle: 'NONE'
          Permission: 'NONE'
          Other:
            Commands:
              Commands:
                - ''
              Enabled: false
            Title:
              Title:
                - '&7Welcome in spawn;%player_name%'
              Enabled: true
              Repeat: 4
              Delay: 10
            ActionBar:
              Text:
                - ''
              Enabled: false
              Repeat: 5
              Delay: 10
            Book:
              Pages:
                1: []
              Enabled: false
            Bossbar:
              Text:
                - ''
              Delay: 10
              Repeat: 5
              Enabled: false
      Quit:
        Spawn:
          Message:
            Text:
              - '&7Bye!'
            ClickType: 'NONE'
            OnClick: 'NONE'
            Hover: 'NONE'
          Sound: 'NONE'
          Particle: 'NONE'
          Permission: 'NONE'
          Other:
            Commands:
              Commands:
                - ''
              Enabled: false
            Title:
              Title:
                - '&7Bye;%player_name%'
              Enabled: true
              Repeat: 4
              Delay: 10
            ActionBar:
              Text:
                - ''
              Enabled: false
              Repeat: 5
              Delay: 10
            Book:
              Pages:
                1: []
              Enabled: false
            Bossbar:
              Text:
                - ''
              Delay: 10
              Repeat: 5
              Enabled: false

    Other:
      JoinMessage:
        FirstJoin:
          Message: '&c%player_name% joined for the first time!'
          Click: 'NONE'
          ClickType: 'SUGGESTCOMMAND'
          Hover: 'Welcome %player_name%!'
        Rejoin:
          Message: '&c%player_name% just joined with a ping of %player_ping%ms'
          Click: 'NONE'
          ClickType: 'NONE'
          Hover: 'NONE'
     QuitMessage:
       Quit:
         Message: '&c%player_name% left!'
         Click: 'NONE'
         ClickType: 'NONE'
         Hover: 'NONE'

    PluginMessages:
      NoPermission: '&7[&cError&7]: You don''t have permissions to execute this command!'
      NotAPlayer: '&7[&cError&7]: You aren''t a player!'
      AlreadyEnabled: '&7[&cError&7]: AutoCast is already enabled'
      AlreadyDisabled: '&7[&cError&7]: AutoCast is already disabled'
      Enabled: '&7[&aAutoCast&7]: AutoCast is now enabled'
      Disabled: '&7[&aAutoCast&7]: AutoCast is now disabled'
      SpecifyPreview: '&7[&cError&7]: Specify a message to preview! Valid messages are %messages%'
      InvalidArgument: '&7[&cError&7]: The message you specified is unknown!'
     

    As you can see, this file is quite big. I'll explain the message layout once.

    • Messages: Contains all messages for the auto broadcaster
      • 1: Message name (Should be an upcounting number)
        • Enabled: Declares if the message is enabled or not
        • Message: Contains all the settings for the message
          • Text: Contains all text for the message
          • ClickType: Declares what the plugin should do on a click, valid types are LINK, COMMAND, and SUGGESTCOMMAND
          • OnClick: Declares what is should link, execute or suggest on click
          • Hover: Declares the message when you hover over it
        • Sound: Declares the sound that should play
        • Particle: Declares the particle that should appear
        • Permission: Declares the permission the player should have in order to see the message
        • Other: Contains all the other settings of the message
          • Commands: Contains all the settings of the commands
            • Commands: Contains all the commands that should be executed. Commands starting with 'p:' are executed by the player, and starting with 'c:' by the console
            • Enabled: Declares if the commands should be enabled or not
          • Title: Contains all the settings of the titles
            • Title: Contains all the titles/subtitles, seperated by a ';'. In order to remove one of the titles enter a space.
            • Enabled: Declares if the titles are enabled or not
            • Repeat: Declares how many times the titles should repeat, useful for animations
            • Delay: Declares how long it should take for the next title to appear
          • ActionBar: Contains all settings of the actionbar
            • Text: Declares the text displayed on the actionbar
            • Enabled: Declares if the actionbars are enabled or not
            • Repeat: Declares how many times the actionbars should repeat, useful for animations
            • Delay: Declares how long it should take for the next actionbar to appear
          • Book: Contains all the settings of the book
            • Pages: Contains all the pages
              • 1: Page number followed by the text. In order to have a empty page enter '[]'
            • Enabled: Declares if the books are enabled or not
          • Bossbar: Contains all the settings of the bossbar
            • Text: Declares the text displayed on the bossbar
            • Delay: Declares how long it should take for the next bossbar to appear
            • Repeat: Declares how many times the bossbar should repeat, useful for animations.
            • Enabled: Declares if the bossbars are enabled or not

    • MOTD: Contains all the settings for the MOTD
      • FirstJoin: Contains the message when the player joins for the first time
      • Rejoin: Contains the message when the player doesnt join for the first time

    • RegionMessages: Contains all the settings for the region messages
      • Enter: Contains all the messages for when you enter a region
        • Spawn: Region name, contains the message when you enter that region
      • Quit: Contains all the messages for when you quit a region
        • Spawn: Region name, contains the message when you quit that region

    • Other: Contains all the other settings
      • JoinMessage: Contains all the settings of the joinmessages
        • FirstJoin: Contains the settings for when a player joined the first time
        • Rejoin: Contains all the settings for when a player didnt join for the first time
      • QuitMessage: Contains all the settings of the quitmessages
        • Quit: Contains all the settings for when a player quits.

    • PluginMessages:
      • NoPermission: Message sent when you dont have permissions
      • NotAPlayer: Message sent when you arent a player
      • AlreadyEnabled: Message sent when you already enabled autocast
      • AlreadyDisabled: Message sent when you already disabled autocast
      • Enabled: Message sent when you enable autocast
      • Disabled: Message sent when you disable autocast
      • SpecifyPreview: Message sent when you didn't specify the message you wanted to preview
      • InvalidArgument: Message sent when you specified an invalid argument



    Data.yml

    Code (Text):
    # Data file

    LastSent: 1

    Enabled: true

    PlayerData:
      UUID:
        DisabledMessages: false

    • LastSent: Keeps track of the last sent message
    • Enabled: Keeps track if you enabled/disabled the automatic broadcasting
    • PlayerData: Contains all the player data
      • UUID: Player UUID
        • DisabledMessages: Declares if the player has disabled their messages or not.

    This is it. I will expand this more during the updates.

    Last updated on 1/4/2018 2:37PM
  • Loading...
  • Loading...