Mapping Guidelines - Revision history

Maestro Fenix: /* 4: How to use some Source tools. */

2013-09-30T19:17:10Z

‎4: How to use some Source tools.

Maestro Fenix: /* 3: Information about the map files. */

2013-09-30T19:13:18Z

‎3: Information about the map files.

Maestro Fenix: /* 3: Information about the map files. */

2013-09-30T19:11:43Z

‎3: Information about the map files.

Maestro Fenix: /* 3: Information about the map files. */

2013-09-30T19:07:00Z

‎3: Information about the map files.

Maestro Fenix at 14:17, 4 September 2013

2013-09-04T14:17:04Z

Maestro Fenix: /* 4: How to use some Source tools. */

2013-04-24T19:17:11Z

‎4: How to use some Source tools.

Maestro Fenix at 13:01, 31 March 2013

2013-03-31T13:01:30Z

Maestro Fenix: /* 3: Information about the map files. */

2012-11-10T18:20:27Z

‎3: Information about the map files.

Maestro Fenix: /* 3: Information about the map files. */

2012-11-10T18:20:12Z

‎3: Information about the map files.

Maestro Fenix at 18:13, 10 November 2012

2012-11-10T18:13:27Z

← Older revision		Revision as of 19:17, 30 September 2013
Line 126:		Line 126:

	'''Note:''' This will raise (a lot) the file size of your map (the .BSP file). Also, it makes it more difficult to the map decompilers work on it (the more content you embed in the map, the hard it will decompile it).		'''Note:''' This will raise (a lot) the file size of your map (the .BSP file). Also, it makes it more difficult to the map decompilers work on it (the more content you embed in the map, the hard it will decompile it).
		+
		+
		+	*Resource Generator
		+
		+	Homepage (NONE, only Facepunch thread): http://www.facepunch.com/showthread.php?t=842886
		+
		+	Alternate mirror: http://www.mediafire.com/?k817lvo8qwfbk82
		+
		+	Created by Kogitsune, generates a file where lists all the previously selected files of your map. The file is generated in the same folder as the executable.
		+
		+	This generator was made for Gmod, so you will have to follow the indications posted at the point 1.3 to know how to use it for another Source games/mods. It also can compress automatically all the selected files into bz2 format, on a separated folder.
		+
		+	Requires .Net 3.5. Even if the last version is from 2012, it doesn't work on Windows 8.


