Skip to content

Wiki page addition template #1

@Maldor

Description

@Maldor

This issue attempts to create a template from which to contribute additional articles and to document efforts in modding certain aspects of the game that we currently have access to. Discussion is welcome to add, remove or change the template. Where possible, the template should be made available on the main README or in a separate file available in the repository.

The following questions should be asked when opening an issue regarding an addition to the wiki:

  1. What section should this page be filed under?
  2. What feature/function does this document?
  3. How will this assist future modders?

For documenting purposes, the wiki should maintain the same structure as the moddable files, with added references to commonly modded resources. When adding a new file to this documentation, the following should be answered in the page:

  1. Where is the file located? (assuming /content or /source is the root of the filesystem)
  2. What is contained in the file? (Short description of what the file does or contains)
  3. Are there any known game functions that reference data in this file? (This might be used to correlate something in https://github.com/cc2modteam/knowledgebase/wiki/Mod-Reference-Lua-Global-vars)
  4. Are there any files that this file references? (This will be most common for the scripts and game objects)
  5. What are the useful functions of changing this file? (A short description of what can be changed in this file and what effect that change will have)

Again, discussion is welcomed in this effort to improve documentation of the moddable assets of this game, I hope to contribute more as my own modding journey begins.

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