search

voxel / issues

an issue tracker and discussion forum for voxel.js related projects
9 stars 2 forks source link

Guide for Minecraft (Bukkit, Sponge, Forge devs) concepts as they correspond to voxel.js (documentation) #8

Open deathcap opened 8 years ago

deathcap commented 8 years ago

@z3t0 started documenting voxel.js on http://voxeljs-documentation.readthedocs.org/, a good start but for this guide it could show how analogous functionality in the familiar world of Minecraft with Bukkit/Sponge/Forge maps to voxel.js, target audience Minecraft mod/plugin developers. For example, tileentity (TE) corresponds to blockdata (BD). Also I was thinking of using GitHub, either the wiki or in a markdown file in a repository, to make it easier to find (centralized location, most everything related to voxel.js is on GitHub and/or NPM).

deathcap commented 8 years ago
Concept Minecraft voxel.js
Language Java JavaScript *
Graphics OpenGL WebGL
Chunk format 16x256x16 rectangular 32x32x32 cubic chunks default, chunkSize in voxel-engine
Block IDs Segmented 12-bit type + 4-bit meta 15-bit flat voxel index in voxel-mesher
Block data Tile Entity (TE) / Block Entity voxel-blockdata (BD)
Items Integer item ID + NBT tags String name + JSON tags in inventory, itempile
Item / block assignment Minecraft Forge API - GameRegistry voxel-registry registerBlock, registerItem
Player scripting Command Blocks voxel-scriptblock
Developer extensibility Bukkit, Spigot, Sponge, Forge APIs, MCP modification voxel-plugins, source modification
Plugin toggling /enable, /disable voxel-plugins-ui
Inventory Hotbar, carried inventory, creative/crafting voxel-inventory-hotbar, voxel-carry, voxel-inventory-creative / voxel-inventory-crafting
Health Health bar drumsticks voxel-health, voxel-health-bar, voxel-health-fall
Food Food voxel-food
Embedded webpages Web Displays mod voxel-webview, gl-css3d
VR (Oculus Rift) Minecrift mod voxel-vr
Commands org.bukkit.command voxel-commands
Recipes Forge recipe registration, Ore Dictionary voxel-recipes, crafting thesaurus
Crafting Crafting table voxel-workbench
Fluids Forge FluidRegistry voxel-fluid
Storage Chest voxel-chests
Processing Furnace voxel-furnace
Mining precision Pickaxe voxel-pickaxe
Mining broad Tinkers Construct hammer voxel-hammer
Mining massive BuildCraft Quarry voxel-quarry
Distance measurement BiblioCraft Tape Measure voxel-measure
Block information What Am I Looking At (WAILA) voxel-voila
Full screen F11 voxel-fullscreen F11
Floating block Extra Utilities Angel Block voxel-skyhook
Texture selection Options - Resource Packs… voxel-drop drag & drop zip resource pack file, or press 'P' to open voxel-artpacks pack priority dialog