[WIPRELz] TES3 Readme Generator

Post » Tue Sep 22, 2015 4:29 pm

The TES3 Readme Generator is to make life easier and simpler for Morrowind modders everywhere! No more do you have to mess around in Notepad to make your readme's look good. The TES3 Readme Generator will do it all for you. Just type in the information about your mods into the relevant fields, click the Generate button, and voila! A new readme! Ready to be distributed with your mod.

Current version: 2.1.2

Any section left blank will not be included in the generated readme.

Features

  • Generate a readme with the following sections:
    • Title of Mod
    • Version
    • Author
    • Requirements
    • Specific Requirements
    • Description
    • Install
    • Uninstall
    • Updating
    • Incompatibility
    • Known Issues or Bugs
    • Load Order
    • Changelog
    • Credits
    • Contact
    • Permissions
  • The readme can be opened automatically after generation for reviewing.
  • Custom sections can be added to the readme
    • As many sections can be created as needed
    • Each section can be titled differently
  • Default and custom sections can be reordered
  • Preview tab
  • A preferences tab
    • Section title separator's can be customised
    • A readme contents can be toggled
    • Readme filename can be customised using the magic words: %Name, %Version, and %Author
    • Default generation path can be customised
    • Default saving path can be customised
  • Saving readme's in the .esr format
  • Loading readme's in the .esr format

Changes in 2.1.2

  • Moved location of settings.ini so that installer download won't cause permission issues.

Spoiler

Changes in 2.1.0

  • Fixed blank sections still being listed in the section contents
  • Fixed section contents misalignment of items

Changes in 2.0.0

  • Added: an icon
  • Added: a check to make sure a directory exists before saving or generating
  • Changed: default save and generation paths
  • Removed: many old things here and there

Changes in 1.9.7

  • Added: Separator selection
  • Added: Can now select whether to open readme after generation
  • Added: Can now use a folder browser to select saving and generation paths
  • Added: Section contents generation
  • Added: Filename magic words
  • Added: All preferences are now saved between sessions

Changes in 1.9.0

  • Rebuilt with WPF using the MVVM pattern
  • Added: Load Order section
  • Changed: Moved Custom Sections to its own tab
  • Changed: Improved UI
  • Many other improvements and tweaks
  • Issue: Preferences are not currently saved
  • Issue: Automatically opening the readme after generation is broken
  • Issue: Readme contents section is broken

Changes in 0.9.1

  • Added: Saving and loading in the .esr format.
  • Added: A folder browsing dialog for selecting the default saving and generating paths.

Planned Features

  • Load order section

Changes in 0.7.4.5

  • Fixed issue where text from deleted sections remained
  • Fixed issue where deleted sections where still being written to the readme
  • Fixed issue where 'EMPTY STRING' would appear in the text box when a new custom section was created

Changes in 0.7.4

  • Added: checkbox to enable and disable the extra permissions box.
  • Added: status bar that informs the user where the readme has been generated, and if there are any errors.
  • Added: custom sections.
  • Added: checks for name, version, author, and title version fields. If these are empty the readme will not generated.
  • Added: permissions tab.
  • Added: separator customising.
  • Added: section reordering (including custom sections).
  • Added: contents, and being able to toggle it.
  • Added: can now change the file name of the generated readme. Available magic cards are: %Name, %Version, and %Author.
  • Added: Can now change the default generation and saving paths.
  • Added: Can toggle whether to create a new directory or not. Used for when the default gen or save directories don't currently exist.
  • If a directory does not exist, and creating a new directory is unchecked, then the readme will be generated in the fallback directory of My Documents.
  • Added: all preferences will now persist across sessions.
  • Removed: readme generation dialog.
  • Removed: readme saving dialog (you couldn't access it, but it was there).
  • Code: A lot of Readme object restructuring, including the addition of the ReadmeSection object.

Download:

  • http://www.nexusmods.com/morrowind/mods/43208/?
  • http://www.theassimilationlab.com/forums/files/file/1026-tes3-readme-generator/
  • http://tesalliance.org/forums/index.php?/files/file/1807-tes3-readme-generator/

Source:

  • http://gitlab.theassimilationlab.com/brucoms/tes3readmegen
  • http://gitlab.theassimilationlab.com/brucoms/tes3readmegen2

Permissions:

This programme can be modified without permission. Just make sure that you credit me (Trevalyan Stevens (aka 'Brucoms')) as the original developer.

If you wish to redistribute, please contact me first.

User avatar
SEXY QUEEN
 
Posts: 3417
Joined: Mon Aug 13, 2007 7:54 pm

Post » Tue Sep 22, 2015 11:44 am

Thank you for this, I will give it a try :)

