Co-Operative Base (Mod)

From Valve Developer Community
Jump to: navigation, search

Description

Source Engine Co-Operative Base Modification (SecobMod) is a modification containing useful code fixes for co-operative games. Please see the Features list for more details.


There are currently two versions of this modification available, The current one for Source SDK 2013 the older one for Source Engine 2007/2009 which can be found here.

This page deals solely with the latest version (the Source SDK 2013 multiplayer version).


    • Please be aware that no support is given with this modification. Occasionally I check the steam forums and reply to threads I see as I can, but in most cases you are on your own - this is why this wiki page has been so heavily detailed


If you release a modification which uses SecobMod or code from it, please remember to add those listed in the Credits section of this page to your own credits.


Currently the minimum requirements are solely that you have the Source SDK Base 2013 Multiplayer installed, though you may find the content restrictive is what you have available to you, as a result of this you may wish to mount other Valve games so that you can use their content (maps, models, sounds, materials etc) but please note that coded items from games that are not Half-Life 2 based will not work.


These must use the new .vpk file format to work, at the time of writing the following have been tested and are found to work with various degrees of success:

  • Half-Life 2.
  • Half-Life 2: Episode 1.
  • Half-Life 2: Episode 2.
  • Portal 1
  • Portal 2
  • Team Fortress 2
  • Counter Strike Source


To keep this wiki page easily viewed, many items are now implemented into scroll boxes, so that the more important aspects of the page can be kept whole.

Installation.

With the switchover of Valves' Source SDK hosting onto a GitHub repository it is now much easier to get hold of the code for SecobMod than it was with the previous Seco7 version.

Firstly you should follow the instructions for the Source SDK as found on here.

However where it would have you going to the official Valve SDK repository you will want to point your browser or GitHub client to this repository instead.

Make sure that you store your code in a folder path WITHOUT any spaces in it as it can cause problems compiling especially if you wish to debug your code!

As you can see in Valves' instructions you have the choice of using github for your project and forking off the code (creating your own unique copy of the SecobMod code to edit as you see fit and with the added bonus of being able to merge updates to the base SecobMod and Source SDK code as they are released should you want them, or by downloading a zip file containing all the SecobMod files at the latest commit to the GitHub repository.

If you have already started on your project and wish to combine it into a SecobMod base then I would recommend getting a copy/forking a copy of SecobMod and using a program such as winmerge to merge in your changes due to the amount of changes SecobMod has made to many of the base Source SDK files.


Setting up the compiled game folder.

Now that you have obtained the latest SecobMod and extracted the zip file (if you didn't fork the code in GitHub) then you will want to copy SecobMod's folder located at:


MP>Game>mod_hl2mp

to:

Steam>steamapps>sourcemods


At this point you could rename the mod_hl2mp folder in your sourcemods folder to that of your game name.

Setting up the Project files.

Once you have the code setup you can quickly get the source code project files up and running with all the required code files added/removed for compiling by going into your:

mp>game>mod_hl2mp

folder and open client_hl2mp-2005.vcxproj and server_hl2mp-2005.vcxproj in a text editor and changing all references to:

c:\github\SecobMod...etc to reflect where you have stored your code files.

Once this is complete you should then copy the files as outlined below:


client_hl2mp.vcxproj to the mp>src>Game>Client folder.

-and-

server_hl2mp.vcxproj mp>src>Game>Server folder.

and overwriting the files that were created while following the github instructions on the other Valve wiki page.

Debugging the code

You will of course wish to debug any problems, errors, crashes and such that you get while play testing your game. This wiki page describes the process of setting up the project for debugging.

Adding and Removing Game Features

SecobMod was designed so that you can easily disable and enable its features, so that you can customise it in whatever which way you want it.

As such all features are stored with a file in the Src>Game>Shared>Secobmod folder, called secobmod_shareddefs.h

On opening this file you will find every feature clearly defined, and information concerning what each feature does.

To enable a feature, remove the // from the beginning of the word define, to disable a feature add the // in front of its' define.

As an aside if you'd like to try out nightvision in game, it is binded to the 'N' key and as it stands it is currently only enabled for the heavy class (but you have the power to change this if you'd like!).

The file has one last important role, and that is that by defining all changes, this makes searching for all references to a specific feature in the entire codebase very easy. This allows easier transition of code between engine releases or should you wish to use code from SecobMod you can easily find it to implement in other Source SDK Multiplayer games.


Note: --
Important information about all the code can be found in the same folder, but in the file titled secobmod_information.h- }}

Teams

Setting up teams in Secobmod is very easy, you can enforce teamplay using the secobmod's definition, however for a full team play implemenation you will want to follow this wiki page (take a note of the warnings about SDK 2013).

In the old 2007/9 SDK release there was a problem with team members being unable to do any damage to either teams AI. The code function which had this problem was removed from the 2013 SDK and I have not added it back in. If you have issues with teamplay and the AI then you may need to grab this code from the older seco7 code.

In my basic testing of teams the game does now work as it should without this code, but I leave this in as a small warning for those wishing to have a teamplay based co-operative game.

Setting up the Hammer Map Editor

SecobMod has a few custom entities that mappers can use, should they wish to.

So that you can use these in your the Hammer editor, you'll need to edit and add a few files (as will any other mappers on your modifications team).

Locate the ..\SteamApps\common\Source SDK Base 2013 Multiplayer\bin\ GameConfig.txt file

And add the following to it, edit as appropriate with your modifications name and steam folder paths.

		"SecobMod"
		{
			"GameDir"		"..\Steam\SteamApps\SourceMods\mod_hl2mp"
			"hammer"
			{
				"TextureFormat"		"5"
				"MapFormat"		"4"
				"DefaultTextureScale"		"0.250000"
				"DefaultLightmapScale"		"16"
				"DefaultSolidEntity"		"func_detail"
				"DefaultPointEntity"		"info_player_start"
				"GameExe"		"..\Steam\Steam\SteamApps\common\Source SDK Base 2013 Multiplayer\hl2.exe"
				"MapDir"		"..\Steam\steamapps\SourceMods\mod_hl2mp\mapsrc"
				"CordonTexture"		"tools\toolsskybox"
				"MaterialExcludeCount"		"0"
				"BSP"		"..\Steam\SteamApps\common\Source SDK Base 2013 Multiplayer\bin\vbsp.exe"
				"Vis"		"..\Steam\SteamApps\common\Source SDK Base 2013 Multiplayer\bin\vvis.exe"
				"Light"		"..\Steam\SteamApps\common\Source SDK Base 2013 Multiplayer\bin\vrad.exe"
				"BSPDir"		"..\Steam\Steamapps\SourceMods\mod_hl2mp\maps"
				"GameData0"		"..\Steam\SteamApps\common\Source SDK Base 2013 Multiplayer\bin\secobmod.fgd"
			}
		}

Next, you'll want to create a blank/empty file called secobmod.fgd using a text editor, and place it in the ..\SteamApps\common\Source SDK Base 2013 Multiplayer\bin folder.

//-------------------------------------------------------------------------
//
// Game data for SecobMod.
//
//-------------------------------------------------------------------------

@include "base.fgd"
@include "halflife2.fgd"
@include "hl2mp.fgd"
@include "portal.fgd"
//Add any other includes here such as css, tf2 etc etc.

@PointClass base(PlayerClass, Angles) studio("models/editor/playerstart.mdl") = info_player_assaulter :
	"This entity indicates the position and facing direction at which the player will spawn during a player classes map. Any number of "+
	"info_player_assaulter entities may be placed in a map."
[
]

@PointClass base(PlayerClass, Angles) studio("models/editor/playerstart.mdl") = info_player_supporter :
	"This entity indicates the position and facing direction at which the player will spawn during a player classes map. Any number of "+
	"info_player_supporter entities may be placed in a map."
[
]


@PointClass base(PlayerClass, Angles) studio("models/editor/playerstart.mdl") = info_player_medic :
	"This entity indicates the position and facing direction at which the player will spawn during a player classes map. Any number of "+
	"info_player_medic entities may be placed in a map."
[
]

@PointClass base(PlayerClass, Angles) studio("models/editor/playerstart.mdl") = info_player_heavy :
	"This entity indicates the position and facing direction at which the player will spawn during a player classes map. Any number of "+
	"info_player_heavy entities may be placed in a map."
[
]

@PointClass base(Targetname, Angles) studio( "models/combine_turrets/floor_turret.mdl" ) = npc_turret_floor : "Combine Floor Turret"
[
		spawnflags(Flags) = 
	[
		32 : "Autostart" : 0
		64 : "Start Inactive" : 0
		128 : "Fast Retire" : 0
		256 : "Out of Ammo" : 0
		512 : "Citizen modified (Friendly)" : 0
		1024 : "Portal Turret" : 0
	]

	SkinNumber(integer) : "Skin Number" : 0 : "Which skin to use for this turret. Set to 0 to select randomly."

	// Inputs
	input Toggle(void) : "Toggle - If open, close. If closed, open."
	input Enable(void) : "Enable the turret."
	input Disable(void) : "Disable the turret."
	input DepleteAmmo(void) : "Depletes all the ammo from a turret, causing it to dry-fire."
	input RestoreAmmo(void) : "Restores ammo to a turret, allowing it to fire live rounds again."
	input SelfDestruct(void) : "Causes the turret to warn and then explode."

	// Outputs
	output OnDeploy(void) : "Turret is becoming active and dangerous."
	output OnRetire(void) : "Turret is becoming inactive and harmless."
	output OnTipped(void) : "Turret has been tipped over and is inactive."
	output OnPhysGunPickup(void) : "Picked up with physgun"
	output OnPhysGunDrop(void) : "Released by physgun"
]

