Skip to content

Package Structure

Joshua Cleland edited this page Jan 7, 2017 · 1 revision

Package Structure.

We are using JSON to collect our information for packages.
Let's look at a package with One defined function:

{
"Defines": [
  {
     "Name": "UserMessageSend",
     "Params": [
        "UserID",
        "Message"
     ],
     "Content": "{pm:{0}}{1}"
  }
}

Alright now what you're looking at above is a function to send a custom user a custom message.
Make sure you have read up on the Github Main README.md if you don't understand the {0},{1}

Multiple defined functions in a page below:

{
"Defines": [
  {
     "Name": "UserMessageSend",
     "Params": [
        "UserID",
        "Message"
     ],
     "Content": "{pm:{0}}{1}"
  },
  {
     "Name": "ActiveMessageSend",
     "Params": [
        "Message"
     ],
     "Content": "{pm}{0}"
  }
}

Now your package will include the UserMessageSend & ActiveMessageSend. What's the difference?
UserMessageSend will direct message a defined user. or you can set it up to pm multiple.
ActiveMessageSend will message the user who triggers the function. Or whoever is mentioned in the trigger.

Clone this wiki locally