Package manual, readme and FAQ with p5
issueid=1878 01-28-2013 08:16 PM
Senior Member
Number of reported issues by aerol: 68
Package manual, readme and FAQ with p5
Package manual.doc, readme.1st and adomfaq.txt with p5

With all the new excitement generated by the renewed development, new players are and will be coming into the game. If someone wants to introduce a friend to the game with a copy of p5 instead of a copy of 1.1.1 or earlier, the p5 package does not include manual.doc, readme.1st and adomfaq.txt. That someone then has to dig up a copy of p1 or p2 or an earlier version or look for those documents online to share with the new player.

The suggestion is then to package those three files with the p5 zipfiles for the various platforms, even if manual.doc and readme.1st are not yet up to date with the versions of those documents accessible in-game. These three little files offer very valuable information to players totally new to the game about the game itself, bug reporting, and other etceteras. If the files are not yet up to date this can just be mentioned briefly at the beginning of the files advising the player to check the in-game versions for new, specifically 1.2.0 related information, and the files can be updated at a later point. The main advantage of having a version of these documents accessible outside the game itself is that they are text searchable and easier to scroll through and skim.

Concurrently, it'd be a good idea to link to the online versions of the manual, the readme and the adom FAQ on ancardia.com:

HTML manual: http://adomgb.sweb.cz/adomman-toc.html / mirrored at http://www.natrox.org/adom/improved/adomman-toc.html / downloadable version at http://ancardia.us.to/bi/manual.zip (1.1.1 version)
Downloadable .doc manual: http://ancardia.us.to/bi/manual_doc.zip (version packaged with p1)
ADOM FAQ: html version at http://adomgb.info/adomfaq.html and ascii version at http://adomgb.info/adomfaq.txt
Readme: http://ancardia.us.to/bi/readme.1st (version packaged with p1)
Issue Details
Issue Number 1878
Issue Type Feature
Project ADOM (Ancient Domains Of Mystery)
Category All
Status Implemented
Priority Unknown
Suggested Version ADOM 1.2.0 pre 5
Implemented Version (none)
Milestone (none)
Votes for this feature 3
Votes against this feature 1
Assigned Users (none)
Tags (none)




02-05-2013 12:09 AM
Member
I actually wondered where they went when I first downloaded the prereleases.

02-05-2013 08:41 PM
Senior Member
Additionally, if www.adom.de/adom/readme1st.php3 was updated to reflect the current version of readme.1st, it could become the official online version of readme.1st, and could also be linked to on ancardia.com. By the way, the font is a bit too small on the current iteration of that page.

03-08-2013 06:11 PM
jt jt is offline
Administrator
For a start, the documentation will be added to Prerelease 12 (and onward).

03-09-2013 03:37 PM
Senior Member
TB and JT: just so you know, I am the new maintainer of the Adom FAQ and there is a new version up. The up to date adomfaq.txt can still be gotten at the usual place: http://adomgb.info/adomfaq.txt.

03-09-2013 07:55 PM
jt jt is offline
Administrator
Thanks, the makefile that builds the ADOM documentation will now download the FAQ automatically to keep it up to date.

03-10-2013 11:19 AM
jt jt is offline
Administrator
www.ancardia.com now has an additional "documentation" page with manual/FAQ downloads and links.

+ Reply