//-------------------------------------------------------------------------
//
// Vehicles.
//
//-------------------------------------------------------------------------
@BaseClass base(Targetname, Origin, Global, prop_static_base) = BaseVehicle
[
	vehiclescript(string) : "Vehicle Script File" : "scripts/vehicles/jeep_test.txt"
	actionScale(float) : "Scale of action input / framerate" : "1"

	// Inputs
	input Action(float) : "Set the speed of the action animation"

	input TurnOn(void) : "Turn on: Start engine & enable throttle"
	input TurnOff(void) : "Turn off: Stop engine, disable throttle, engage brakes."

	input Lock(void) : "Prevent the player from entering or exiting the vehicle."
	input Unlock(void) : "Re-allow the player to enter or exit the vehicle."
]


@BaseClass base(BaseVehicle) = BaseDriveableVehicle
[
	VehicleLocked(choices) : "Start locked" : 0 =
	[
		0 : "No"
		1 : "Yes"
	]	

	// Outputs
	output PlayerOn(void) : "Player entered the vehicle"
	output PlayerOff(void) : "Player exited the vehicle"
	
	output PressedAttack(void) : "Player Pressed attack key"
	output PressedAttack2(void) : "Player Pressed attack2 key"

	output AttackAxis(string) : "State of attack button [0,1]"
	output Attack2Axis(string) : "State of attack2 button [0,1]"
	
	// Inputs
	input HandBrakeOn(void) : "Turns the handbrake on"
	input HandBrakeOff(void): "Releases the handbrake"
]

@PointClass base(BaseVehicle) studioprop() = prop_vehicle :
	"Studiomodel vehicle that can be driven via inputs."
[
	// Inputs
	input Steer(float) : "Steer the vehicle +/-1"
	input Throttle(float) : "Throttle +/-1"

	spawnflags(flags) =
	[
		1 : "Always Think (Run physics every frame)" : 0
	]
]


@PointClass base(BaseDriveableVehicle) studioprop() = prop_vehicle_driveable :
	"Generic driveable studiomodel vehicle."
[
]
@PointClass base(BaseDriveableVehicle) studioprop() = prop_vehicle_jeep : "Driveable studiomodel jeep."
[
]
@PointClass base(BaseDriveableVehicle) studioprop() = prop_vehicle_hl2buggy : "Jeep for episode 2 mods."
[
model(studio) : "World model" : "models/buggy.mdl"
vehiclescript(string) : "Vehicle Script File" : "scripts/vehicles/jeep_test.txt"
]
@PointClass base(BaseDriveableVehicle) studioprop() = prop_vehicle_jalopy : "Jeep for episode 2 mods."
[
model(studio) : "World model" : "models/vehicle.mdl"
vehiclescript(string) : "Vehicle Script File" : "scripts/vehicles/jalopy.txt"
]

@PointClass base(BaseDriveableVehicle, Parentname) studioprop() = prop_vehicle_passengerseat :
	"Our method of multiplayer passenger vehicles."
[
model(studio) : "World model" : "models/ss_passenger_cube.mdl"

	vehiclescript(string) : "Vehicle Script File" : "scripts/vehicles/prisoner_pod.txt"
	
	input Open(void) : "Plays the pod's open animation and unlocks the pod for entry or exit."
	input Close(void) : "Plays the pod's close animation and locks the pod for entry or exit."
	input EnterVehicle(void) : "Forces the activator (or player) into the pod."
	input EnterVehicleImmediate(void) : "Forces the activator (or player) into the pod without enter/exit animations."
	input ExitVehicle(void) : "Boots the prisoner out of the pod."
	
	output OnOpen(void) : "Fired when the pod is open enough to enter."
	output OnClose(void) : "Fired when the pod too closed to enter."
]

