Model Folder Structure: Difference between revisions

Latest revision as of 23:44, 1 February 2019

All darkmod models are now located in the "models/darkmod/" folder. This is to keep our models separate from the regular D3 assets. Note that many folders have sub-folders to organize things further. When there is a grey area, try looking at what is already in the folders to decide where your model should go.

Textures for specific models (other than map_specific) should go in models/darkmod/props/textures

Please use the following guide when uploading models in the future

models/darkmod/architecture

--anything that doesn't fit elsewhere; balconies, etc

models/darkmod/architecture/arches/
models/darkmod/architecture/buildings/ -- prefab buildings
models/darkmod/architecture/doors/ -- doors, handles and doorframes
models/darkmod/architecture/fencing/ -- fences and gates
models/darkmod/architecture/handrails/ -- railing for stairs or other
models/darkmod/architecture/ladders/
models/darkmod/architecture/pillars/
models/darkmod/architecture/stairs/
models/darkmod/architecture/windows -- outdoor and indoor windows

models/darkmod/containers

-- crates, barrels, sacks

models/darkmod/containers/openable -- anything player could open, like chests

models/darkmod/decorative

-- potted plants, globe, etc

models/darkmod/decorative/wall -- paintings, banners, curtains, animal heads, etc
- models/darkmod/decorative/wall/signs -- hanging signs
models/darkmod/decorative/vases
models/darkmod/decorative/statues -- statues and statuettes
models/darkmod/decorative/games -- gameboards, dice, cards, etc

models/darkmod/door_related

-- keys, locks, door knockers

models/darkmod/dungeon

chains, bars, manacles, torture devices, fresh body parts

models/darkmod/furniture

-- any furniture not covered below (armoire, desks, etc)

models/darkmod/furniture/seating -- chairs, sofas, stools
models/darkmod/furniture/tables -- end tables, dining tables, etc
models/darkmod/furniture/beds -- beds
models/darkmod/furniture/shelves -- bookshelves, wineracks, etc

models/darkmod/fireplace

--logs, tools, racks, heat shields, prefab fireplaces

models/darkmod/graveyard

-- tombstones, crypts, etc

models/darkmod/graveyard/bones -- skeletons or skulls

models/darkmod/hangers

-- hooks, brackets, or other things to hang things on

models/darkmod/junk

-- broken objects, refuse, scrap wood, etc

models/darkmod/junk/broken_furniture --specific for furniture pieces
models/darkmod/junk/generic_shards -- broken bits of material, like wood splinters or broken pottery

models/darkmod/kitchen

-- pots, dishes, etc

models/darkmod/kitchen/food
models/darkmod/kitchen/utensils -- spoons, forks, cleavers, etc

models/darkmod/laboratory

-- alchemical equipment, flasks, potion ingredients

models/darkmod/loot

-- anything that is typically loot: gold vases, purses, gold goblets, etc

models/darkmod/loot/coins -- coins or stacks of coins
models/darkmod/loot/exotic -- unique or unusual loot
models/darkmod/loot/jewellery -- bracelets, rings, necklaces

models/darkmod/lights

models/darkmod/lights/extinguishable -- lights that can be put out by water (torches/open flames)
models/darkmod/lights/non-extinguishable -- lights that can't be put out by water
- models/darkmod/lights/non-extinguishable/streetlamps -- outdoor lamps on poles

models/darkmod/map_specific/map name

-- models that are only useful for specific maps, like specialized architecture or lightray models

models/darkmod/misc

-- anything that doesn't fit elsewhere, like rope, a wagon, etc.

models/darkmod/misc/system -- models used for code or for testing

models/darkmod/mechanical

-- boilers, machines, generators

models/darkmod/mechanical/gauges -- dials and displays
models/darkmod/mechanical/pipes -- pipes and valves
models/darkmod/mechanical/switches -- levers, switches and buttons
models/darkmod/mechanical/gears -- cogs and other gears

models/darkmod/musical

-- any musical instrument, viktrolas

models/darkmod/nature

--mushrooms, non-potted plants, etc

models/darkmod/nature/animals/ -- only for animals that don't need animating, like snails
models/darkmod/nature/flowers/
models/darkmod/nature/rocks/ -- rocks, boulders, etc
models/darkmod/nature/trees -- All trees or stumps

models/darkmod/player_equipment

-- potions, flashbombs, lockpicks, mines, etc

models/darkmod/readables

-- books, scrolls, signs, plaques

models/darkmod/tools

-- pick-axe, shovel, anvil, etc (NOT for player tools)

models/darkmod/tools/household -- brooms, mops,

models/darkmod/waterworks

