Difference between revisions of "Editor's information/Map Documentation Guide"

From Valve Cut Content
Jump to: navigation, search
m (Reverted edits by 蔣介石 (talk) to last revision by Uncanny)
(Tag: Rollback)
(Version 2 - let's cut through the noise.)
Line 1: Line 1:
 +
<!-- version 2 -->
 
__NOEDITSECTION__
 
__NOEDITSECTION__
This article is intended as a reference for creating leaked map documentation, since its repetitive nature makes it simple to standardize.
+
 
Want a template for this? Go [[Editor's_information/Map_Documentation_Guide/Template|here]].
+
{{MapInfoBox
==Article Naming==
+
|title1=50antlions.vmf <!-- the map name with .vmf -->
Captialize each distinct "word" within the map name. First, place in parenthesis the originating leak. Then, place in the map name, capitalizing each "word" within.
+
<!-- Sidebar images. The map at a glance, with some sweeping shots. Leave the whole gallery for below. -->
Potential map leaks:
+
|image1=Placeholder phys.jpg
*WC
+
<!-- Basic Info -->
*EP1/EP2
+
|game=Half-Life 2 <!-- What game is this made for?-->
*HL1WC
+
|leak=[[The 2003 Leak|WC Mappack]]<!-- Leak it originated from. Provide a link to the VCC wiki page where possible.-->
I.E.:
+
|mapdate= PLACEHOLDER <!-- Date of the map file, last modified. If this is obviously irrelevant, don't include. -->
*(WC) Ai Hallwalk
+
|mapversion= PLACEHOLDER <!-- Open the VMF in notepad and copy the number after "mapversion". -->
==Pre-Intro==
+
|editor_build= PLACEHOLDER  <!-- Ditto, but with "editorbuild". -->
Place a sentence or two describing the direct purpose of the map, and nothing else. Bold the title of the map.  
+
}}
I.E.:
+
<!-- Place a sentence or two describing the direct purpose of the map, and nothing else. Bold the title of the map. -->
*<b>Ai_Hallwalk</b> is a testmap intended to test the ability of the AI to navigate a simple course.
+
 
 +
<b>PLACEHOLDER</b> is a testmap intended to test the ability of the AI to navigate a simple course.
 +
 
 
==Overview==
 
==Overview==
Describe the map, and how it was supposed to play out.
+
<!-- Describe the map, what its purpose is, how it was supposed to play out. -->
===Appearances===
+
 
Where this map appears. I.E.
 
*\
 
*\john\ai_testmaps\
 
==Unused References==
 
List any erroneous texture/model/sound references. If there aren't any, don't include this section.
 
===Textures===
 
===Models===
 
 
==Unused Visgroups==
 
==Unused Visgroups==
In subheaders, describe each unused visgroup in the map, including a picture. Again, if there aren't any, don't include this.
+
<!-- In subheaders, describe each unused visgroup in the map, including a picture. If there aren't any, don't include this. -->
 +
===Example===
 +
[[File:Crap_uv_1.png|thumb|310px]]
 +
Another rotated brush placed close to the first. It uses BRICK/BRICKWALL032C, instead of concrete/concretefloor022a.
 +
{{Clear}} <!-- this prevents the side-images from desyncing with the text of the article -->
  
 
==Gallery==
 
==Gallery==
 
===In-Game===
 
===In-Game===
A minimum of three shots of various areas in the map.
+
<!-- A minimum of three shots of various areas in the map. -->
 +
<gallery widths="150" bordersize="none" spacing="small">
 +
crap_ig_2.png
 +
crap_ig_1.png
 +
crap_ig_3.png
 +
</gallery>
 +
 
 
===Hammer===
 
===Hammer===
At least one shot of the map in hammer, and one from the 2-D grid above.
+
<!-- At least one shot of the map in hammer, and one from the 2-D grid above. -->
 +
<gallery widths="150" bordersize="none" spacing="small">crap_ham_1.png
 +
Crap_grid_1.png
 +
</gallery>

Revision as of 08:35, 5 August 2022


Editor's information/Map Documentation Guide
Placeholder phys.jpg
Info
Game Half-Life 2
Leak WC Mappack
Map Date PLACEHOLDER
Editor Build PLACEHOLDER
Map Date (NET) Error: Invalid time.


PLACEHOLDER is a testmap intended to test the ability of the AI to navigate a simple course.

Overview

Unused Visgroups

Example

Crap uv 1.png

Another rotated brush placed close to the first. It uses BRICK/BRICKWALL032C, instead of concrete/concretefloor022a.

Gallery

In-Game

Hammer