//----------------------------------//
//							   	    //
// 		Switch Model Targets	    //
//  Sets all players to set model   //
//									//
//----------------------------------//
@PointClass base(Targetname, Angles, EnableDisable) iconsprite("sprites/icons/switchmodel.vmt") = info_switchmodel : "SecobMod Co-Operative Set Model"
[
]

//-------------------------------------------------------------------------
//
// Solid Classes
//
//-------------------------------------------------------------------------

@SolidClass = func_ladder : 
	"Ladder. Players will be able to freely along this brush, as if it was a ladder. If you are using a model prop " +
	"for the visual representation of the ladder in the map, apply the toolsinvisibleladder material to the " +
	"func_ladder brush."
[
]

Now launch Hammer and from the selection list choose SecobMod.

If you are going to be using the stock vehicles and the secobmod passenger seat, you will find the prefabs folder a useful addition to your hammer editor. So copy the secobmod_prefabs folder from your game folder to your: ..\Steam\SteamApps\common\Source SDK Base 2013 Multiplayer\bin\Prefabs folder.

Important Map Settings.

If you are using the player class system, then there are a few changes you will have to make to the map so that it doesn't crash on trying to spawn the player.

Make a hollow room/cube large enough to fit several players in outside of the main map area, and texture it in a purely black colour. Add in some standard player starts into it, and then put the real (per-class) player starts where you want them inside the playable space of the map.

This will now mean your game won't crash on your player trying to spawn, usually you can get away with just one standard player start and a room large enough for one person as people will spawn inside one another till they pick their class and spawn at their correct class location, but for safety it may be best to make it a large cube with several player starts as stated above.


Also, there is a custom actor you can allow mappers to use called setmodel, this if placed in a game will allow players to set the model for all players, you can see how this works by opening the defector example map. In this maps case it spawns all players as metrocops.


Important Settings Files.

These are all used in the compiled folder of your modification.


GameInfo.txt

GameInfo.txt is also where you define such things as your developers team name, website and the icon to display in Steam, as well as the game's title.

The most important section are the 'Search Paths'.

Search paths are the modifications way of mounting the VPKs which come with each modern Valve game.

A backup of the gameinfo.txt file can be found within the secobmod_information.h file.

resource/mod_hl2mp_english.txt

This is found in the resource folder and is the modification's language definition file. Here you can find settings such as the titles for Chapters, the messages displayed on a vital ally being killed (for example) and other things such as server connection messages etc.


You should name this file to that of your own game/modifications' title, (GameorModName_english.txt).

cfg/skill.cfg

The skill.cfg file is important as it allows you to define such things as NPC health, NPC damage (to others such as the player), number of rockets a Strider may withstand and even how much charge a Vortigaunt can give to the players suit. It is worth reading through the file and editing it to suit your needs as it does define a lot of features of modifications. It can be found in the cfg folder.

scripts/ChapterBackgrounds.txt

This file defines which of your modifications maps are background maps to display on the main menu. If you choose to use background maps with your modification, be sure to enable the secobmod__BG_MOTD_FIX definition in the secobmod_shareddefs.h so as not to display the motd on the main menu.

cfg/valve.rc

This file defines whether background maps are displayed on the main menu. It's found in the cfg folder.

resource/ClientScheme.res

This is the HUD colour file. Seperate versions can be used per player class as needed (the code is implemented). Currently all classes are set to use the same file.

maps/map_briefings

This is a folder inside the maps folder. Each map that requires a briefing has a text file for that specific map. This loads in a similar fashion to the MOTD panel. It allows a quick map storyline for people loading the map. See our example maps in-game to see this concept in action.


Dedicated Server Guide

Please see this guide for setting up a Source SDK dedicated server.

Features

Developers can easily enable and disable individual features to suit their needs.

This is a cut down list, for full information as to the features please see the secobmod_shareddefs.h file).

