Skip to content

Architecture #1

@Ingramz

Description

@Ingramz

This will probably consist of easily maintainable and convertible files.

Before re-inventing the wheel, some things need to be checked.

  • File format - is there a convenient format already which can handle multiline strings and act as a list of properties. Considering YAML.
  • Possible fields
    • Game - CoD, UO, CoD2, CoD4, CoDWaW, CoDBO...
      • Are there definitions that vary between game versions, how to specify those?
    • Single-Player/Multi-Player/Both?
    • Module/Category
    • Summary/Description
    • Whether is it a function, a method or both (eg iprintln)
      • If method, call on what?
    • Example code
    • Argument descriptions
      • Variable arguments
      • Optional arguments
      • Argument type
        • Limited set of constants
    • Return value
      • Return type
    • Additional notes
    • Platforms where it works (or where it doesn't)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions