Map Database  •  FAQ  •  RSS  •  Login

Readme

<<

Litude

User avatar

King Karolus

Posts: 1233

Joined: 01 May 2006, 22:00

Website: http://www.knightsandmerchants.net

Location: Finland

Post 20 May 2009, 12:34

Readme

So I whipped up a potential readme for the patch, get it here.
The changelog is ways too long (~20 pages) at least in my opinion so I was thinking about removing all small differences and concentrating on the bigger bugs. Any naysayers? A complete changelog could be on the website or somewhere.
<<

Lewin

User avatar

KaM Remake Developer

Posts: 3822

Joined: 16 Sep 2007, 22:00

KaM Skill Level: Skilled

ICQ: 269127056

Website: http://lewin.hodgman.id.au

Yahoo Messenger: lewinlewinhodgman

Location: Australia

Post 20 May 2009, 13:25

Nice! It looks very professional.
My comments:
- There are no bookmarks, which would be a useful feature of the PDF even though it's only shortish
- The disclaimer is written in quite informal language, perhaps some of it should be made slightly more formal? (ripping off is a bit ambiguous) I'm not saying write it in legal English though. What do other people think?
- Installation: "...the changes that this patch does": I don't like the "does". What about "...the changes that this patch makes to the game"?
- Overview: "All this and more gets explained throughout in the new and improved tutorial": I don't think throughout is the correct word. Shouldn't it be thoroughly or something?
- The links in FAQ should be made into blue clickable links.

I don't think the big change log is a problem. If you have bookmarks then people will be able to skip past it easily. Still, that's just my opinion.

Another thing not about the readme: I was just thinking: What will happen if someone tries to install the patch over a version of the game that has already been patched to 1.6? If you do this with the betas then I think it might have caused some issues with music files being updated and such.

I like it! Much nicer than the text file you had before.
Keep it up, and I'll try to get those sound effects done soon.
Lewin.
<<

Litude

User avatar

King Karolus

Posts: 1233

Joined: 01 May 2006, 22:00

Website: http://www.knightsandmerchants.net

Location: Finland

Post 20 May 2009, 20:47

- There are no bookmarks, which would be a useful feature of the PDF even though it's only shortish
Huh, there are bookmarks?
- The disclaimer is written in quite informal language, perhaps some of it should be made slightly more formal? (ripping off is a bit ambiguous) I'm not saying write it in legal English though. What do other people think?
Yeah perhaps it should, was just a bit bored when writing that part so I ended up writing something random. If you want to reword it, feel free. Could attempt something on my own as well but my English isn't perfect so I'm sure you could do it better.
- Installation: "...the changes that this patch does": I don't like the "does". What about "...the changes that this patch makes to the game"?
Sounds better, yeah.
- Overview: "All this and more gets explained throughout in the new and improved tutorial": I don't think throughout is the correct word. Shouldn't it be thoroughly or something?
Yeah it should definitely be thoroughly, didn't know how to spell it (spellt it throughoutly and word complained it being a non-exsitant word hence messing up and forgetting to correct it :oops: )
- The links in FAQ should be made into blue clickable links.
The website links? Well I tried to make it look like a book and generally website links are not links in books, but if it's better than way perhaps I could reconsider.
I don't think the big change log is a problem. If you have bookmarks then people will be able to skip past it easily. Still, that's just my opinion.
Yeah the problem was mainly that I doubt someone is going to read 20 pages of changes even if they're slightly interested and cutting it down would make it easier to read.
Another thing not about the readme: I was just thinking: What will happen if someone tries to install the patch over a version of the game that has already been patched to 1.6? If you do this with the betas then I think it might have caused some issues with music files being updated and such.
Well the plan is that you will be installing it on a fresh copy or on 1.58 SR2, not on a previous beta of the patch as ensuring compability with all the different betas is just asking for trouble and takes too much time compared to what it gives.
<<

merchant_992

Pikeman

Posts: 162

Joined: 11 Nov 2006, 23:00

Location: Rinsumageest, Nederland

Post 20 May 2009, 22:15

If you want to cut down the changelog. Still give the complete changelog in an other file. I don't tink much people will read it, but it can be useful.
<<

Lewin

User avatar

KaM Remake Developer

Posts: 3822

Joined: 16 Sep 2007, 22:00

KaM Skill Level: Skilled

ICQ: 269127056

Website: http://lewin.hodgman.id.au

Yahoo Messenger: lewinlewinhodgman

Location: Australia

Post 28 May 2009, 11:54

Huh, there are bookmarks?
Yeah, well there are in the original manual that came with KaM. If you click View -> Bookmarks or something like that. (I use Foxit Reader, so it's different) I think bookmarks would make it easier to find the section you want, and people can just ignore them if they like. I don't know how to add them though.
Yeah perhaps it should, was just a bit bored when writing that part so I ended up writing something random. If you want to reword it, feel free. Could attempt something on my own as well but my English isn't perfect so I'm sure you could do it better.
I'll consider it. Right now I'm kind of busy with schoolwork, so maybe during the holidays.
The website links? Well I tried to make it look like a book and generally website links are not links in books, but if it's better than way perhaps I could reconsider.
Well it's up to you. I doubt anyone will print the readme, and even so blue-underline has kind of become the standard for links everywhere.
Yeah the problem was mainly that I doubt someone is going to read 20 pages of changes even if they're slightly interested and cutting it down would make it easier to read.
Thinking about it again, I agree with you. But I do think the entire change log should be provided, in a separate file like Merchant_992 suggested.
Well the plan is that you will be installing it on a fresh copy or on 1.58 SR2, not on a previous beta of the patch as ensuring compability with all the different betas is just asking for trouble and takes too much time compared to what it gives.
Ok, I see.
<<

Litude

User avatar

King Karolus

Posts: 1233

Joined: 01 May 2006, 22:00

Website: http://www.knightsandmerchants.net

Location: Finland

Post 28 May 2009, 17:28

Yeah, well there are in the original manual that came with KaM. If you click View -> Bookmarks or something like that. (I use Foxit Reader, so it's different) I think bookmarks would make it easier to find the section you want, and people can just ignore them if they like. I don't know how to add them though.
Sorry, what I meant is that the readme does have bookmarks. At least my Adobe Reader can read them, dunno if Foxit is having some problems with them (wouldn't surprise me as the incompability with certain PDF files is what threw me off from using it as my primary PDF viewer).
<<

Litude

User avatar

King Karolus

Posts: 1233

Joined: 01 May 2006, 22:00

Website: http://www.knightsandmerchants.net

Location: Finland

Post 05 Aug 2009, 12:29

Okay I went ahead and did what I'm hoping to be the final version of the readme (save for any possible changes to the changelog). If anyone has any suggestions or notices any errors, make sure to report those now! E.g. if there's some note in the list of changes that is hard to understand I'd appreciate feedback.

And for the curious, yeah the changelog will be altered in each translation so it accurately reflects the changes in that language version of the patch (the one here is naturally for the English build).
<<

Lewin

User avatar

KaM Remake Developer

Posts: 3822

Joined: 16 Sep 2007, 22:00

KaM Skill Level: Skilled

ICQ: 269127056

Website: http://lewin.hodgman.id.au

Yahoo Messenger: lewinlewinhodgman

Location: Australia

Post 09 Aug 2009, 03:43

I'm going to comment just because no one else has. It looks fine to me. I quickly checked over it and I didn't see any major issues.
Keep up the good work!
<<

Krom

User avatar

Knights Province Developer

Posts: 3280

Joined: 09 May 2006, 22:00

KaM Skill Level: Fair

Location: Russia

Post 09 Aug 2009, 05:21

I like how it looks as well :)
Well done!
Knights Province at: http://www.knightsprovince.com
KaM Remake at: http://www.kamremake.com
Original MBWR/WR2/AFC/FVR tools at: http://krom.reveur.de
<<

Thunderwolf

User avatar

Crossbowman

Posts: 233

Joined: 22 Jan 2008, 23:00

Website: http://thunderwolf.freehost10.com/KaMMissionBuilder/index.php

Location: Netherlands

Post 12 Aug 2009, 11:28

looks good.
~old sig
MissionBuilder v0.9f2 UPDATED!!
Defend The Outer Colony. fight for your king and uncover the secrets of this land.
Temporary version at
http://thunderwolf.x10hosting.com/index.php
"You can't defeat me, I've played Knights and Merchants"

Return to “1.60 Patch (Service Release 3)”

Who is online

Users browsing this forum: Semrush [Bot] and 11 guests