User avatar
Roanne Bardsley
 
Posts: 3414
Joined: Wed Nov 08, 2006 9:57 am

Post » Tue Sep 22, 2015 6:53 pm

No problem! Keep an eye out for the updates! :)

User avatar
Shianne Donato
 
Posts: 3422
Joined: Sat Aug 11, 2007 5:55 am

Post » Tue Sep 22, 2015 7:45 am

So, any issues or comments so far? Is the interface functional and not irritating?

All feedback would be fantastic! :)

User avatar
k a t e
 
Posts: 3378
Joined: Fri Jan 19, 2007 9:00 am

Post » Tue Sep 22, 2015 8:34 am

It works perfectly. I haven't encountered any issues.

User avatar
Dawn Porter
 
Posts: 3449
Joined: Sun Jun 18, 2006 11:17 am

Post » Tue Sep 22, 2015 10:32 am

Gave it a try. No errors or issues, but while playing around with it a few ideas came to my head:

  • In the Basic Info tab, in the bottommost Permissions section, under the lisited menu (Modify my mod without credits or permission; Modify my...etc.) there is this larger white box. I am guessing it is for input of custom permissions or for permission notes. However it should be marked as such, so that no guessing would be needed.
  • The "About" window is too big for its contents. A purely cosmetic suggestion, though, and I do realise you may want to add some things there later.
  • How about having an option (for example in the "Preferences" tab that you are planning to implement) to have the application generate the readme with a filename defined by a template? For example "Title - Readme" or "Title Version - Readme". You could add a few predefined templates as well as an option for the user to generate templates on their own. If so, you'd only need to provide simple instruction on what to put into the template to make it work - for example how to mark the variables for the program to interpret them as strings set earlier by the user; e.g. %Title would generate the Title that he user had set or %Version would input the version.
  • Another idea, connected to the one before that and to your planned feature of customisable default generatio location, would be to have a preference option that would do the following: instead of asking the user where to save and how to name the file, user could select where to save and the program would not prompt him to select the name - it would be generated based on the naming template feature I mentioned before. However, it would be good to let the user know that the application did it, so a prompt with "Your readme has been generated!" or a more specific "Your has been generated at " or something
  • I know that you have planned "Setting default generation location" feature, however I'd appreciate if apart from that option the generator would remember where I last generated a readme and keep that location so that when I want to save a readme again, it will open at the last used location. I can see that it effectively IS like that now, but in a hacky and unclear way: After I generated one readme and in the same application session wanted to create it again, the application opened its current default location (user documents) and as a file name it had path to the location I generated the first readme + the first readme's name. If that's unclear, let me present an example:
  1. I generate the first readme on Desktop, choosing "Test readme" as filename.
  2. I want to generate the readme in the same session, so I click "Generate" again.
  3. The same default location opens as the first time (User Documents), but in the "File name" field I have "C:\Users\Username\Desktop\Test readme"

I think it'd be better if instead of implementing it by path it was done with simply remembering the last generation location.

Those are just a few ideas. Should you find them unclear, don't hesitate to ask. And don't think too much on them if you find them unnecessary, I just wanted to provide some more feedback to gnaw on :)

User avatar
Rusty Billiot
 
Posts: 3431
Joined: Sat Sep 22, 2007 10:22 pm

Post » Tue Sep 22, 2015 4:25 pm

Good to hear! :D

Thank you for your feedback and ideas!

  • Excellent point. I think I'll do the same for what I did for the specific requirements section.
  • Yeah, I left it like that to remind myself to add more detail when it comes to me. Thanks for pointing it out though! :smile:
  • I will be added a feature where it will automatically create the file name for you, but I think I'll expand it to include your ideas.
  • Considering that I'll be allowing the user to customise the save/gen path, and now they can customise the name. The save dialogs will be quite redundant, and shall be removed.
  • You mean a path that's separate from the default set in the Preferences?

Thank you again for your feedback! One thing I forgot to mention in the OP is that TES3 Readme Generator already uses a .ini file and it already has the default paths customisable. It's just that I haven't implemented a user friendly method yet. :smile:

User avatar
Stefanny Cardona
 
Posts: 3352
Joined: Tue Dec 19, 2006 8:08 pm

Post » Tue Sep 22, 2015 6:40 am

Glad to be of use!

I presume you are referring to the last point of my suggestions... and to be frank I think I overcomplicated the description there. Let's try again, also with an additional idea.

What I would like to have:

  • If I have not set a default location for readme generation in the preferences, the application will remember the last location I saved a readme in; and next time I generate a readme, the save dialog will open at that location.

What I have now:

  • Whenever I generate more than one readme in a session, the location is always the value of sReadmeDefaultPath, and the filename is always last_used_path\last_file_name

I'm not sure it's any clearer. If it is not, just nevermind it :P

I also have another idea! How about implementing a list of contents into the generated readmes? I've seen it in some of the readmes and it is a great asset in my opinion.

User avatar
KiiSsez jdgaf Benzler
 
Posts: 3546
Joined: Fri Mar 16, 2007 7:10 am

Post » Tue Sep 22, 2015 7:51 am

I like the look of this (just need to create a mod so I can use it :smile: )

I totally agree with Skrawafunda's suggestions (particularly the one which means that the readme's not called "readme.txt", another option could just be %Title%.txt)

Just a thought on saving the last location the readme was exported to: have a fallback directory if the last used location's been deleted! I haven't packaged any mods in a while but when I have I tend to export to a temporary directory, create the mod and readme and then delete that temporary directory.
User avatar
Charlie Sarson
 
Posts: 3445
Joined: Thu May 17, 2007 12:38 pm

Post » Tue Sep 22, 2015 5:47 am

I know this is a pretty trivial suggestion, but could there be some feild where we could customize the type of seperators the readme would use? I'm not a fan of bunches of equals signs used as separators and prefer just spacing mine out with indents and a good amount of whitespace. It's the reason I haven't used readme generators before.

User avatar
Laura Ellaby
 
Posts: 3355
Joined: Sun Jul 02, 2006 9:59 am

Post » Tue Sep 22, 2015 11:51 am

Ah ah! I know it's a secondary thing, but me too I was thinking: ``can I change the separator === by **** symbols instead`` lol

User avatar
amhain
 
Posts: 3506
Joined: Sun Jan 07, 2007 12:31 pm

Post » Tue Sep 22, 2015 5:28 pm

Totally agree! Wanted to suggest that too but I see the others also have thought about that :)

User avatar
IsAiah AkA figgy
 
Posts: 3398
Joined: Tue Oct 09, 2007 7:43 am

Post » Tue Sep 22, 2015 4:54 pm

Wow, thanks for the feedback everyone! Being in different timezones certainly makes replying in a timely manner difficult.

Aah that makes a lot of sense. That's simple enough to implement.

The list of contents is a good idea.

The fallback directory could just be the customisable default directory. If there's no default, I think I'll just have the program fallback to using My Documents.

So you would prefer to have an extra blank line instead of the line of equals signs?

User avatar
Cheville Thompson
 
Posts: 3404
Joined: Sun Mar 25, 2007 2:33 pm

Post » Tue Sep 22, 2015 7:45 am

Yes. Options to replace the equals signs with hyphens, asterisks, underscores, or other characters would be nice too.

User avatar
Kate Murrell
 
Posts: 3537
Joined: Mon Oct 16, 2006 4:02 am

Post » Tue Sep 22, 2015 8:16 am

Got it! :)

User avatar
Your Mum
 
Posts: 3434
Joined: Sun Jun 25, 2006 6:23 pm

Post » Tue Sep 22, 2015 5:43 am

Got to try this and I like it very much!

I have had no problems whatsoever and agree with the suggestions made above.

User avatar
emily grieve
 
Posts: 3408
Joined: Thu Jun 22, 2006 11:55 pm

Post » Tue Sep 22, 2015 12:31 pm

Version 0.7.4 has been released! The OP has been updated with the relevant info, and you can get the release hot off of the keyboard http://www.nexusmods.com/morrowind/mods/43208/?!

User avatar
Jack Moves
 
Posts: 3367
Joined: Wed Jun 27, 2007 7:51 am

Post » Tue Sep 22, 2015 4:52 am

Thank you very much for this utility and taking into consideration ours suggestions. :tes:

User avatar
Kortknee Bell
 
Posts: 3345
Joined: Tue Jan 30, 2007 5:05 pm

Post » Tue Sep 22, 2015 3:27 pm

No problem! They were all really good suggestions anyway! :)

Any more feedback from people?

User avatar
Alexandra walker
 
Posts: 3441
Joined: Wed Sep 13, 2006 2:50 am

Post » Tue Sep 22, 2015 5:00 pm

A bug and a suggestion (both for version 0.7.4):

Bug:

