Author |
Topic |
|
tekgirl
Starting Member
USA
40 Posts |
Posted - 14 January 2004 : 16:50:07
|
Title: Additional Smilies Version: 1.1 for Snitz Forums 3.4.xx and possibly earlier versions Author: tekgirl Last Update: January 14, 2004
Description: This mod is used to add ten additional animated smilies to the Snitz default group. Uses the existing Snitz default table, without changing the layout.
Installation Instructions: Please read the readme.htm file that comes with the mod.
Difficulty of Installation: Very Easy. The files have already been modified, using a clean Snitz install, and the images are included.
Download: http://www.snitzbitz.com/mods/details.asp?Version=All&mid=171
Support: If you have problems installing this MOD, post your questions in the Help: MOD Implementation
|
--tekgirl |
|
Faizan
Average Member
United Kingdom
592 Posts |
Posted - 14 January 2004 : 17:00:12
|
You should have atleast added a proper readme file.
|
»Snitz Graphics
|
|
|
tekgirl
Starting Member
USA
40 Posts |
Posted - 14 January 2004 : 17:35:28
|
I thought I did. I am totally new to this process, so if there is something I should have done, I would appreciate the constructive criticism.
The files are already modified and the modifications clearly marked. If you have any suggestions on how I can make the readme better, feel free to let me know
I actually tried to follow the readme files of other posters. |
--tekgirl |
|
|
Faizan
Average Member
United Kingdom
592 Posts |
Posted - 14 January 2004 : 18:18:10
|
Actually, most mods have instructions like "find this and put this below this", that's what I meant by a "proper readme"
|
»Snitz Graphics
|
|
|
tekgirl
Starting Member
USA
40 Posts |
Posted - 14 January 2004 : 18:28:47
|
I understand what you are saying. I guess I thought that as long as the code was clearly delineated on the pages I modified, that would not be necessary, since the pages can just be uploaded as is, if they have not been modified. I will try to improve the readme.
Thanks for your feedback - it is much appreciated! |
--tekgirl |
|
|
Roland
Advanced Member
Netherlands
9335 Posts |
Posted - 15 January 2004 : 06:17:10
|
If you put "pre-modded files" in the MOD's ZIP, that's great for people who haven't added MODs to their forums yet, but without instructions such as what faizan recommended, it'd be a lot more work for people who have added MODs and want to add yours too. A readme file with instructions of how to "install" the MOD is always recommended. Personally I prefer readme files in HTML format, with the codes to find/replace and the codes to add in text areas for easier copy & pasting, and more layout options than when using a txt file. |
|
|
tekgirl
Starting Member
USA
40 Posts |
Posted - 15 January 2004 : 10:40:39
|
I understand what you're saying and I agree with you, as I have added mods myself. Since this mod involved only the smilie pages and I haven't really seen many mods which involve those pages, I didn't think it would be a problem. I guess I was wrong!
Since there really is no replacing of code, only adding, what I could do is write a new readme with instructions on where to add the code, with what code is above and below.
I also prefer the type of readme you do for more complicated mods, but am not sure how to write one. If someone would be kind enough to give me an example, that would be helpful! For less complicated mods, to let me know where the code should be placed is fine and that is what I was basing my readme on. But one should try to write for everyone - what one person finds easy, another may find difficult.
Thanks for all your help! |
--tekgirl |
|
|
OneWayMule
Dev. Team Member & Support Moderator
Austria
4969 Posts |
|
tekgirl
Starting Member
USA
40 Posts |
Posted - 15 January 2004 : 12:33:58
|
OneWayMule,
Your readmes are excellent and I really appreciate the help. Thank you!
I did create a new readme file, based on your examples. It was a bit of work, but I'm glad I did it. Hopefully it will now meet the Snitz standard - I'm pretty sure it will now meet Roland's |
--tekgirl |
Edited by - tekgirl on 15 January 2004 20:26:36 |
|
|
OneWayMule
Dev. Team Member & Support Moderator
Austria
4969 Posts |
|
Roland
Advanced Member
Netherlands
9335 Posts |
Posted - 16 January 2004 : 07:41:11
|
quote: Originally posted by tekgirl
Hopefully it will now meet the Snitz standard - I'm pretty sure it will now meet Roland's
I don't have any standards that go beyond having a clear, easy to follow file with the instructions, so don't worry about me
I just gave the advise to use an HTML file with text areas for the codes to be displayed in as it's easier for most people, but it's by no means necessary or required for a MOD writer to do it like that. Still, it's amazing how much more people will appreciate your MOD if you have instructions in a file that's easier to follow, rather than putting it in a plain text file, even though it's still the same MOD |
|
|
tekgirl
Starting Member
USA
40 Posts |
Posted - 16 January 2004 : 10:36:02
|
I really appreciated your advice and learned something by your post! That's what counts! Lest you get the wrong idea
Thanks to OneWayMule, I now know how to write a good HTML readme file, which I agree, is much easier for people to follow. So thanks again to both of you!
P.S. Are there guidelines somewhere on how to write a MOD? |
--tekgirl |
|
|
|
Topic |
|