Roadmap - ParkitectNexus/ParkitectNexusClient GitHub Wiki

Introduction

This document describes the ParkitectNexus Client roadmap.

The ParkitectNexus Client was created to easily let users install blueprints and savegames. As we started to fiddle around with modifying the game, we quickly came up with a few mod loading and distribution tools which we ended up integrating in the ParkitectNexus Client. The initial idea of the tool was to make it work quick and easy, but as the number of users of ParkitectNexus kept growing, the client attracted more and more attention and now has about 2500 users.

Ever since we've settled most of the bugs in the client, it is now time to move forward and improve its simplicity. The client should be clear and easy to use for experienced and inexperienced users. Aside of that, we also want to add features which simplify uploading of new assets to the ParkitectNexus website.

All items below are marked with MoSCoW prioritizations(M/S/C/W).

Redesigning the Frontend

The application front-ends will be redesigned for all platforms, to improve upon its simplicity. The new front-end designs should have: #11

  • (M) An slick an clear design
  • (M) A design which suits it's platform (a native look-and-feel)
  • (M) All features should be easily accessible
  • (M) Tile based overview of installed mods, blueprints and saves
  • (S) Option to upload blueprints or saves to PN
  • (S) A simple screen for changing options, and use development options
    • Switch for logging level
    • Set default launch options (e.g. development mods only?)
    • Upload log
    • Open/view log
  • (C) A log viewer for client errors
  • (C) A clear error view when a mod compilation failed

Data-layer Improvements

Since the data layer was hacked together over time (which has actually been done quite well) there a a few flaws which may need changing. The following changes should be considered:

  • (M) Move as much as possible common logic to the data layer #27
  • (M) A download queue #8
  • (S) Via the API, fetch an image for installed mods [#10]
  • (C) Improve testability and write unit tests for most, if not all, classes and methods #12
  • (C) Check if the data structure has been implemented logically and improve if necessary #22
  • (S) Change parkitectnexus URI protocol to use asset identifiers instead of full name/type/id instructions #28

New Features

Over time we have thought up a few new features:

  • (M) Mod dependencies #35
  • (S) Uploading of blueprints/savegames #29
  • (S) Subscriptions #30
    • Authentication
    • Write data-layer logic for the PN API
  • (C) Savegame and blueprint dependency checker #31
  • (C) Add a launch option to only load development mods #3 #9

Needs Research

The following items need some research:

  • Detect the current version of Parkitect. This can be used as a compile-time definition. All mods can also be recompiled when Parkitect has been updated.
  • Some users run into GitHub limits. Find out why, how and possible solutions.