ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

Difference between revisions of "RTFM"

From ModEnc
Jump to: navigation, search
(Initial version, no inner-ModEnc-links except for "INIs")
 
(Read the guides: Provided working DZ link, changed Art Guide link to non-deep as we don't want to be assholes.)
 
(6 intermediate revisions by 5 users not shown)
Line 2: Line 2:
 
Hi there. This is a page similar to [http://www.fuckinggoogleit.com/ Just Fucking Google It]. If you have been sent here by someone from a forum after asking a question, chances are that the question you asked has either been answered a dozen times before, or the answer is totally obvious. Either way, please check if you did the following before asking your question:
 
Hi there. This is a page similar to [http://www.fuckinggoogleit.com/ Just Fucking Google It]. If you have been sent here by someone from a forum after asking a question, chances are that the question you asked has either been answered a dozen times before, or the answer is totally obvious. Either way, please check if you did the following before asking your question:
  
=== 1. Reading the [[INIs]] ===
+
=== Read the INIs ===
What many newbies overlook is that the all the RA2/YR-INIs are written in plain English and 99% of the tags are commented. Questions like "How do I change a weapon's damage?" while there's a tag named "Damage=" directly on the weapon don't make it look like you invested much time to find the answer, or even tried to familiarize yourself with your future working environment.
+
What many newbies overlook is that all of the [[INI]]s are written in plain English and 99%{{fnl|1}} of the tags are commented. Questions like "How do I change a weapon's damage?" while there's a tag named {{f|Damage|link}} directly on the [[weapon]] doesn't make it look like you've invested much time to find the answer, or even tried to familiarize yourself with your future working environment.
  
=== 2. Reading the Guides ===
+
=== Search ModEnc ===
While there is no official modding-support of Westwood Studios or Electronic Arts, Inc., our fellow modders have compiled a two-parted suite of documents called the "INI-Guide". This prominent Guide was mostly written by DeeZire and his helpers, and explains almost every tag valid (and even some invalid ones) in the INIs. The second part is XGamer's Art.ini-Guide, which was missing from the original suite. Many questions can be answered by simply opening up the Guide(s) and searching for a keyword.<br>
+
The [[ModEnc:About|C&C Modding Encyclopedia]] grows every day and already includes answers to many common, modding problems, and often very detailed, specialized information on more advanced topics. In addition, users may update, add and improve articles if deemed necessary. The older [[RTFM|this page]] is, the higher the probability that ModEnc has the answers you seek.
DeeZire's INI-Guide can be downloaded [http://www.deezire.net/modules.php?name=Downloads&d_op=viewdownload&cid=1 here].<br>
 
XGamer's Art.ini-Guide can be downloaded [http://yrarg.cncguild.net/ here], in the Tutorials-section.
 
  
=== 3. Checking for Tutorials ===
+
=== Check for tutorials ===
Many community- and especially modding-sites include a big tutorials-section were most beginners' questions have already been answered. Things like "How do I add a new tank?" can be found there and are described in detail.
+
Many community sites, especially those that pertain to modding, host tutorials were most beginners' questions have already been answered. Things like "How do I add a new tank?" can be found there and are answered in detail.
One place to seek for such sites is ModEnc's very own [[ModEnc:Community_Portal|Community Portal]].
+
One place to find such sites is [[ModEnc:About|ModEnc]]'s very own [[ModEnc:Community_Portal|Community Portal]].
  
=== 4. Searching ModEnc ===
+
=== Read the guides ===
While it may still be in the beginning, the C&C Modding Encyclopedia grows every day and already includes answers to many common problems of modding, and often very detailed, specialized information on more advanced topics. In addition, you yourself can update, add and improve information if necessary. The older this page is when you get directed to it, the higher the possibility is that ModEnc has the answer you seek.
+
While there is no official modding-support of [[Westwood Studios]] or [[Electronic Arts]], Inc., our fellow modders have compiled a two-parted suite of documents known as [[The Guide]]. This prominent guide was mostly written by [[DeeZire]] and his helpers, and attempts to explain almost every tag valid&mdash;even some invalid ones&mdash;in the [[INI]]s. The second part is XGamer's Art.ini-Guide, which was missing from the original suite. Many questions can be answered by simply opening up the guides and searching for a keyword.
  
=== 5. Searching the Forum(s) ===
+
'''Please note that the vast majority of information in both guides has been placed on ModEnc, and that DZ's guide is growing more outdated every day.'''
 +
*[[:File:RA2YR INI Bible Pack.tar.gz|The Guide mirror at ModEnc]] (This package includes both Guides.)
 +
* [http://yrarg.cncguild.net/index.php?page=tutorials/tutorials XGamer's Art.ini-Guide] (This is just the Art Guide, look for "ART.INI Guide by XGamer" under "Modding".)
 +
 
 +
=== Search the forums ===
 
If all of the above failed, and people still sent you here, try searching the very forum you asked your question in. The prime example, the DeeZire-forums, currently has more than 22,000 posts in 1,500 topics in it's RA2/YR Editing Section. If you were sent here, the answer you seek is probably in the archive.
 
If all of the above failed, and people still sent you here, try searching the very forum you asked your question in. The prime example, the DeeZire-forums, currently has more than 22,000 posts in 1,500 topics in it's RA2/YR Editing Section. If you were sent here, the answer you seek is probably in the archive.
  
== Asking a Question ==
+
== Ask questions ==
 
While we're at it, let's take a look at your question:
 
While we're at it, let's take a look at your question:
 
In numerous cases, newbies don't get an answer not because there is none available, but because the question they asked was considered rude, dumb, annoying or even insulting by those who volunteered to help. So, before you post your question, make sure you got the following things right:
 
In numerous cases, newbies don't get an answer not because there is none available, but because the question they asked was considered rude, dumb, annoying or even insulting by those who volunteered to help. So, before you post your question, make sure you got the following things right:
  
=== Grammar, Punctuation and Spelling ===
+
=== Grammar, punctuation and spelling ===
At least half the community consists of people who speak English as a second, or even third language. In addition, most newbies are actually quite young. Therefore, we do not expect you to speak perfect English. What we do expect, however, is a basic check for text-correctness. Even if you didn't notice it while typing, you can be assured that one period for a paragraph of a hundred words is definately not enough. And even if  the sentence is that long, it probably should contain a lot of commas. In addition, check your spelling. While a casual "teh" once in a while is nothing serious, having a typo in every second word is not a pleasure to read for those you want to get help from. And if you're really unlucky, these typos prevent the helper from understanding your problem - which, in turn, means you won't get an answer.
+
At least half the community consists of people who speak English as a second or even third language. In addition, most newbies are actually quite young. Therefore, we do not expect you to speak perfect English. What we do expect, however, is a basic check for text-correctness. Even if you didn't notice it while typing, you can be assured that one period for a paragraph of a hundred words is definitely not enough. And even if  the sentence is that long, it probably should contain a lot of commas. Be sure to check your spelling as well. While a casual "teh" once in a while is nothing serious, having a typo in every second word is not a pleasure to read for those you want to get help from. And if you're really unlucky, these typos prevent the helper from understanding your problem; which, in turn, means you won't get an answer.
  
 
And don't you even ''dare'' writing in l33t-speak.
 
And don't you even ''dare'' writing in l33t-speak.
  
=== Rude Behaviour, Demands & Insults ===
+
=== Rude behaviour, demands, and insults ===
 
Never forget one thing: ''You'' want help from ''us''. Cursing your problem is one thing, but when you step over the line and piss off an oldbie, you can be sure you won't get nothing but flames. If you ask kindly, you will get a nice answer, be it what you wanted, the advice to search the forums or the link to this page. But if you treat us bad, we'll treat you worse. Promise.
 
Never forget one thing: ''You'' want help from ''us''. Cursing your problem is one thing, but when you step over the line and piss off an oldbie, you can be sure you won't get nothing but flames. If you ask kindly, you will get a nice answer, be it what you wanted, the advice to search the forums or the link to this page. But if you treat us bad, we'll treat you worse. Promise.
  
=== Your Problem/The Thread's Use ===
+
=== Clarity in explaining the problem ===
Make sure your thread not only serves a purpose, but people also understand what you want - this starts by picking a simple, straight to the point (not l33t, not excessive, not terror-caps) thread-title, and continues in the way you write your post: We are not Yuri. We cannot read minds. Make sure you write down the exact problem, how and when it occurs, what you did before it started, and what you already tried to solve it. Be prepared to post your code, if somebody asks for it.
+
Make sure your thread not only serves a purpose, but people also understand what you want. This starts by picking a simple, straight to the point (not l33t, not excessive, not terror-caps) thread-title, and continues in the way you write your post. We are not Yuri; We cannot read minds. Make sure you explain the problem in detail: How and when it occurs, what you did before it started, and what you already tried to solve it, are all useful for diagnosing an issue. Be prepared to post your code if it is requested, but do not copy and paste your entire {{ini|rules}} file in the post.
 
 
If you do not need help, but rather want opinions, want to offer something, or just want to advertise your (hopefully bug-free) mod, then please make this clear in your thread-title.
 
 
 
== Final Note ==
 
After reading all this, realize one thing: We did not write this down because we don't like you. We did not refer you here because we don't like you. We put this here because almost every obvious question in the community has been answered before, and we're sick and tired of still hearing the same questions again and again. This is not here to make you go away - this is here so we can concentrate on helping people who's answers can't be found somewhere else, and so we don't have to give out the same advice again and again and again.
 
  
If you have a serious problem with your mod, a coding-question you can't get answered or anything like that, you're very welcome to stop by and ask us for help. But please check if your question has already been answered ''first''. It saves you time, it saves us time, and it saves space in the database. ;)
+
If you do not need help, but rather want opinions, want to offer something, or just want to advertise your (hopefully bug-free) mod, then please make this clear in your thread-title.
  
 +
==Notes==
 +
{{fn|1|Did you know 72% of statistics are made up on the spot?}}
  
Thanks for your attention,<br>
+
[[Category:Miscellaneous]]
The RA2/YR Editing Community
 

Latest revision as of 10:39, 7 December 2009

"Use the f*cking search-button!"

Hi there. This is a page similar to Just Fucking Google It. If you have been sent here by someone from a forum after asking a question, chances are that the question you asked has either been answered a dozen times before, or the answer is totally obvious. Either way, please check if you did the following before asking your question:

Read the INIs

What many newbies overlook is that all of the INIs are written in plain English and 99%1 of the tags are commented. Questions like "How do I change a weapon's damage?" while there's a tag named Damage directly on the weapon doesn't make it look like you've invested much time to find the answer, or even tried to familiarize yourself with your future working environment.

Search ModEnc

The C&C Modding Encyclopedia grows every day and already includes answers to many common, modding problems, and often very detailed, specialized information on more advanced topics. In addition, users may update, add and improve articles if deemed necessary. The older this page is, the higher the probability that ModEnc has the answers you seek.

Check for tutorials

Many community sites, especially those that pertain to modding, host tutorials were most beginners' questions have already been answered. Things like "How do I add a new tank?" can be found there and are answered in detail. One place to find such sites is ModEnc's very own Community Portal.

Read the guides

While there is no official modding-support of Westwood Studios or Electronic Arts, Inc., our fellow modders have compiled a two-parted suite of documents known as The Guide. This prominent guide was mostly written by DeeZire and his helpers, and attempts to explain almost every tag valid—even some invalid ones—in the INIs. The second part is XGamer's Art.ini-Guide, which was missing from the original suite. Many questions can be answered by simply opening up the guides and searching for a keyword.

Please note that the vast majority of information in both guides has been placed on ModEnc, and that DZ's guide is growing more outdated every day.

Search the forums

If all of the above failed, and people still sent you here, try searching the very forum you asked your question in. The prime example, the DeeZire-forums, currently has more than 22,000 posts in 1,500 topics in it's RA2/YR Editing Section. If you were sent here, the answer you seek is probably in the archive.

Ask questions

While we're at it, let's take a look at your question: In numerous cases, newbies don't get an answer not because there is none available, but because the question they asked was considered rude, dumb, annoying or even insulting by those who volunteered to help. So, before you post your question, make sure you got the following things right:

Grammar, punctuation and spelling

At least half the community consists of people who speak English as a second or even third language. In addition, most newbies are actually quite young. Therefore, we do not expect you to speak perfect English. What we do expect, however, is a basic check for text-correctness. Even if you didn't notice it while typing, you can be assured that one period for a paragraph of a hundred words is definitely not enough. And even if the sentence is that long, it probably should contain a lot of commas. Be sure to check your spelling as well. While a casual "teh" once in a while is nothing serious, having a typo in every second word is not a pleasure to read for those you want to get help from. And if you're really unlucky, these typos prevent the helper from understanding your problem; which, in turn, means you won't get an answer.

And don't you even dare writing in l33t-speak.

Rude behaviour, demands, and insults

Never forget one thing: You want help from us. Cursing your problem is one thing, but when you step over the line and piss off an oldbie, you can be sure you won't get nothing but flames. If you ask kindly, you will get a nice answer, be it what you wanted, the advice to search the forums or the link to this page. But if you treat us bad, we'll treat you worse. Promise.

Clarity in explaining the problem

Make sure your thread not only serves a purpose, but people also understand what you want. This starts by picking a simple, straight to the point (not l33t, not excessive, not terror-caps) thread-title, and continues in the way you write your post. We are not Yuri; We cannot read minds. Make sure you explain the problem in detail: How and when it occurs, what you did before it started, and what you already tried to solve it, are all useful for diagnosing an issue. Be prepared to post your code if it is requested, but do not copy and paste your entire rules(md).ini file in the post.

If you do not need help, but rather want opinions, want to offer something, or just want to advertise your (hopefully bug-free) mod, then please make this clear in your thread-title.

Notes

1 Did you know 72% of statistics are made up on the spot?