API.md

   1 # API
   2 ## Groups
   3 MineClone 2 makes very extensive use of groups. Making sure your items and objects have the correct group memberships is very important.
   4 Groups are explained in `GROUPS.md`.
   5
   6 ## Mod naming convention
   7 Mods mods in MineClone 2 follow a simple naming convention: Mods with the prefix “`mcl_`” are specific to MineClone 2, although they may be based on an existing standalone. Mods which lack this prefix are *usually* verbatim copies of a standalone mod. Some modifications may still have been applied, but the APIs are held compatible.
   8
   9 ## Adding items
  10 ### Special fields
  11
  12 All nodes can have these fields:
  13
  14 * `_mcl_hardness`: Hardness of the block, ranges from 0 to infinity (represented by -1). Determines digging times. Default: 0
  15 * `_mcl_blast_resistance`: How well this block blocks and resistst explosions. Default: 0
  16
  17 Use the `mcl_sounds` mod for the sounds.
  18
  19 ## APIs
  20 A lot of things are possible by using one of the APIs in the mods. Note that not all APIs are documented yet, but it is planned. The following APIs should be more or less stable but keep in mind that MineClone 2 is still unfinished. All directory names are relative to `mods/`
  21
  22 ### Items
  23 * Doors: `ITEMS/mcl_doors`
  24 * Fences and fence gates: `ITEMS/mcl_fences`
  25 * Walls: `ITEMS/mcl_walls`
  26 * Beds: `ITEMS/mcl_beds`
  27 * Buckets: `ITEMS/mcl_buckets`
  28
  29 ## Mobs
  30 * Mobs: `ENTITIES/mods`
  31
  32 MineClone 2 uses Mobs Redo [`mobs`] by TenPlus1, a very powerful mod for adding mods of various types.
  33 There are modificiations from the original mod for MineClone 2 compability. Some items have been removed or moved to other mods, but the API is identical.
  34 You can add your own mobs, spawn eggs and spawning rules with this mod.
  35 API documnetation is included in `ENTITIES/mobs/api.txt`.
  36
  37 ### Help
  38 * Item help texts: `HELP/doc/doc_items`
  39 * Low-level help entry and category framework: `HELP/doc/doc`
  40 * Support for lookup tool (required for all entities): `HELP/doc/doc_identifier`
  41
  42 ### HUD
  43 * Statbars: `HUD/hudbars`
  44
  45 ### Utility APIs
  46 * Select random treasures: `CORE/mcl_loot`
  47 * Get flowing direction of liquids: `CORE/flowlib`
  48 * `on_walk_over` callback for nodes: `CORE/walkover`
  49 * Get node names close to player (to reduce constant querying): `PLAYER/mcl_playerinfo`
  50
  51 ### Unstable APIs
  52 These APIs may be subject to change in future. You could already use these APIs but there will probably be breaking changes in the future, or the API is not as fleshed out as it should be. Use at your own risk!
  53
  54 * Panes (like glass panes and iron bars): `ITEMS/xpanes`
  55 * Slabs and stairs: `ITEM/mcl_stairs` **and** `ITEMS/mcstair`
  56 * `_on_ignite` callback: `ITEMS/mcl_fire`
  57 * Farming: `ITEMS/mcl_farming`
  58 * Other mods not listed above
  59
  60 ### Planned APIs
  61
  62 * Flowers
  63 * Saplings and trees
  64 * Custom banner patterns
  65 * Custom dimensions
  66 * Custom portals
  67 * Music discs
  68 * Dispenser and dropper support
  69 * Proper sky and weather APIs
  70 * Explosion API