Permissions + Config

Permissions

  • illness.immune: Grants immunity from ALL diseases (use on admins or players not using the plugin)
  • illness.infectcommand: Allows you to infect other players with a command
  • illness.cureadmincommand: Allows you to cure other players with a command
  • illness.player: Allows players to use command like status, info and cure

Red = Recommended for admins only Green= Recommended for players

Config

Do not edit the config.yml file as it will get overwritten. If you want to make changes/create a custom setup then modify the CustomConfig.yml file generated on start-up. To make the customConfig load on be used then you need to set 'usecustomconfig' to true in the customconfig.yml.

REMEMBER TO ADD THE ILLNESS ROOT NAME TO THE ILLNESS LIST AT THE BOTTOM OR IT WILL NOT LOAD.

Explanation of Diseases Config

  • Name= The name of the disease
  • Description = The description used when a player uses /il info on the disease
  • InfectionRadius = Unused, will be implemented soon.
  • Contraction = A list of events that can cause a contraction. (see contraction events)
  • OnContractMessage = The message that appears when you get infected (leave 'default' to display the default message)
  • Symptons = The tier list of symptoms, conating info about how many tiers there are, the length of each tier and the symptoms and when they occur and what they cause. (see symptons setup)
  • Cure = The list of items needed for curing the disease (In the format amount^items id:items optional data value)

Lets look at this example disease:

Illness:
    SmallCut:
        Name: Small Cut
        Description: A small cut from broken glass or splinter from wood.
        InfectionRadius: 0
        Contraction:
            - BREAKBLOCK(20)&40
            - BREAKBLOCK(20,hand)&3
            - BREAKBLOCK(5)&200
            - BREAKBLOCK(17)&80
        OnContractMessage: default
        Symptoms:
            - 1:
                Duration: forever
                Effects:
                    - POTION:POISON(3,70)&2
                    - POTION:WEAKNESS(30,50)&1
        Cure: 1^359,1^351:1,3^339

IllnessList:
    - SmallCut

It is called Small Cut. Its root name is SmallCut, and it will load as it is added to the IllnessList. The description is 'A small cut from broken glass or splinter from wood.' It has a 1/40 chance when glass is broken. If the glass is broken wit hthe hand it has a 1/3 chance. If wooden planks are broken it has a 1/200 chance and if wood is broken it has a 1/80 chance. Its message on contraction is default. It only has one tier. This tier last forever. It has two symptoms. A poison effect of ferocity 2 occuring every 70 seconds and lasting for 3 seconds and a weakness effect of ferocity 1 occuring every 50 seconds and lasting for 30 seconds. It can be cured with 1 shear, 1 rose dye and 3 paper.

Contraction Events

Each contraction even has these parts to it.

  1. The name. e.g. BREAKBLOCK or ATTACKEDBYENTITY
  2. The data in the brackets e.g. BREAKBLOCK(88) or ATTACKEDBYENTITY(ENDERMAN)
  3. The chance of contraction (in the format 1/the number you put) e.g. BREAKBLOCK(88)&20 = 1/20 chance of contraction when the player breaks soulsand, ATTACKEDBYENTITY(ENDERMAN)&1000 = 1/1000 chance of contraction when the player is hit by an enderman.

This is a list of possible names and the data they collect in the brackets

  • BREAKBLOCK(id of block)
  • BREAKBLOCK(id of block, id of item in hand) for the item in the hand to be null (no item) simply put the id as 'hand'
  • PLACEBLOCK(id of block)
  • EATFOOD(id of food)
  • ATTACKENTITY(name of entity in caps and spaces replaced with a '_') for a list of entity names see here
  • ATTACKENTITY(name of entity...,id of item in hand) for the item in the hand to be null (no item) simply put the id as 'hand'
  • ATTACKEDBYENTITY(name of entity...)
  • PLAYERMOVEIN(id of block) use this to detect if the player is moving in something like water/lava/grass NB: both move events must have a low chance of contraction as this is checked 5 times per second if the player is walking.
  • PLAYERMOVEON(id of block) use this to detect if the player is moving on something like dirt/ice/cobble... NB: both move events must have a low chance of contraction as this is checked 5 times per second if the player is walking.

Symptons Setup

Each sympton looks like this:

- 1:
                Duration: 300
                Effects:
                    - POTION:WEAKNESS(20,40)&1  
                    - POTION:HUNGER(constant)&1
                    - POTION:BLINDNESS(10,80)&3

This sympton is tier 1, it last for 300 seconds and has these effects:

  • A weakness potion effect lasting for 20 second occuring every 40 seconds, it is of ferocity 1
  • A hungerpotion effect that is constant, it is of ferocity 1
  • A blindness potion effect lasting for 10 second occuring every 80 seconds, it is of ferocity 3
- 3:
                Duration: forever
                Effects:
                    - POTION:WEAKNESS(30,40)&1  
                    - POTION:POISON(15,50)&4

This is the third tier of a disease, it lasts forever (until the disease is cured), it has these effects:

  • A weakness potion effect lasting for 30 second occurring every 40 seconds, it is of ferocity 1
  • A posion potion effect lasting for 15 second occurring every 50 seconds, it is of ferocity 4

For a list of potion effects names see here. Remember to replace the spaces with '_' and makes it all in uppercase.

Template

This is a template:

DISEASE ROOT NAME:
        Name: 
        Description: 
        InfectionRadius: 0
        Contraction:
            - 
            - 
        OnContractMessage: default
        Symptoms:
            - 1:
                Duration: 
                Effects:
                    - 
                    -
            - 2:
                Duration:
                Effects:
                    -
                    -
            - 3:
                Duration:
                Effects:
                    -
                    -
            - 4:
                Duration: 
                Effects:
                    -
                    -
            - 5:
                Duration: forever
                Effects:
                    -
                    -
        Cure:

REMEMBER TO ADD THE DISEASES ROOT NAME TO THE ILLNESS LIST AT THE BOTTOM OR IT WILL NOT LOAD.