fortressforever
/
fortressforever-2013
mirror of https://github.com/fortressforever/fortressforever-2013.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added some file/dir guidelines

This commit is contained in:
Ryan Liptak 2013-09-04 11:37:00 -07:00
parent 11845f8e16
commit e16bdd07e1
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -18,13 +18,23 @@ We will be using the branching model laid out here: http://nvie.com/posts/a-succ
## Code
* Avoid making changes in the base Source engine files; always try to move those changes into a FF-specific source file that derives from the base class.
### Syntax
#### Variable, Function, File Names and Directory Structure
#### Variable and Function Names
* __TODO__ Decide on a naming convention
* Always make variable and function names as descriptive as possible (if 'i' stands for 'currentPlayerIndex' then use 'currentPlayerIndex')
#### File Names and Directory Structure
* Always put FF code files in the src/game/<server/client/shared>/ff/ directory.
* __TODO__ Decide on a subdirectory scheme
* Always prefix Fortress Forever code files with ff_
* Add a secondary prefix depending on the usage of the file; for client-only files, use cl\_; for server-only files, use sv\_; for shared files, use sh\_
* Example: the "player" source files would be named: ff\_cl\_player, ff\_sv\_player, and ff\_sh\_player
### Adding/Removing Files
Solution and makefiles are no longer stored on the repo, they are generated using [VPC](https://developer.valvesoftware.com/wiki/Valve_Project_Creator). To add/remove files from the project, you must edit the __game/client/client_ff.vpc__ and/or __game/server/server_ff.vpc__ files and then execute __createallprojects(.bat)__ in the __src/__ directory. To remove a non-FF-specific file from the project (like HL2DM files), add exactly what you would to add the file (or copy the line from the .vpc that includes it), but put a - before "$File".