fortressforever-2013/DOCUMENTATION.md
squeek 9b85904aca * Added initial DOCUMENTATION.md
* Updated README.md with FF-specific information (renamed from just README)
2013-09-03 23:03:31 -07:00

1.4 KiB

Legend

  • TODO Things that need documentation
  • Unconfirmed statements
  • Confirmed statements
  • (FF) Fortress Forever specific

New Entity Implementation Checklist

  • TODO Document general entity requirements

Demos

  • TODO Document the requirements for something being replicated in a demo
  • TODO Document how ConVars get set when watching someone else's demo and how to include/exclude ConVars from doing that

SourceTV

  • TODO Document the requirements for something being replicated to a SourceTV client or in a SourceTV demo (and what would exclude them)
  • Variables in a _NOBASE DataTable do not get recorded in SourceTV demos

Prediction

  • TODO Document how to make something properly predicted

DataTables / Networked Variables

  • TODO Document DataTables in how they interact with other people on the server (how to send netwrorked variables to specific clients depending on certain conditions)
  • SendProxys are used server-side to determine how the variables in the DataTable are sent (see game/server/sendproxy.cpp)
    • TODO List the available SendProxys (or link to a SendProxy section)

Example Feature

General description/overview of the feature (optional)

Usage

  • List of guidelines for dealing with the feature
  • Information about things like how to implement a new derived class or how to handle a new feature-related entity