Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Architecture #1

Open
8 of 19 tasks
Ingramz opened this issue Jan 1, 2015 · 0 comments
Open
8 of 19 tasks

Architecture #1

Ingramz opened this issue Jan 1, 2015 · 0 comments

Comments

@Ingramz
Copy link
Contributor

Ingramz commented Jan 1, 2015

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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Ingramz