Use text snippets for tutorial messages

data/json/snippets/tutorial.json

@@ -0,0 +1,168 @@
+[
+  {
+    "type": "snippet",
+    "category": "tutorial_messages",
+    "text": [
+      {
+        "id": "LESSON_INTRO",
+        "text": "Welcome to the Cataclysm tutorial!  As you play, pop-ups like this one will appear to guide you through the basic game actions.  Pressing spacebar will close the pop-up."
+      },
+      {
+        "id": "LESSON_MOVE",
+        "text": "The '@' character in the center of the screen represents you.  To move, you can use the numpad, the vikeys (hjklyubn), or the arrow keys.  To have your character wait in place, press '.'"
+      },
+      {
+        "id": "LESSON_LOOK",
+        "text": "To see what the symbols around you mean, press ';'.  You'll be able to scroll around and get information on the terrain, monsters, and items in the world around you."
+      },
+      {
+        "id": "LESSON_OPEN",
+        "text": "That brown '+' next to you is a closed door.  To open it, either simply walk into it, or press 'o' and then a movement key."
+      },
+      {
+        "id": "LESSON_CLOSE",
+        "text": "You can close an opened door by pressing 'c' and then a movement key.  Closing doors behind you can often slow down throngs of monsters greatly."
+      },
+      {
+        "id": "LESSON_SMASH",
+        "text": "Most monsters will have to smash their way through a closed door.  If a door is locked or stuck, you can smash it by pressing 's' and then a movement key."
+      },
+      {
+        "id": "LESSON_WINDOW",
+        "text": "You can smash through windows by pressing 's' and then a movement key.  A smashed window takes a long time to climb through, and it's possible to hurt yourself on the broken glass, but it's a good last-ditch escape route.  You can smash through other things, too."
+      },
+      {
+        "id": "LESSON_PICKUP",
+        "text": "You just stepped on a space with one or more items.  If you wish to pick it up, press ',' or 'g'."
+      },
+      {
+        "id": "LESSON_EXAMINE",
+        "text": "The nearby { is a display rack, and the blue background indicates that there are items there.  If you press 'g' while adjacent to the rack, you can pick up items without moving to the square."
+      },
+      {
+        "id": "LESSON_INTERACT",
+        "text": "The Examine command 'e' can be used for interacting with some terrain and furniture.  Interactive terrain is often designated with a '6' symbol."
+      },
+      {
+        "id": "LESSON_FULL_INV",
+        "text": "You don't have space in your inventory to store the item you just tried to pick up.  You need to wear something with storage space, like a backpack or cargo pants, to gain more storage space."
+      },
+      {
+        "id": "LESSON_WIELD_NO_SPACE",
+        "text": "The item you just picked up has been wielded as a weapon automatically.  This happened because you do not have space in your inventory to stash the item, and so you must carry it in your hand.  To expand your inventory space, try wearing clothing with a lot of storage space, like a backpack, or cargo pants."
+      },
+      {
+        "id": "LESSON_AUTOWIELD",
+        "text": "The item you just picked up has been wielded as a weapon automatically.  This happened because it is a good melee weapon, and you were empty-handed.  This usually is faster than than picking it up, then wielding it."
+      },
+      {
+        "id": "LESSON_ITEM_INTO_INV",
+        "text": "The item you just picked up went into your inventory, the shared storage space of all the clothing you're wearing.  To view your inventory, press 'i'.  You can then press the letter of any item to get more information about it."
+      },
+      {
+        "id": "LESSON_GOT_ARMOR",
+        "text": "The item you just picked up is a type of clothing!  To wear clothing, press W and then select an item.  To take off clothing, press T, or simply take it off and drop it in one action by pressing d."
+      },
+      {
+        "id": "LESSON_GOT_WEAPON",
+        "text": "The item you just picked up is a good weapon!  To wield a weapon, press w, then pick what to wield.  To wield nothing, either drop your weapon with d, or press 'w-' to put it away.  A zombie has spawned nearby.  To attack it, simply move into it."
+      },
+      {
+        "id": "LESSON_GOT_FOOD",
+        "text": "The item you just picked up is a comestible!  To eat a comestible, press 'E'.  Comestibles are items you can use up, like food, drink, pills, etc.  Most food expires eventually, so be careful.  Some comestibles, especially drugs, can cause subtle, long-term effects."
+      },
+      {
+        "id": "LESSON_GOT_TOOL",
+        "text": "The item you just picked up is a tool!  To activate a tool, press 'a'.  Some tools have a set charge, which can be reloaded once depleted.  Other are single-use items, and still others are reusable."
+      },
+      {
+        "id": "LESSON_GOT_GUN",
+        "text": "The item you just picked up is a firearm!  Guns are very powerful weapons but they require ammunition.  Firearms have many special attributes.  Most modify the damage done by their ammunition.  They also have dispersion, which affects their chance to hit.  Some guns are semi-automatic, while others can fire a burst.  Some firearms (mainly bows and other muscle-powered weapons) have a range, which is added on top of the ammo's range when firing."
+      },
+      {
+        "id": "LESSON_GOT_AMMO",
+        "text": "The item you just picked up is ammunition, used with a gun.  It has many special attributes.  The damage value is the maximum done on a standard hit; a critical hit or headshot will do much more damage.  Some monsters or NPCs will wear armor which reduces the damage from gunfire; a high Armor-pierce value will reduce this effect.  The Range is the maximum range the ammo can achieve, and the dispersion affects its chance to hit."
+      },
+      {
+        "id": "LESSON_WORE_ARMOR",
+        "text": "You just put on an article of clothing that provides physical protection.  There are two types of damage that clothing defends against, bashing, and cutting.  Most monsters deal bashing damage, but cutting is often the more deadly of the two.  Bullets are considered cutting damage."
+      },
+      {
+        "id": "LESSON_WORE_STORAGE",
+        "text": "You just put on an article of clothing that provides ample storage space.  This will allow you to carry much more stuff, but be aware that there is also a limit on the weight you can carry which depends on strength.  The item you put on also encumbered your torso.  This will make combat a little more difficult.  To check encumbrance, press @."
+      },
+      {
+        "id": "LESSON_WORE_MASK",
+        "text": "You just put on an article of clothing that protects against the environment.  The most common and important are respiratory devices, which will protect you against smoke, air-born toxins or organisms, and other common hazards.  However, they also make it a little harder to breath when running, so you'll move more slowly.  To check encumbrance, press @."
+      },
+      {
+        "id": "LESSON_WEAPON_INFO",
+        "text": "If you press 'i' and then the letter of your weapon, you'll see its combat stats.  Bashing damage ignores most armor, but varies greatly and requires strength.  Cutting damage is a fixed amount, but is blocked by armor.  The To-hit bonus affects your chances of hitting.  The amount of time it takes to swing your melee weapon depends on both its size and weight; small, compact weapons are the fastest."
+      },
+      {
+        "id": "LESSON_HIT_MONSTER",
+        "text": "Hitting a monster will stun it briefly, allowing you to escape or get in another attack.  Your dexterity and melee skills are used to determine whether an attack hits, while strength affects damage."
+      },
+      {
+        "id": "LESSON_PAIN",
+        "text": "Taking damage often causes pain.  Small amounts of pain are tolerable, but as it gets worse your stats will drop and you will move much slower.  To reduce pain, take painkillers like codeine, or simply wait it out."
+      },
+      {
+        "id": "LESSON_BUTCHER",
+        "text": "When you kill a monster it will often leave behind a corpse.  Corpses can be important sources of food, but you must Butcher them by standing on the corpse and pressing 'B'.  You'll need a bladed weapon in your inventory, preferably a small, very sharp one.  An unskilled butcher may only get a few pieces of meat, or none at all.  Note that many monsters, such as zombies, leave tainted meat, unsuitable for consumption."
+      },
+      {
+        "id": "LESSON_TOOK_PAINKILLER",
+        "text": "That drug you just took is a painkiller.  Painkillers are very important to keep on hand, as pain both penalizes your stats and makes you slower.  Be careful, as the stronger painkillers can make you woozy, and some are even addictive."
+      },
+      {
+        "id": "LESSON_TOOK_CIG",
+        "text": "That drug you just took placed an effect on you.  To check your effects, press '@'.  Most only last a short while, while others, like chronic disease, last until cured by some other means."
+      },
+      {
+        "id": "LESSON_DRANK_WATER",
+        "text": "You just drank a bottle of water, reducing your thirst level and reducing the water level in the bottle.  You'll probably want to drop empty bottles, or you might want to save them to refill from a water source later."
+      },
+      {
+        "id": "LESSON_ACT_GRENADE",
+        "text": "You just activated a grenade!  You probably want to throw it.  To throw an item, press 't' and then select the item to throw.  The maximum range depends on your strength and the object's weight and size.  Throwing isn't very good in most combat situations, but if you've got some fire power…"
+      },
+      {
+        "id": "LESSON_ACT_BUBBLEWRAP",
+        "text": "You just placed a trap.  Traps are permanent until set off, and can be an important defensive tactic, particularly when sleeping in unsafe territory.  Try stepping on that _ -- don't worry, it's a harmless bubblewrap trap."
+      },
+      {
+        "id": "LESSON_OVERLOADED",
+        "text": "You're carrying more volume than you have storage for, which means you are carrying some stuff in the crook of your arm or in some other awkward manner.  While overloaded like this, you will suffer SEVERE encumbrance penalties, making combat dangerous.  Either drop an item, or possibly wield something-- the object you are wielding does not take up inventory space."
+      },
+      {
+        "id": "LESSON_GUN_LOAD",
+        "text": "To use a gun, first wield it with the 'w' key.  Next you need to reload using the 'r' key, assuming you have the proper ammo.  If you wish to unload your gun, possibly to change ammunition types, press 'U'."
+      },
+      {
+        "id": "LESSON_GUN_FIRE",
+        "text": "Once you have a loaded gun wielded, you can fire it.  Press the 'f' key to fire a single shot.  With many guns, you can fire a burst by pressing 'F'.  You'll automatically target the last monster you shot at, or the closest monster to you.  You can change your target with the movement keys, or cycle through monsters with '<' and '>'.  To fire, press 'f' or '.'; to cancel, hit the escape key."
+      },
+      {
+        "id": "LESSON_RECOIL",
+        "text": "After firing your gun, you will probably notice a Recoil alert in the lower right.  Generally speaking, the more damaging the ammo, the worse the recoil.  Recoil severely reduces your chance to hit, but you can eliminate recoil by pausing ('.') for a turn or moving normally.  High strength reduces recoil, so weak characters might want to stick to .22 or 9x19mm guns."
+      },
+      {
+        "id": "LESSON_STAIRS",
+        "text": "That yellow > next to you is a staircase leading down.  To go downstairs, step onto the staircase and press the '>' key.  Similarly, a yellow < is stairs leading up, and can be followed with the '<' key."
+      },
+      {
+        "id": "LESSON_DARK_NO_FLASH",
+        "text": "It's dark down here!  Without a source of light, you'll be limited to seeing only one space in any direction.  You'll encounter darkness while underground or at night.  Press '<' to go back upstairs, and look around for a flashlight."
+      },
+      {
+        "id": "LESSON_DARK",
+        "text": "It's dark down here!  Fortunately, you have a flashlight.  Press 'a' and then select your flashlight to turn it on."
+      },
+      {
+        "id": "LESSON_PICKUP_WATER",
+        "text": "~ is a terrain symbol that indicates water.  From a water source like this, you can fill any containers you might have.  Examine the water ('e') and press 'c' to fill a container, then select a watertight container to put the water into."
+      }
+    ]
+  }
+]