[WIP][Client][Server] Mod Help Player Guide

Discussion in 'Work-In-Progress Mods' started by wondible, January 11, 2015.

  1. wondible

    wondible Post Master General

    Likes Received:
    Release Thread

    1. Make the player guide accessible accessible from the game lobby (`new_game`)
    2. Add tabs to the player guide with mod articles. Default articles are provided with the official modinfo fields, or mods can specify custom articles.
    There are both client and server mods. The lobby functionality is only provided to other players (or when using only the server mod yourself) after a UI refresh, which must occur after mod loading is complete.

    The official player guide is currently under development, so this mod may be volitile for a while.

    The repo is the client mod. A grunt task creates the server mod with modified shadow files (assuming it can find PA files in your system) in `../../server_mods/`

    - https://github.com/pamods/mod_help_player_guide
    - http://wondible.com/pa/mod_help_player_guide_v0.1.0.zip
    - http://wondible.com/pa/mod_help_player_guide.server_v0.1.1.zip

    Custom Articles

    The mod attempts to load an `<identifier>/mod_help.json` for each active mod. The file should contain a key named `articles`, which is an object containing article-name:article-url pairs.

    This mod currently has example files:


          "articles": {
            "Mod Help Player Guide (Client)": "coui://ui/mods/mod_help_player_guide/article/mod_help_player_guide.html"

    Mods with provisional support

    To test, download an archive.

    - https://github.com/JustinLove/extreme_energy_combat
    - https://github.com/JustinLove/extremely_efficient_engineers
    - https://github.com/JustinLove/finite_metal
    - https://github.com/JustinLove/junkyard_wars
    - https://github.com/JustinLove/no_metal_commander
    - https://github.com/JustinLove/puppetmaster
    - https://github.com/JustinLove/reclaimable_features
    Last edited: January 23, 2015
  2. wondible

    wondible Post Master General

    Likes Received:

Share This Page