In "Other" tab, in the "Custom Sections" section if you click on "Delete" while nothing is there, you receive the following error. I've translated the non-English text for you:

System.ArgumentOutOfRangeException: InvalidArgument=Warto?? '-1' nie jest prawid?ow? warto?ci? dla 'index'. (Value '-1' is not a valid value for 'index'.)Nazwa parametru: index (Name of parameter: index)   w System.Windows.Forms.ListBox.ObjectCollection.RemoveAt(Int32 index)   w TES3ReadmeGenerator.frmMain.btnSectionDel_Click(Object sender, EventArgs e)   w System.Windows.Forms.Control.OnClick(EventArgs e)   w System.Windows.Forms.Button.OnClick(EventArgs e)   w System.Windows.Forms.Button.OnMouseUp(MouseEventArgs mevent)   w System.Windows.Forms.Control.WmMouseUp(Message& m, MouseButtons button, Int32 clicks)   w System.Windows.Forms.Control.WndProc(Message& m)   w System.Windows.Forms.ButtonBase.WndProc(Message& m)   w System.Windows.Forms.Button.WndProc(Message& m)   w System.Windows.Forms.Control.ControlNativeWindow.OnMessage(Message& m)   w System.Windows.Forms.Control.ControlNativeWindow.WndProc(Message& m)   w System.Windows.Forms.NativeWindow.Callback(IntPtr hWnd, Int32 msg, IntPtr wparam, IntPtr lparam)

In the error window we may choose to either ignore the error and continue using the application or to close it.

As for suggestion:

It would be nice if we could load a previously create readme and modify it inside the editor isntead of recreating it or having to do this in the same application session. It could be done easier once you implemented the to-do feature of "Saving readme's in the .esr format", I suppose.

User avatar
Haley Cooper
 
Posts: 3490
Joined: Wed Jun 14, 2006 11:30 am

Post » Tue Sep 22, 2015 7:34 am

Bug:

Dammit! I should have picked up on that before releasing. My apologies everyone, it shall be fixed ASAP.

Suggestion:

That's the plan with the whole .esr format thing. You'll be able to separately save your readmes in this format, which you'll then load from. I decided to do this instead of simply importing the actual .txt format because it will simply be easier. I won't have to deal with any possibility of the user hand modifying the readme and then loading it back up.

User avatar
Nancy RIP
 
Posts: 3519
Joined: Mon Jan 29, 2007 5:42 am

Post » Tue Sep 22, 2015 5:20 am

Ok, 0.7.4.2 is released with the Delete button fix!

User avatar
Jarrett Willis
 
Posts: 3409
Joined: Thu Jul 19, 2007 6:01 pm

Post » Tue Sep 22, 2015 2:38 pm

I've been fiddling with the generator while creating a few readmes for compatibility patches and I've had to manually create a "Load Order" section. Do you think it could be a worthwhile addition to the generator as a default section, or is it not that needed and should stay doable as a custom section only?

And also another thing: whenever I create a custom section, in the field of the section I automatically get "EMPTY STRING".

http://i.imgur.com/glzRugF.png

I think it would look better if instead of that, we'd get, well, an empty field :tongue:

Yet another thing: whenever I delete a custom section, its field's text is being left over.

http://i.imgur.com/Z1JV3NT.png

Aaand ultimately other thing: after deleting a section, you still get it in your generated readme. It is only deleted in the application's "Other" tab, while still being in the Preferences tab (the "Section order" section) and in the output readme file. This issue is probably connected with the one before it.

User avatar
electro_fantics
 
Posts: 3448
Joined: Fri Mar 30, 2007 11:50 pm

Post » Tue Sep 22, 2015 2:58 am

Thanks for pointing those out! :) They've now been fixed in v0.7.4.5, which is also now available for download at the Nexus.

On the load order section:

I might just add it. Could you send me an example(s)?

User avatar
Setal Vara
 
Posts: 3390
Joined: Thu Nov 16, 2006 1:24 pm

Post » Tue Sep 22, 2015 4:14 am

E.g.:


Load Order1. Pearls Enhanced (whichever version you use)2. Graphic Herbalism (optionally with the Extra module)3. The Compatibility Patch (only one of the four provided)
Load Order1. NoM2. Compatibility Patch
Load Order:1. Graphic Herbalism2. Correct UV Ore Replacer3. Modified GH Extra module
Load order:all your modsPTEmerged objectsmerged levelled lists
User avatar
Dina Boudreau
 
Posts: 3410
Joined: Thu Jan 04, 2007 10:59 pm

Next

Return to III - Morrowind