Line 141:		Line 154:

	When you finished doing the operation, your files must be have in .bz2 format.		When you finished doing the operation, your files must be have in .bz2 format.
		+
		+
		+	*Recursive BZip2
		+
		+	(Original thread [http://www.obsidianconflict.net/forums/posting.php?mode=quote&f=10&p=68616 here]).
		+
		+	Originally by [http://forums.eventscripts.com/viewtopic.php?t=11538 Ace Rimmer], modified by Tesla to add support for recursive compression.
		+
		+	Simply drop the folders/files you want to compress into the ''ToBeZipped'' folder, then run either ''RecursiveCompress.bat'' or ''RecursiveCompressNoKeep.bat'' (both compress recursively, but the latter deletes the original files as well).
		+
		+	Get it [http://www.mediafire.com/?540towlpgaaqwej here].

@@ Line 55: / Line 55: @@
 You can list manually the routes of the files, or you can follow this steps to do it automatically:
-<div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">*Get the Resource Generator from the tool section above.
+<div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">
 *Put all your folders of your map inside of a folder

@@ Line 71: / Line 71: @@
 *Since this tool was designed for Gmod, replace the following (CRTL+F->replace):
-<div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">resource.AddFile( <div> with <div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;"><div> (mind the space after the '''(''' and make sure you replace it with nothing, so it would like the lines as "thing/thing.thing").
+¨resource.AddFile( ¨ with ¨¨ (mind the space after the '''(''' and make sure you replace it with nothing, so it would like the lines as "thing/thing.thing").
-<div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;"> )<div> with <div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;"> "file"<div>
+¨ )¨ with ¨ "file"¨
-<div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">--Generated with Kogitsune's Resource Generator<div> with <div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">"resources"(here goes a jump line){<div>
+¨--Generated with Kogitsune's Resource Generator¨ with ¨"resources"(here goes a jump line){¨
-<div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">"/<div> with <div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">div> (The lines must start like maps/thing or models/thing, you know, without having a slash before the first part).
+¨"/¨ with ¨¨(The lines must start like maps/thing or models/thing, you know, without having a slash before the first part).
-<div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">/<div> with <div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">\<div>
+¨/¨ with ¨\¨
 *Add under the last line a } to close the list.

@@ Line 53: / Line 53: @@
 *.RES: Is a file used for the server to download the content it says to the players: https://developer.valvesoftware.com/wiki/Resource_list . Remember to use Notepad++ or similar programs, but not wordpad, since it screws the file. Make sure you set the codification to ANSI, you will save on space and avoid future problems (UTF-8 without BOM is allowed too).
-You can list manually the routes of the files, or you can do the following:
+You can list manually the routes of the files, or you can follow this steps to do it automatically:
 Or in case you have problems on the server side (missing downloadable content), take the oc_lobby.res, and modify it to our files. You can grab it from [http://www.mediafire.com/?q8ocgif16xvnn6j here] in case you feel lazy to search it on your obsidian folder.

@@ Line 6: / Line 6: @@
-='''Your map: How i can make a map for OC'''=
+='''Your map: How I can map for OC'''=
@@ Line 28: / Line 28: @@
 The package where your map lies should contain at least the following:
-*The briefing file (''yourmapname_briefing.txt | It goes in maps/cfg''). The text that appears in the screen after the MOTD. It contains all the info of the map (mainly the objectives), as well as the credits.
+*The briefing file (''yourmapname_briefing.txt | It goes in maps/cfg''). The text that appears in the screen after the MOTD. It contains all the info of the map (mainly the objectives), as well as the credits. Keep it short, because it has a limit of 2047 characters.
-*The map in .bsp file (''It goes in maps''). Make sure its functional, doesnt have bugs (or little) and propperly optimizated. Compile it at least in normal. And for god´s sake, put in it lights (or a better idea, dont release shit maps).
+*The map in .bsp file (''It goes in maps''). Make sure it's functional, it doesn't have bugs (or only a little) and properly optimizated. Compile the map at least on normal. And for god's sake, put in it lights (or a better idea, don't release shit maps).
-*The icon of your map. Is the reference image that you can see it in the lobby so you can select it. The size must be 256x256 at the best quality as you can, in VTF format.
+*The icon of your map. Is the reference image that you can see in the lobby, so you can select it. The size must be 256x256 at the best quality as you can, in VTF format.
-*A thumbnail of your map for the map list. To see how to create one, check this [https://developer.valvesoftware.com/wiki/Maplist_Thumbnails link].
+*A thumbnail of your map for the map list in-game server browser. To see how to create one, check this [https://developer.valvesoftware.com/wiki/Maplist_Thumbnails link].
 *In case you need more files, keep it organized in their folders.
-*If you have custom content: Duplicate your files and put them in to separated folders called Server and Client.
+*If you have custom content: Duplicate your files and put them in on separated folders (compressed and uncompressed).
-*In the Server folder, it must contain all the files, compressed into bz2 format in order they can be used with FastDL. The .RES file (that is needed in order to can download all the files) must be there too (but without being compressed).
+*In the compressed folder, it must contain all the files, compressed into bz2 format in order it can be used with FastDL. The .RES file (that is needed in order to can download all the files) must be there too (but without being compressed).
-*In the Client folder, put all the files without compressing them.
+*On the uncompressed folder, put all the files without compressing them..
 Remember, you only have to include the content that '''IS NOT STOCK''' from a mounted game and '''IS NOT EMBEDDED''' in the .bsp file. We had in the past problems with some maps which their size was too large for the amount of the content that in fact it had.
@@ Line 51: / Line 51: @@
 *.BSP: Is the map file format that Source uses.
-*.RES: Is a file used for the server to download the content it says to the players: https://developer.valvesoftware.com/wiki/Resource_list . Remember to use Notepad++ or similar programs, but not wordpad, since it screws the file.
+*.RES: Is a file used for the server to download the content it says to the players: https://developer.valvesoftware.com/wiki/Resource_list . Remember to use Notepad++ or similar programs, but not wordpad, since it screws the file. Make sure you set the codification to ANSI, you will save on space and avoid future problems (UTF-8 without BOM is allowed too).
 You can list manually the routes of the files, or you can do the following:
@@ Line 62: / Line 62: @@
 *map_mounts.txt: Allows you to indicate to OC what game are you mounting, if Episode One or Two. http://wiki.obsidianconflict.net/?title=Content_Mounting
-*map_modify.txt: Is used for modify a map using scripts. Also, it allows you create custom ammo and mount the soundcaches of the game you want.  http://wiki.obsidianconflict.net/?title=Mapadd_Scripts http://wiki.obsidianconflict.net/?title=Creating_Custom_Ammos
+*map_modify.txt: Is used for modify a map using scripts. Also, it allows you to create custom ammo and mount the soundcaches of the games that you want.  http://wiki.obsidianconflict.net/?title=Mapadd_Scripts http://wiki.obsidianconflict.net/?title=Creating_Custom_Ammos
-*map_cfg.txt: This file text "overrides" the server variables by putting the yours inside, allowing you have a different fall damage in your map for example.
+*map_cfg.txt: This file text "overrides" the server variables by putting the yours inside, allowing you to have a different fall damage in your map for example.
 *map_briefing.txt: Is used for showing in game the briefing of the map, where it explains the story of it, the objectives and the credits. Is shown after the MOTD.
@@ Line 71: / Line 71: @@
 *map_soundscapes.txt: Is used for use custom soundscapes.
 *map_name_particle_manifest.txt: Allows you define a list of particles for your map: https://developer.valvesoftware.com/wiki/Particles_manifest.txt
@@ Line 85: / Line 83: @@
 This tool is used for pack all the custom content inside your map. Is pretty useful when you have a little amount of custom
-content, and you don´t want lose your time separating your files into Client and Server, and making a .RES file.
+content, and you don´t want lose your time separating your files into compressed and uncompressed folders, and making a .RES file.
 The main advantage that has this tool, is that you only have to especify a folder where are your content, and the tool will recursively adding all the content inside of your map.
-Their use is easy: You only have to indicate the path of your bspzip.exe (For OC, SteamApps/youraccount/sourcesdk/bin/source2007/bin/bspzip.exe), the map where you are going to add or extract content, and the folder where are the content to add, or where is going to be put.
+Is easy to use: You only have to indicate the path of your bspzip.exe (For OC, SteamApps/youraccount/sourcesdk/bin/source2007/bin/bspzip.exe), the map where you are going to add or extract content, and the folder where are the content to add, or where is going to be put.
 You must select the main folder where are the content, NOT the folders that are inside of that folder, or it will give problems.
@@ Line 140: / Line 138: @@
 _beta, _BETA, _b (Used for those maps in Beta version, pre-release tests).
-_v (Indicates what version is the map. Generally used from the second edit of the map after their release).
+_v, _V (Indicates what version is the map. Generally used from the second edit of the map after their release).
-_oc, _OC (Used for those custom maps who comes from another Source games, to indicate that it have been modified for use it in OC).
+_oc, _OC (Used for those custom maps who comes from another Source games, to indicate that it have been modified for use it in OC. Is not enforced, in the case is not really needed to change their name).
 Also, is common use numbers after the suffix, but also letters (this for indicate that it continues being the same edition, but improved). Example: _b1, _v3j, _a2...
@@ Line 150: / Line 148: @@
 *In general, is allowed use content from all the Source games, as long as they can be mounted in OC. Use content from another games, the HL2 leak and such, although is tolerated in theory, it will make your map lose any possibility of become an official map. If you are going to use stuff from another mods or from a person, '''ASK ALWAYS FOR PERMISSION'''. The OC DEVs are not responsible of your acts, and, even if it becomes necessary, it will delete the map (although luckly the situation never degenerated until that point).
-*Try dont exceed very much with the size of the compressed map. Unless your main objective is that your map become official, you should keep the size under 60mb. Even with FastDL, it can take a while, making that the players stop downloading and move to another server. Think about it.
+*Try dont exceed very much with the size of the compressed map. Unless your main objective is that your map become official, you should keep the size under 100mb compressed. Even with FastDL, it can take a while, making that the players stop downloading and move to another server. Think about it.
 *Is not allowed take an official map from a Source game (like for example, the Dam level in HL:S), modify it and present it. Is tolerated in case you make it with the modify scripts (yourmapname_modify.txt), or if the map is custom (in this case ask for permission).

@@ Line 80: / Line 80: @@
 =='''4: How to use some Source tools.'''==
-*Pakrat:
+*BspZipGui
-Homepage: http://www.bagthorpe.org/bob/cofrdrbob/pakrat.html
+Homepage: https://sites.google.com/site/softdevdy/software/bspzipgui
 This tool is used for pack all the custom content inside your map. Is pretty useful when you have a little amount of custom
 content, and you don´t want lose your time separating your files into Client and Server, and making a .RES file.
-Their use is easy: Execute the Java file, wait for the window that ask you for the location of your map appear and left the program work. Then a new window will appear, showing all the content that the map has (if you delete something in this moment, you will corrupt the map, forcing you to compile the map again). You have now two options: Add files, or copy them to your computer.
+The main advantage that has this tool, is that you only have to especify a folder where are your content, and the tool will recursively adding all the content inside of your map.
-If you choose add files, a window will appear, asking you where is the file you want to add. After pressing "ok", it will add it to the map. If you choose the save option (after selecting a file of the map first), the program will ask you where you want save it ('''NOTE:''' When saving files in your computer, the program will not create the folders where originally the files were. Be careful, you could overwrite some files).
+Their use is easy: You only have to indicate the path of your bspzip.exe (For OC, SteamApps/youraccount/sourcesdk/bin/source2007/bin/bspzip.exe), the map where you are going to add or extract content, and the folder where are the content to add, or where is going to be put.
 '''Note:''' This will raise (a lot) the file size of your map (the .BSP file). Also, it makes it more difficult to the map decompilers work on it (the more content you embed in the map, the hard it will decompile it).

← Older revision		Revision as of 13:01, 31 March 2013
Line 33:		Line 33:

	*The icon of your map. Is the reference image that you can see it in the lobby so you can select it. The size must be 256x256 at the best quality as you can, in VTF format.		*The icon of your map. Is the reference image that you can see it in the lobby so you can select it. The size must be 256x256 at the best quality as you can, in VTF format.
		+
		+	*A thumbnail of your map for the map list. To see how to create one, check this [https://developer.valvesoftware.com/wiki/Maplist_Thumbnails link].

	*In case you need more files, keep it organized in their folders.		*In case you need more files, keep it organized in their folders.

@@ Line 54: / Line 54: @@
 <div style="padding: 0.5em 1em 0.5em 1em; border: 1px dashed #2f6fab; color: black; background-color: #f9f9f9; line-height: 1.1em;">
-Method by [http://wiki.obsidianconflict.net/?title=User: Tesla-X4]: All I do is copy the associated resources to a new folder (retaining folder structure), open up Command Prompt, cd my way to that folder and then dir /b /s /a:-h-d-s > output.txt. After that, I open that up in Notepad++ and do a Find and Replace with extended characters.</div>
+Method by [http://wiki.obsidianconflict.net/?title=User:Tesla-X4 Tesla-X4]: All I do is copy the associated resources to a new folder (retaining folder structure), open up Command Prompt, cd my way to that folder and then dir /b /s /a:-h-d-s > output.txt. After that, I open that up in Notepad++ and do a Find and Replace with extended characters.</div>
 Or in case you have problems on the server side (missing downloadable content), take the oc_lobby.res, and modify it to our files. You can grab it from [http://www.mediafire.com/?q8ocgif16xvnn6j here] in case you feel lazy to search it on your obsidian folder.

← Older revision		Revision as of 18:13, 10 November 2012
Line 1:		Line 1:
−	~~__TOC__~~
−
−	~~{{wip}}~~
−
	(I write this for make the making and the release of a map more easier, as well as make easier the life of those who want download one).		(I write this for make the making and the release of a map more easier, as well as make easier the life of those who want download one).

−	~~Content:~~	+	__TOC__
−
−	~~'''Your map: How i can make a map for OC.'''~~
−	*'''Setting the SDK for OC, information about the OC entities and tutorials.'''
−	*'''What files should you have.'''
−	*'''Information about the map files.'''
−	*'''How to use some Source tools.'''
−	*'''Recomendations.'''

−	~~'''Posting a new map: The main post, how it should be organized and tips.'''~~
−	*'''The name of the thread.'''
−	*'''The main post. What i should have in it?.'''
−	*'''Mirrors. What i should pick and how many?.'''
−	~~'''~~
−	~~The comments: How to review and listen the feedback.'''~~
−	*'''How to make a decent review of a map.'''
−	*'''Listen the feedback, or how to not get mad.'''