Readme

UNCRAFTED V1.0 README
Copied directly from file included in download.
---------------------

Send Feedback to Chuckleluck on Bukkit.org.

-------------
TABLE OF CONTENTS:
1. Overview
    1.1 Setup
2. Health Module
    2.1 Thirst
    2.2 Temperature
    2.3 Status Effects
3. Enemy Module
    3.1 Mob Types
    3.2 The Enderdragon
4. Building Module
    4.1 Block Manipulation in the Wild
    4.2 Protection
5. Loot Module
    5.1 Loot Types
    5.2 Custom Items
6. Chat Module
-------------

---------------------------------------

1. OVERVIEW

---------------------------------------

Uncrafted is a zombie survival game inspired by DayZ, Rust, and MineZ. Its focus is on five
"modules", each one controlling a different aspect of the plugin. Before we begin, however,
you must set it up!

-------------
1.1 SETUP
-------------
The first thing you must do is install Uncrafted. Place it in the /plugins/ folder inside your
Bukkit directory. If your server is already running, type "reload" in the console or "/reload"
as a player. There should be a new folder called "Uncrafted" in your plugins folder. Inside is
the config.yml file, which is vital to the functioning of the plugin.

The config currently has 3 major sections, each with a following list of values: "loot",
"locations", and "spawn". The first defines the locations of loot spawns; the second defines the
protected hostile mob-spawning sections of the world; and the third defines the spawn points that
the plugin will randomly choose from to place the player.

You can have an infinite number of each of these. To add a new item to a list, add a new line,
four spaces, a dash -, another space, and the "code". Each section has a slightly different code.
Specific pieces of data are separated by semicolons.

Loot: Give the location (x, y, z, and world name) and the type of loot. For example, the code
"0;64;0;world;CIVILIAN" will place a loot chest at the coordinates x0, y64, z0 in the world named
"world" of the type "CIVILIAN". For a full list of loot types, see section 5.1.

Locations: Give the x and z values, the width and length of the location, the world, and the mob
spawn type. For example, the code "-16;-16;16;16;world;DEFAULT" will protect an area that begins
at x-16, z-16 and extends 16 blocks in either direction, ending at x0, z0. It will spawn the
default mob, Zombies. To see a full list of mob spawn types, see section 3.1. Negative widths and
lengths will go the opposite direction (in this case, it will end at x-32, z-32). Locations span
the entire Y-axis. You can leave out the spawn type, which will default to DEFAULT.

Spawn: Define the x, y, z, and world. For example, the code "0;64;0;world" will add a spawn point
at x0, y64, z0 in the world named "world".

---------------------------------------

2. HEALTH MODULE

---------------------------------------

The Health Module deals with all the most difficult aspects of Uncrafted: staying alive.

-------------
2.1 THIRST
-------------
Your thirst is represented by your EXP level. It can vary from 0 to 20. If it is at 0, you are
dehydrated and will slowly take damage, like starvation. It will slowly decrease. You can
replenish it by drinking from a water bottle. If the bottle is uncured, you will gain 10 levels
and have a chance to contract Common Disease. If it is cured, you will gain 13 levels. You can
cure a water bottle by cooking it in a furnace.

-------------
2.2 TEMPERATURE
-------------
Your temperature is represented by your EXP level. Unlike thirst and hunger, you desire your
temperature to be in the middle, not the top. If it goes too far in either direction, you have
a chance of catching the ailments Freezing, Frostbite, Heat Exhaustion and Heat Stroke. The
following affect your temperature:
- Biome Temperature (Snow decreases, desert increases, etc.)
- Proximity to fire and lit furnaces (increases)
- Being on fire (increases, duh)
- If in water (decreases, has a more profound effect in cold environments)
- If in the rain or snow (decreases)
- Armor (increases, especially leather)
- Ice & Heat Packs (decreases and increases, respectfully)

-------------
2.3 STATUS EFFECTS
-------------
This is a list of status effects, how to acquire them, their actual effects, and how to cure them:

- DEHYDRATION:
    - Acquire: Thirst at 0
    - Effect: Periodic damage.
    - Cure: Drink water.
- COMMON DISEASE:
    - Acquire: Drinking uncured water, standing in soul sand (mud).
    - Effect: Weakness and mining fatigue, occasional hunger and nausea.
    - Cure: Take antibiotics.
- ZOMBIE PLAGUE:
    - Acquire: Get hit by a zombie.
    - Effect: Catch on fire in sunlight, hunger.
    - Cure: Take a Anti-Zombie Vaccine.
- FREEZING:
    - Acquire: Temperature drops below 35%.
    - Effect: Slowness, mining fatigue.
    - Cure: Raise your temperature.
- FROSTBITE:
    - Acquire: Temperature drops below 20%.
    - Effect: All effects of Freezing, occasional damage, chance of unconsciousness.
    - Cure: Raise your temperature.
- HEAT EXHAUSTION:
    - Acquire: Temperature increases over 65%.
    - Effect: Slowness, mining fatigue.
    - Cure: Lower your temperature.
