View source for Co-Operative Base (Mod)

= Description =

{{note| -The dynamic and static mounting code has temporarily been removed for the transition from .gcf to .vpk mounting- ))

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

At the time of writing the latest version is based on Source Engine 2013.

{{note| -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 secob or code from it, please remember to add those listed in the Credits section of this page to your own credits.


There are some minimum requirements, which are as follows:

* Half-Life 2 or Half-Life 2: Episode 1.
* Source SDK Base 2013 multiplauer (free download).

Aditional games you may like to use as well.
*Half-Life 2: Episode 2
*Portal
*Any Content from Valve Games / supported Modifications which must have their own unique AppID.


It is possible to base a modification solely on Half-Life 2: Episode 2, along with the Base and HL2DM, however you won't have as much content at your disposal as you would have if you had used Half-Life 2/Episode 1.


Before launching the compiled version of secobmod you should launch all the games you intend on using with it, this prevents a startup crash which may still happen for some people the first time they launch the modification.


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. =

If you have already started on a modification for HL2MP (Source SDK Multiplayer), then you will probably find it easier to merge your code into the secobmod source code than the other way round. The easy way is to compare your code against secobmod using a program such as [http://winmerge.org/downloads/ winmerge] to see your changes, unless like me you ifdef everything which while considered bad coding form by some coders sure makes it easy to find your code again amongst all the official code AND convert the code from one engine change to the next.


You can either fork the codebase on github by registering for a github account, and then using the fork button on the secob github repository to create your own github repository and edit your own full version of the code (and access updates to the base secob when they're commited) or by going on the repository site and choosing the 'Download Zip' button on the lower right of the page: 

[https://github.com/whoozzem/Seco-2013/ GitHub]

{{note| -Make sure to change the github client program (if you use it) to save to a path containing no spaces as this can cause problems with code compiling! - }}

If you are already familiar with the latest Source Engine release then you should know how to get started already.

Those of you who aren't, follow the instructions on the following Valve wiki page:

[https://developer.valvesoftware.com/wiki/Source_SDK_2013/ SDK Wiki Page]

The nice thing about now being on github is that regardless of whether the Source Engine SDK remains unmodified or not you'll always know the code you get from the secobmod repository site is known to work, and that it can be updated (or has been updated) with the latest Valve fixes to its' parent Source Engine base). Those of you who have used seco v7 and know the fun and games with each SDK update that happened will know why this is such a good thing to have happen.


== Setting up the compiled game folder. ==

Now that you have your source code one way or an other, you will want to copy (from your github folder) the Secobmod's MP>Game>mod_HL2MP folder to your Steam>steamapps>sourcemods folder.

At this point you may if you would like rename the mod_hl2mp folder in your sourcemodes folder to that of your game name.


== Setting up the Project files. ==


...To Do...
client_hl2mp-2005.vcxproj and client_hl2mp-2005.vcxproj.user to the Src>Game>Client folder.

server_hl2mp-2005.vcxproj and server_hl2mp-2005.vcxproj.user to the Src>Game>Server folder.


== Setting up the Source Code. ==

If you did decide to change the name of the mod_hl2mp folder in your sourcemods folder then you will have to tell the mounting code the new name of your mod.

You can search for anything important that requires being changed in such a situation by searching all code files (either in Visual Studio or some other compilter or in a decent text editor such as notepad++) for:

\\SecobMod__ChangeME!

Save all the files you've modified. Note that unless you added extra or(||) lines to the map mounting code then any maps that are released with secbomod will run in a failsafe mode and may not display correctly (or run at all!).

Make sure that you now compile the code in your chosen compiler, and then copy the server and client .dll's (or whichever files osX and Linux use) from your local github game>mod_hl2mp>bin folder to your sourcemods mod_hl2mp (or whatever name you gave it) folder.


== Adding and Removing Game Features ==

Secob 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 hl2mp games.


{{note| -- }}Important information about all the code can be found in the same folder, but in the file titled secbo_information.h- }}

Besides the important role of this file, it also has an information section containing valuable search words, which to get a better grasp of the secobmod code, and how features work.



== Setting up the Hammer Map Editor ==
.....To Do......


= 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 Half-Life 2 game. In the current compiled version the search paths in our gameinfo.txt looks like this:

Notice how we do not have Portal in the search paths. This is because Portal should never be defined here (Unless you use Static Mounting, in which case it should be put '''BELOW''' hl2).

== InstalledSourceGames.txt ==

... Currently not used....

== resource/mod_hl2mp_english.txt ==

This 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. It's found in the resource folder. You should name this file to that of your own modifications title, (modification_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 <code>secobmod__BG_MOTD_FIX</code> definition in the <code>secobmod_shareddefs.h</code> 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 <code>maps</code> 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 =

......To Do.......

= Features =

<div style="max-height:30em;overflow:auto;"><source lang=xml>

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 seco7_shareddefs.h file).

** Portal Gun, enable testing in the seco7 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:
** Dynamically mount various official Valve games to get the most for your mod.
** or use Static Mounts when you're sure you don't need Dynamic mounting.		  


* 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. 


* Teamplay Support:
** Fixes for enemy NPCs and teamplay games.


* 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!
</source></div>

= Credits =

** ChiefWhosm/Whoozzem
** Spamslayer
** MontyPython
** Sneaky
** Everyone else who used to be in 4WH.
** - and -
** Winston
** Tony Sergi
** Biohazard_90
** Sub-Zero
** DutchMega
** The Last 7 Hours Spanish Mod
** Skidz
** Alters
** .Kave
** KuRouZu
** Jorg
** z33ky
** JordanN
** TheRJMan
** SilverPower
** Vektorx4
** HalfWit2
** Sneaky[ToB]
** Anyone else forgotten
</source></div>

= Known Bugs =

<div style="max-height:30em;overflow:auto;"><source lang=xml>

*Armour not working on non-playerclass save/restore transitions.

*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.

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

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

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

*Chat bubbles angle towards the player's view, so they can appear embedded in walls etc. Currently they're disabled due to compiler problems.


*AI bend their legs when going up in lifts (elevators), but are fine going down.
</source></div>

= 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.

[[Category:Modding]]