** Portal Gun, enable testing in the shared defs file to enable its useage. give weapon_portalgun and companioncube.
** Super Gravity Gun (some graphic effects missing - most of the code done by .Kave).
** Restart level on critical ally/object/time limit failing.
** View Cameras now take control of all players on a server (Gordon's KO Wakeup scene, etc).
** Save/Restore transitions now work even if you disable playerclasses from the code.
** Each player class player now has their own unique filter name, meaning only a certain playerclass
 can trigger an event (for example). Thanks Alters for the fix!
** Called it a day on development. It's all in the hands of the community now.


* AI Patch Modifications:
** Enable/Disable an enhanced version of Winston's AI Multiplayer patch.
** Valve Game Mounting through use of the gameinfo.txt search paths.		  


* Episode 2 Support:
** Including support for Alyx Darkness Mode 


* Player Abilities:
** Non-HEV wearers can still be allowed to sprint, have the geiger counter, etc. This is on a
 per-item basis, so players could have the geiger, but no sprint if you wanted.
** Players can pick up objects with their hands.  
** NightVision (currently only enabled for the Heavy class, use the 'N' key to enable it).


* Player Class System With:
** Four (or more, or less) Player Classes.
** Per Player Class Object Pickup Strengths.
** Customise Class Health/Maximum Health Values.
** Customise Class Armour/Maximum Armour Values.
** Customise Class Walk/Sprint/Normal movement speeds.
** Customise Class Jump Heights.
** Each Class Can Have Its Own HUD Layout/Colour scheme.
** Define how many players can be in each Player Class. 


* Weapon Enhancements:
** Development teams can now enable Iron Sight.
** A known HL2DM shotgun fast-switch bug - fixed thanks to Community input!.


* NPC Abilities:
** Striders can be set to always impale players who get too close.
** Barnacles can now be set to swallow players.


* Vehicles:
** The multiplayer camera judder is no more!
** Thirdperson model in-vehicle animations can now be used.
** Old-Style passenger seats can now be used to provide extra seats in vehicles.
** Jeeps and Jalopys' can now have their headlights switched on.


* Cool Stuff:
** Firstperson ragdoll views on player deaths.
** Camera bob on player movement (incl. strafe).
** Use Counter-Strike: Sources' ladders code instead of the Half-Life 2 ladders.


* Game Settings:
** Friendly Fire (Replaces players can collide from v1.5).
** Dynamic Respawn Code. Don't spawn back at the start of the map anymore, respawn back 
where you left off in your killing spree.
** Multiplayer Level Transitions. On ALL players entering the transition area the server 
is forced to changelevel to the next map (percentage can be changed).
** Save/Restore. A basic working transition system which saves/restores your loadouts.
** Valve approved cheating. Now even if sv_cheats 1 is enabled, players can't cheat unless 
you define it as acceptable in the code.
** Map briefings. Provide storylines on a per-map basis.
** Map specific model overrides. Changes all players to a specified player model on a 
particular map (set by the mapper). Check out our defector map for an in-game example!

Credits

    • ChiefWhosm/Whoozzem
    • Spamslayer
    • MontyPython
    • Sneaky
    • Ariae
    • Everyone else who used to be in 4WH.
    • - and -
    • Winston
    • Tony Sergi
    • Biohazard_90
    • Sub-Zero
    • DutchMega
    • The Last 7 Hours Spanish Mod
    • Makkon
    • Skidz
    • Alters
    • .Kave
    • KuRouZu
    • Jorg
    • z33ky
    • JordanN
    • Toox
    • TheRJMan
    • SilverPower
    • Vektorx4
    • Sirmastercombat
    • Sandern
    • HalfWit2
    • Anyone else forgotten

Known Bugs

* HIGH - Restore code of the save/restore code is currently set to use a static folder/file path. This is probably easily fixed.

* MEDIUM - Because we are relying on search path mounting, currently some scenes (meaning actions, gestures and some sounds) do not play. There are more that work than those few that don't at least.

* MEDIUM - Armour not working on non-playerclass save/restore transitions. This should work according to the code!

* MEDIUM - Leaving tilted vehicles causes players to appear tilted as well. This affects only their player
 model, their actual views are normal.

* MEDIUM - Weapon strip/dissolve zones (as used to make the Super Gravity Gun in HL2/EP1) don't work.

The above is Caused by the game not recognizing the hl2mp gravity gun and just deleting it,
then the test zone (d3_citadel_03) sticks waiting on the script to finish.

* LOW - Gravity Gun - Particles show without alphas/blobs, this is probably missing particle files and can probably be easily fixed. It's possible to mount HL2:DeathMatch vpk's to fix this but this breaks the AI animations from working.

* LOW - Super Gravity Gun - Some particle effects are missing, but the gun itself works as in singleplayer.

* LOW - Blood splashes being emitted when shooting other players despite no damage actually being dealt
 (only applicable when "SecobMod__FRIENDLY_FIRE_ENABLED" is disabled).

* LOW - Chat bubbles angle towards the player's view, so they can appear embedded in walls etc, however there is also now a bug where the code is fine but the model fails to render. I'm wondering if it is spawning at the map rather than player origin or something strange.

* LOW - AI bend their legs when going up in lifts (elevators), and hover slightly in the air going down.

Bug Fixes.

  • Feel free to fork the github code and push back changes to the base code for all to enjoy, or post them here to be added to the code once spotted.