- HEAT STROKE:
    - Acquire: Temperature increases over 80%.
    - Effect: All effects of Heat Exhaustion, occasional damage, chance of unconsciousness.
    - Cure: Lower your temperature.
- BLEEDING:
    - Acquire: Small chance whenever taking damage from an arrow or sword.
    - Effect: Occasional damage.
    - Cure: Apply a bandage.
- BROKEN BONE:
    - Acquire: Take damage from a falling block, falling, arrow, or an explosion.
    - Effect: Slowness, damage on sprinting.
    - Cure: Apply a Splint.
- SPLINTED BROKEN BONE:
    - Acquire: Apply a Splint to a broken bone.
    - Effect: Slowness, damage on sprinting, chance of breaking splint on sprinting.
    - Cure: Wait 2 minutes.
- UNCONSCIOUSNESS:
    - Acquire: Take large amounts of damage, frostbite, heat stroke.
    - Effect: Inability to interact with blocks or items, move, or jump. Blindness.
    - Cure: Wait 2 minutes, or have someone apply a Revival Syringe to you.

Note: For most medical items, you can apply them to yourself with a right-click, or to a friend
with a left-click (you won't hurt them).

---------------------------------------

3. ENEMY MODULE

---------------------------------------

The Enemy Module handles both the spawning of hostile and neutral mobs. Default hostile mob
spawning has been disabled, and instead the locations you defined in the Setup stage spawn a
specific type of mob. Neutral mob spawn rate has been reduced to 1/20th of the vanilla version.

-------------
3.1 MOB TYPES
-------------
This is a list of the types of mobs you can spawn. Note that the name they go by in this section
is the name you should type into the config file to set the location's mob type.

NO_MOBS
    - Spawns no hostile mobs. Neutral mobs can spawn all they want.
DEFAULT
    - Spawns Zombies. Zombies do not burn in sunlight, have increased speed and damage, and
      deal even more damage at night. They drop Zombie Hearts, vital for Anti-Zombie Vaccines.
SPIDER
    - Spawns Spiders, who have speed upgrades.
PIGMAN
    - Spawns Zombie Pigmen. They are always hostile and catch enemies on fire when hit.
WITHER_SKELETON
    - Spawns Wither Skeletons, which represent Vampires. Their swords have Knockback I, and
      they can turn into bats in dire situations.
IRON_GOLEM
    - Spawns Iron Golems. They are always angry, and cannot be hit with arrows.
BLAZE
    - Spawns Blazes. They have increased health, and their fireballs create explosions.

-------------
3.2 THE ENDERDRAGON
-------------
The Enderdragon is a unique mob. Instead of spawning in a region, he is spawned when the Dragon
Egg is right-clicked. He will not break any blocks, but will still fly through them. He can drop
eggs that will spawn Zombies, Pig Zombies, Blazes, and lava. When he is killed, no portal or egg
will spawn (EXP will still drop), and he also drops diamond equipment and an Anti-Zombie Vaccine.

---------------------------------------

4. LOOT MODULE

---------------------------------------

The server administrator can define loot chests, which will open once and disappear once closed.
These chests will randomly spawn at predefined locations, with pseudo-random loot - the general
type of loot is defined by the administrator, but the actual contents is a mystery.

-------------
4.1 LOOT TYPES
-------------
This is a list of the types of loot chests you can define, and the list of items that can spawn
inside one. Note that the name of the loot type is the name you need to type into the config file
to spawn that type of loot.

CIVILIAN
    - Wooden Sword
    - Wooden Axe
    - Wooden Pickaxe
    - Leather Helmet
    - Leather Boots
    - Leather Chestplate
    - Leather Leggings
    - 5 Arrows
    - Rotten Flesh
    - Apple
    - Water Bottle
    - Heat Pack
    - Ice Pack
    - Flint & Steel
    - Healing Herbs
COMMERCIAL
    - All Civilian Items
    - Melon
    - Cooked Beef
    - Cooked Chicken
    - Red Mushroom
    - Brown Mushroom
    - Bowl
    - Wheat
    - Bread
    - Cocoa Beans
    - Saddle
MEDICAL
    - Healing Potion, Level I
    - Healing Potion, Level II
    - Golden Apple
    - Heat Pack
    - Ice Pack
    - Bandage
    - Healing Herbs
    - Splint
    - Anti-Zombie Vaccine
    - Antibiotics
    - Revival Syringe
FARM
    - Antibiotics
    - Wooden Sword
    - Stone Sword
    - Wooden Shovel
    - Wooden Axe
    - Raw Beef
    - Raw Chicken
    - Flint & Steel
    - Saddle
INDUSTRIAL
    - Stone Sword
    - Bow
    - 8 Arrows
    - Splint
    - Iron Pickaxe
    - Iron Axe
    - Iron Shovel
    - Stone Pickaxe
    - Stone Axe
    - Stone Shovel
    - Wooden Pickaxe
    - Wooden Axe
    - Wooden Shovel
    - Stone Hoe
    - Iron Hoe
    - Furnace
COMMON_MILITARY
    - Wooden Sword
    - Wooden Axe
    - Leather Helmet
    - Leather Boots
    - Leather Chestplate
    - Leather Leggings
    - Stone Sword
    - Stone Axe
    - 5 Arrows
    - Bow
    - Bandage
    - Healing Herbs
    - Chainmail Boots
    - Chainmail Helmet
UNCOMMON_MILITARY
    - All Common Military Items
    - Iron Sword
    - Iron Axe
    - Bow, Enchanted with Power I
    - Chainmail Chestplate
    - Chainmail Leggings
    - Chainmail Boots
    - Chainmail Helmet
    - Flintlock Pistol
    - Grenade
    - 5 Gunpowder
    - Iron Horse Armor
RARE_MILITARY
    - Flintlock Pistol
    - 8 Gunpowder
    - Grenade
    - Chainmail Boots
    - Chainmail Helmet
    - Chainmail Leggings
    - Chainmail Chestplate
    - Iron Sword
    - Iron Axe
    - Bow, Enchanted with Power I
    - Iron Sword, Enchanted with Sharpness I
    - Iron Chestplate
    - Iron Leggings
    - Iron Boots
    - Iron Helmet
    - Diamond Sword
    - Diamond Horse Armor

-------------
4.2 CUSTOM ITEMS
-------------
Uncrafted adds a couple new items. They are detailed here, with their use, and crafting recipe, if
applicable.

BANDAGE
    - Basic Item: Paper
    - Use: Apply to yourself or a friend to stop bleeding.
    - Recipe: Shapeless - 1 Paper, 1 Rose Dye.
HEALING HERBS
    - Basic Item: Seeds
    - Use: Apply to yourself or a friend to heal 2 hearts.
    - Recipe: Shapeless - 1 Seeds, 1 Glistering Melon.
SPLINT
    - Basic Item: Wooden Hoe
    - Use: Apply to yourself or a friend to heal a Broken Bone.
    - Recipe: X = Wooden Planks, Y = Sticks
        [ ] [Y] [ ]
        [X] [Y] [X]
        [ ] [Y] [ ]
ANTI-ZOMBIE VACCINE
    - Basic Item: Cactus Green
    - Use: Apply to yourself or a friend to cure their case of the Zombie Plague.
    - Recipe: Shapeless - 1 Zombie Heart, 1 Healing Herbs.
ZOMBIE HEART
    - Basic Item: Spider Eye
    - Use: Used in Anti-Zombie Vaccine recipe.
    - Recipe: None, dropped by Zombies.
ANTIBIOTICS
    - Basic Item: Lime Dye
    - Use: Apply to yourself or a friend to cure their case of the Common Disease.
    - Recipe: None, found in loot.
REVIVAL SYRINGE
    - Basic Item: Redstone Torch
    - Use: Apply to a friend to wake them from Unconsciousness.
    - Recipe: None, found in loot.
FLINTLOCK PISTOL
    - Basic Item: Fire Charge
    - Use: Right-click to fire. Uses Gunpowder as ammunition.
    - Recipe: None, found in loot.
CURED WATER BOTTLE
    - Basic Item: Water Bottle
    - Use: Drink to gain 13 thirst points with no chance of Common Disease.
    - Recipe: Cook a regular water bottle in a furnace.
GRENADE
    - Basic Item: Enderpearl
    - Use: Right-click to toss - explodes where it lands.
    - Recipe: None, found in loot.
RADIO
    - Basic Item: Eye of Ender
    - Use: Place in an inventory slot to hear all others that are talking with their Radios in
           the same slot. Hold in hand to talk on it.
    - Recipe: None, given at spawn - don't lose it!
HEAT PACK
    - Basic Item: Orange Dye
    - Use: Right-click to apply to yourself.
    - Recipe: None, found in loot.
ICE PACK
    - Basic Item: Light Blue Dye
    - Use: Right-click to apply to yourself.
    - Recipe: None, found in loot.

---------------------------------------

5. CHAT MODULE

---------------------------------------

There are two major terms we use when discussing chat: global and local chat. Global chat is
spoken and heard through the Eye of Ender. Local chat is used without.

The Radio (Eye of Ender) is the most important item in chat. Positioning the Radio on the hotbar
has a major effect - it sets the Radio's "channel". You can only hear people talking through
radio on the same channel as you're on. For example, if I talk through my Radio and its on my
first hotbar slot, you wouldn't receive my message unless you also had it in your first hotbar
slot.

To talk through a Radio, hold it in hand. However, you will hear people on the radio regardless
of whether you're holding it.

Local chat (without a radio) is white, while radio chat is green. Local chat's range is limited
to 40 blocks by default - people outside those 40 blocks cannot hear your local chat. You can
increase this range by ending your message with an exclamation point ( ! ), which will extend it
to 75 blocks. You can decrease your message range by starting and ending it with parenthesis ( ),
which will decrease the range to 5 blocks.