Project

General

Profile

Feature #854464

modpack-installer documentation (for publishers and users)

Added by Jacob Nevins 6 months ago. Updated 6 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Jacob Nevins
Category:
Documentation
Target version:
2.6.2
Start date:
Due date:
% Done:

0%

Estimated time:

Description

Maybe more people would publish modpacks that the installer could use if the format and layout of the files was documented.

The user documentation could be clearer too -- if I were a new user, I'd want to know more about what this tool is downloading and installing to my system, and what I do next after installing a modpack.

(Docs mostly reverse-engineered from code, please shout if I misunderstood the intention)

m-readme-modinst.patch (20.3 KB) m-readme-modinst.patch master Jacob Nevins, 2019-12-31 10:35 PM
30-readme-modinst.patch (20.3 KB) 30-readme-modinst.patch S3_0 Jacob Nevins, 2019-12-31 10:35 PM
26-readme-modinst.patch (20.2 KB) 26-readme-modinst.patch S2_6 (2nd try) Jacob Nevins, 2019-12-31 10:39 PM
m-readme-modinst-bis.patch (20.7 KB) m-readme-modinst-bis.patch master, addressing #5 and #6 Jacob Nevins, 2020-01-01 11:41 AM
30-readme-modinst-bis.patch (20.4 KB) 30-readme-modinst-bis.patch S3_0, addressing #5 Jacob Nevins, 2020-01-01 11:42 AM

History

#1 Updated by Jacob Nevins 6 months ago

(patch still in progress, may not get posted today)

#2 Updated by Jacob Nevins 6 months ago

Maybe more people would publish modpacks that the installer could use if the format and layout of the files was documented.

cazfi points out that it is somewhat documented, at http://www.freeciv.org/wiki/Creating_freeciv-modpack_content . So that's not a complete explanation. (However, that page has drifted somewhat out of date.)

The attached README for git documents the format and process for each branch in detail, and includes user documentation.

When these are committed, I'll probably repurpose the wiki page to link to them and give more of an overview, including how things changed between major versions.

#3 Updated by Jacob Nevins 6 months ago

  • File deleted (26-readme-modinst.patch)

#5 Updated by Marko Lindqvist 6 months ago

--with-modlist configure option is replaced by a field in the project definition file in S3_0/master ('--with-project-definition', see bootstrap/freeciv.project for the default/example)

#6 Updated by Marko Lindqvist 6 months ago

In master, also meson based builds should install the new document.

#7 Updated by Jacob Nevins 6 months ago

Thanks for review. Both fixed (and Meson build tested).

#8 Updated by Jacob Nevins 6 months ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF