README.md

Map markers

Map markers can be made by placing signs in the minecraft world. The first line must always contain [mcsource], whilst the second line contains the name of the entity to place.

Examples

Random weapon (TTT)

> [mcsource]
> ttt_random_weapon
> 
> 

Random ammunition pack (TTT)

> [mcsource]
> ttt_random_ammo
> 
> 

Spawnpoint (TTT)

> [mcsource]
> info_player_start
> 
> 

The config file

The McSource config.yml contains different sections for configuring McSource.

MaterialsPath

The MaterialsPath value determines the root path of all material folders.

Note: Please make sure to escape backslashes ('\')!

materialsPath: "C:\\Program Files (x86)\\Steam\\steamapps\\common\\GarrysMod\\garrysmod\\materials"

Textures

The Textures section maps allows for mapping materials and specific attributes to blocks. The Textures section contains all namespaces. McSource will search through all Namespaces section in descending order.

# ...
textures:

Namespaces:

A Namespace can contain Blocks

# ...
textures:
  minecraft:
  # ...
  my_mod:
  # ...

Blocks:

Blocks can be assigned a texture, a type and a translucent flag, determining whether the texture is see-through. A block must always be named after the minecraft block id

textures:
  stone: "minecraft\\stone"
  glass:
    type: "block"
    translucent: true
    texture: "minecraft\\stone"

Possible block types:

Type	Description	Implemented
block	(Default) A solid block	yes
door	A door-shaped block which can be opened or closed	no
fence	A fence-shaped block that can extend to solid blocks nearby	no
fencegate	A fence-gate-shaped block which can be opened or closed	no
fire	Burning fire	no
flat	A flat block like snow or carpet, can be stackable	no
ladder	A ladder-shaped block to climb on	no
pane	A pane-shaped block that can extend to solid blocks nearby	no
plant	A plant-shaped block	no
rod	A rod-shaped block	no
sign	A sign-shaped block, maybe containing text	no
slab	A slab-shaped block that can be placed on the upper or lower half of an empty space	no
stairs	A stair-shaped block that can connect to nearby stairs	no
torch	A torch-shaped block	no
trapdoor	A trapdoor-shaped block which can be opened or closed	no
ignored	Do not process	no

Texture

A Texture defines material paths for different block materials for each side, optionally depending on different block states and stages:

Possible values:

String

The material path to use for all sides at once

Note: Please make sure to escape backslashes ('\')!

texture: "minecraft\\stone"

Sides

The paths to use for each block side. The sides 'front', 'back', 'left' and 'right' take precedence over ' sides', which takes precedence over 'default':

texture:
  sides:
    default: "minecraft\\melon" # All sides that are not specified
    # sides:                    # Optional
    top: "minecraft\\melon_top" # Optional
    # bottom:                   # Optional
    # front:                    # Optional
    # back:                     # Optional
    # left:                     # Optional
    # right:                    # Optional

Parts

Defines materials for a multi-part block (for example doors or beds) by either using a String or a Sides value.

texture:
  parts:
    lower: door_acacia_lower
    upper:
      sides:
        default: door_acacia_upper

Stages

Defines the material to use for each block stage by either using a String, a Parts or a Sides value.

texture:
  stages:
    - "minecraft\\wheat_stage_0"
    - "minecraft\\wheat_stage_1"
    - "minecraft\\wheat_stage_2"
    - sides:
        default: "minecraft\\wheat_stage_3"
#   - parts:
#       lower: "minecraft\\lower"
#       upper: "minecraft\\upper"

States

Defines the texture to use for each block state by either using a String, a Sides, a Parts or a Stages value.

texture:
  states:
    on: "minecraft\\torch_on"
    off:
      sides:
        default: "minecraft\\torch_off"
#     stages:
#       - "minecraft\\a"
#       - "minecraft\\b"
#       - "minecraft\\c"
#     parts:
#       lower: "minecraft\\lower"
#       upper: "minecraft\\upper"