--sources of water like fountains, wells, water pumps, etc

models/darkmod/weapons

-- weapons, mage staves, arrows

models/darkmod/wearables

-- slippers, pouches (non-loot), belt buckles, clothes

models/darkmod/wearables/headgear -- helmets, hats, hairpieces, eyeglasses
models/darkmod/wearables/armour -- pauldrons, breastplates

@@ Line 1: / Line 1: @@
-All darkmod models are now located in the "'''darkmod/models/darkmod/'''" folder. This is to keep our models separate from the regular D3 assets.
+All darkmod models are now located in the "'''models/darkmod/'''" folder. This is to keep our models separate from the regular D3 assets. Note that many folders have sub-folders to organize things further.  When there is a grey area, try looking at what is already in the folders to decide where your model should go.
-'''models/chars, models/md5, models/props''' and '''models/weapons''', have not been moved, because it would cause too much havoc in the code (models/chars will eventually be deleted--the others will unfortunately have to remain, even though it creates some confusion).
+Textures for specific models (other than map_specific) should go in '''models/darkmod/props/textures'''
 == Please use the following guide when uploading models in the future ==
 === models/darkmod/architecture ===
-*'''models/darkmod/architecture''' -- pillars, ladders, prefab houses, etc
+--anything that doesn't fit elsewhere; balconies, etc
-**'''models/darkmod/architecture/windows''' -- outdoor and indoor windows
-All relevant textures should go in models/darkmod/architecture
+*'''models/darkmod/architecture/arches/'''
+*'''models/darkmod/architecture/buildings/'''  -- prefab buildings
+*'''models/darkmod/architecture/doors/''' -- doors, handles and doorframes
+*'''models/darkmod/architecture/fencing/''' -- fences and gates
+*'''models/darkmod/architecture/handrails/''' -- railing for stairs or other
+*'''models/darkmod/architecture/ladders/'''
+*'''models/darkmod/architecture/pillars/'''
+*'''models/darkmod/architecture/stairs/'''
+*'''models/darkmod/architecture/windows''' -- outdoor and indoor windows
+=== models/darkmod/containers ===
+-- crates, barrels, sacks
+*'''models/darkmod/containers/openable''' -- anything player could open, like chests
+=== models/darkmod/decorative ===
+-- potted plants, globe, etc
+* '''models/darkmod/decorative/wall''' -- paintings, banners, curtains, animal heads, etc
+**'''models/darkmod/decorative/wall/signs''' -- hanging signs
+* '''models/darkmod/decorative/vases'''
+* '''models/darkmod/decorative/statues''' -- statues and statuettes
+* '''models/darkmod/decorative/games''' -- gameboards, dice, cards, etc
+=== models/darkmod/door_related ===
+-- keys, locks, door knockers
+=== models/darkmod/dungeon ===
+chains, bars, manacles, torture devices, fresh body parts
+=== models/darkmod/furniture ===
+-- any furniture not covered below (armoire, desks, etc)
+* '''models/darkmod/furniture/seating''' -- chairs, sofas, stools
+* '''models/darkmod/furniture/tables''' -- end tables, dining tables, etc
+* '''models/darkmod/furniture/beds''' -- beds
+* '''models/darkmod/furniture/shelves''' -- bookshelves, wineracks, etc
+=== models/darkmod/fireplace ===
+--logs, tools, racks, heat shields, prefab fireplaces
+=== models/darkmod/graveyard ===
+-- tombstones, crypts, etc
+*'''models/darkmod/graveyard/bones''' -- skeletons or skulls
+=== models/darkmod/hangers ===
+-- hooks, brackets, or other things to hang things on
+=== models/darkmod/junk ===
+-- broken objects, refuse, scrap wood, etc
+*'''models/darkmod/junk/broken_furniture'''  --specific for furniture pieces
+*'''models/darkmod/junk/generic_shards''' -- broken bits of material, like wood splinters or broken pottery
+=== models/darkmod/kitchen ===
+--  pots, dishes, etc
+* '''models/darkmod/kitchen/food'''
+* '''models/darkmod/kitchen/utensils''' -- spoons, forks, cleavers, etc
+=== models/darkmod/laboratory ===
+-- alchemical equipment, flasks, potion ingredients
+=== models/darkmod/loot ===
+-- anything that is typically loot: gold vases, purses, gold goblets, etc
+*'''models/darkmod/loot/coins''' -- coins or stacks of coins
+*'''models/darkmod/loot/exotic''' -- unique or unusual loot
+*'''models/darkmod/loot/jewellery''' -- bracelets, rings, necklaces
+=== models/darkmod/lights ===
+*'''models/darkmod/lights/extinguishable''' -- lights that can be put out by water (torches/open flames)
+*'''models/darkmod/lights/non-extinguishable''' -- lights that can't be put out by water
+**'''models/darkmod/lights/non-extinguishable/streetlamps''' -- outdoor lamps on poles
+=== models/darkmod/map_specific/*map name* ===
+-- models that are only useful for specific maps, like specialized architecture or lightray models
+=== models/darkmod/misc ===
+-- anything that doesn't fit elsewhere, like rope, a wagon, etc.
+*'''models/darkmod/misc/system'''  -- models used for code or for testing
+=== models/darkmod/mechanical ===
+-- boilers, machines, generators
+*'''models/darkmod/mechanical/gauges''' -- dials and displays
+*'''models/darkmod/mechanical/pipes''' -- pipes and valves
+*'''models/darkmod/mechanical/switches''' -- levers, switches and buttons
+*'''models/darkmod/mechanical/gears''' -- cogs and other gears
+=== models/darkmod/musical ===
+-- any musical instrument, viktrolas
 === models/darkmod/nature ===
-*'''models/darkmod/nature''' -- rocks, mushrooms, non-potted plants
+--mushrooms, non-potted plants, etc
-**'''models/darkmod/nature/trees''' -- All trees or stumps
+*'''models/darkmod/nature/animals/'''  -- only for animals that don't need animating, like snails
+*'''models/darkmod/nature/flowers/'''
+*'''models/darkmod/nature/rocks/''' -- rocks, boulders, etc
+*'''models/darkmod/nature/trees''' -- All trees or stumps
+=== models/darkmod/player_equipment ===
+-- potions, flashbombs, lockpicks, mines, etc
+=== models/darkmod/readables ===
+-- books, scrolls, signs, plaques
+=== models/darkmod/tools ===
+-- pick-axe, shovel, anvil, etc (NOT for player tools)
+*'''models/darkmod/tools/household''' -- brooms, mops,
-All relevant textures should go in models/darkmod/nature
+=== models/darkmod/waterworks ===
+--sources of water like fountains, wells, water pumps, etc
-=== models/darkmod/props ===
+=== models/darkmod/weapons ===
-The following are all subfolders of '''models/darkmod/props''':
+-- weapons, mage staves, arrows
-* '''furniture''' -- any furniture not covered below (armoire, desks, bookshelves etc)
-** '''furniture/seating''' -- chairs, sofas, stools
-** '''furniture/tables''' -- end tables, dining tables, etc
-** '''furniture/beds''' -- beds
-* '''fireplace''' -- logs, tools, racks, heat shields, prefab fireplaces
-* '''kitchen''' -- utensils, pots, food, dishes, water pump, etc
-* '''decorative''' -- vases, potted plants, statuettes, globe, etc
-** '''decorative/wall''' -- paintings, banners, curtains, animal heads, etc
-** '''decorative/oversize''' -- fountains, statues, etc
-* '''loot''' -- anything that is typically loot: coins, gold vases, purses, gold goblets, etc
-* '''lights/extinguish''' -- any lights that can be put out
-* '''lights/non-extinguish''' -- any lights that cannot be put out
-* '''containers''' -- crates, chests, barrels
-* '''mechanical''' -- boilers, clocks, generators,
-** '''mechanical/pipekit''' -- pipes
-* '''tools''' -- shovels, brooms, pick-axe, etc (NOT for player tools)
-* '''musical''' -- any musical instrument, viktrolas
-* '''dungeon''' -- chains, manacles, torture devices, body parts
-* '''wearables''' -- slippers, hats, spectacles (non-loot), armour
-* '''junk''' -- broken objects, chair legs, scrap wood, etc
-* '''graveyard''' -- skulls, bones, tombstones, crypts, etc
-* '''readables''' -- books, scrolls, signs, plaques
-* '''misc''' -- anything that doesn't fit elsewhere, like rope, a wagon, etc.
-Textures for the above models should go in '''models/darkmod/props/textures'''
+=== models/darkmod/wearables ===
+-- slippers, pouches (non-loot), belt buckles, clothes
+*'''models/darkmod/wearables/headgear''' -- helmets, hats, hairpieces, eyeglasses
+*'''models/darkmod/wearables/armour''' -- pauldrons, breastplates
-=== Other ===
-*'''models/darkmod/door_related''' -- handles, keys, and door knockers
-*'''models/darkmod/weapons''' -- all player and AI weapons
-*'''models/darkmod/player_equipment''' -- potions, flashbombs, lockpicks, mines, etc
-[[Category:Models]]
+[[Category:Models|F]] [[Category:Folderstructure|M]]