README.md

   1 # Minetest mod: Flying Carpet
   2 by Wuzzy
   3
   4 Version: 1.0.0
   5
   6 ## Introduction
   7 Quickly explore the vast terrain with the magical flying carpet. But only the skilled users can master its speed, the fools will crash and hurt themselves.
   8
   9 The carpet flies fast horizontally, but very slowly is it able to move vertically. It constantly reduces your mana resources (if Mana mod is enabled) and will wear out over time.
  10
  11 ## Dependencies
  12 The mod does not depend on anything but it adds some features if certain mods
  13 are available:
  14
  15 * `default` and `wool` (in Minetest Game): Adds a crafting recipe
  16 * `mana`: Using the flying carpet costs mana
  17 * `doc_items`: Adds in-game help for the flying carpet
  18 * `doc_identifier`: Support for the lookup tool
  19
  20 Obtaining
  21 ---------
  22 In Minetest Game (and most similar games), you can craft the flying carpet using the
  23 following recipe:
  24
  25     Red Wool,     Yellow Wool, Red Wool
  26     Yellow Wool,  Red Wool,    Yellow Wool
  27     Mese Crystal, Gold Block,  Mese Crystal
  28
  29 In MineClone 2, replace the mese cystals with redstone blocks.
  30
  31 Games other than Minetest Game *might* work if they have been forked from it.
  32 If you use an entirely different game, you might be able to obtain it in a different
  33 way provided by the game. If all else fails, you can obtain it by “cheating”, using
  34 the server command “`/giveme flying_carpet:carpet`” (requires “`give`” privilege).
  35
  36 ## How to use
  37 Look to the desired initial flight direction and place the carpet on any flat surface which is not inside a liquid. Make sure it has enough space (3×2×3), then place it.
  38
  39 Right-click the carpet to sit on it and depart. Note you can not enter the flying carpet if you are currently in any other vehicle (e.g. boat).
  40 You can also not enter a flying carpet if it is going fast.
  41
  42 The flying carpet has a basic movement speed which the flying carpet is aiming to reach; thus, the carpet flies without your intervention. Use the speed keys to change the speed for a while; they apply only for as long as you hold down the keys. As soon as you release the keys, the carpet will go back to its basic speed again.
  43
  44 Flying the carpet is a bit tricky, because it flies fast, you can't fully brake and the turning speed is rather low. Be careful not to crash into the landscape!
  45
  46 If the carpet is under a certain critical speed, it loses its magic and just drops on the ground.
  47 There is a short “grace period” at the beginning of the flight where this minimum speed limit does not apply.
  48 You can tell by the color of the particles emitted by the flying carpet whether you are critically slow. If the particles are yellow, everything is okay,
  49 but if they become red this means the carpet is going dangerously slow and you should speed up; if you slow down even more you might risk for the flying carpet
  50 to fail.
  51
  52 The flying carpet also fails immediately if you crash into the landscape.
  53 If you crash while being fast, you may also take damage. There is also fall damage, but with the carpet it is greatly reduced compared to a “normal” drop.
  54 Your carpet will also stop working if your mana resources are depleted (only if Mana mod is installed and active).
  55 When your carpet stopped working, you have to collect the carpet (punch it) and place it again.
  56
  57 If you fly directly down onto a flat solid ground, your flying carpet will come to a halt quickly due to
  58 friction.
  59
  60 Your carpet can not fly into liquids from above, but it can fly into them from the side or even below.
  61 But the speed in liquids is greatly reduced and your carpet will likely fail.
  62
  63 ## Long-term usage
  64 Your carpet is not indestructible! Long flights, scratching and crashes will wear out the carpet over
  65 time and it might get destroyed eventually.
  66
  67 Crash-landing at high speeds will deal major damage, so you should avoid crashing at all costs.
  68 Sliding on the surface will deal a minor wear but it is often negligible.
  69
  70 A constant wear is also caused by flying, but very slowly.
  71
  72 If you always fly perfectly, you could use a single flying carpet for about 12 hours. Fly safe to make
  73 the most of your flying carpet!
  74
  75 On high wear levels, the carpet will emit black particles behind it which will increase in number
  76 with its wear. As long there are only a few black particles, you're still good as long as you don't
  77 crash-land. You should get a replacement soon. If the number of black particles is about the
  78 same as the yellow/red particles, the wear has reached a very high level.
  79
  80 On a critical wear level, the carpet will emit a very annoying loud noise while flying. This is the final
  81 warning, you will have roughly five minutes worth of flight until the carpet finally disintegrates under
  82 your feet! You should land as soon as possible.
  83
  84 Additionally, a flying carpet will disintegrate and is lost forever if it stands still and has no user
  85 for 1 minute.
  86
  87 ## Controls
  88 * Up: Hold down to speed up
  89 * Down: Hold down to slow down
  90 * Left: Turn left
  91 * Right: Turn right
  92 * Jump: Ascend
  93 * Sneak: Descend
  94 * Right click carpet: Sit on carpet / Get off the carpet
  95 * Punch carpet:
  96     * While flying: Stop flying immediately
  97     * While not flying: Take it
  98
  99 Note: Collecting and entering a flying carpet is not possible while it is moving fast.
 100
 101 ## Licenses
 102 This mod free software.
 103
 104 ### License of source code
 105 MIT License
 106
 107 ### Authors and licenses of media files
 108 - `flying_carpet_model.obj`: Wuzzy, MIT License
 109 - `flying_carpet_flight.ogg`: MIT License
 110 - `flying_carpet_out_of_energy.ogg`: by p0ss, CC BY-SA 3.0
 111 - `flying_carpet_almost_dead.ogg`: by John, MIT License
 112 - `flying_carpet_place.ogg`: Unknown authors and Wuzzy (compilation of Public Domain sounds), MIT License
 113 - `flying_carpet_take.ogg`: Julien Matthey, modified by Wuzzy, MIT License
 114 - `flying_carpet_surface.png`: Roman Zacharij and Wuzzy, MIT License
 115 - `flying_carpet_wield.png`: Roman Zacharij and Wuzzy, MIT License
 116 - `flying_carpet_inventory.png`: Roman Zacharij and Wuzzy, MIT License
 117 - `flying_carpet_slide.ogg`: crcavol, MIT License
 118 - `flying_carpet_magic_smoke.png`: Wuzzy, MIT License
 119 - `flying_carpet_smoke.png.png`: Wuzzy. MIT License
 120 - `flying_carpet_star.png`: Wuzzy, MIT License
 121 - `flying_carpet_star_warning.png`: Wuzzy, MIT License
 122 - `flying_carpet_star_death_warning.png`: Wuzzy, MIT License
 123 - `flying_carpet_death.png`: Wuzzy, MIT License
 124
 125 ### License references
 126 * [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)