Dutchman101

Guidelines and formatting for this section [READ BEFORE POSTING]

Recommended Posts

The Scripting Section is meant for asking on-topic scripting development questions. We have a set of rules and guidelines that take effect starting today (19/05/2017) as the amount of unwanted topics that do not match the section purpose is growing. There will be a 1-week cooldown period for the rules and guidelines to be completely enforced.


In order to post a topic in the Scripting section, the topic has to meet the following requirements:

  1. It must contain specific question(s) about either:
    • the code you will include that is problematic or you are asking direct support for, or
    • asking for help in finding the best approach to achieve something.
      • For example, asking more experienced scripters if there is a more efficient way of coding your desired script/function.
  2. The contents of the topic must focus around on-topic code support or coding methods (as explained above).
  3. It needs to follow the Formatting guidelines and Conduct guidelines listed below.


Just to clarify these rules, there is no room for any kind of:

  1. (resource) progress show-off,
  2. recruiting scripters, or
  3. polling interest or brainstorming on what kind of project you are up to next

All of the above things have their own categories to post them in. These categories are respectively:

  1. https://forum.mtasa.com/forum/87-resources/
  2. https://forum.mtasa.com/forum/149-looking-for-staff/
  3. https://forum.mtasa.com/forum/140-mta-chat/

If you still post such a topic in the Scripting section mistakenly, the first time it will get moved gracefully to the correct section. Any subsequent repeated mistakes may result in an instant deletion of your topic.

 

Formatting guidelines

- Tag your topics appropriately by using proper topic titles. Stick to the template as shown below:

  • [BUG] TOPIC_TITLE - for problematic code that will not work or has issues that you need assistance with.
    • This type of topic must always contain a code snippet of the script in question.
       
  • [QUESTION] TOPIC_TITLE - scripting questions, including (but possibly not limited to):
    • asking for help in understanding scripting principles, function or code usage, or
    • if you wonder whether your approach to achieve something is the most optimal and efficient one. We are all learning and aid from more experienced scripters can be useful.
       

- Use code snippet tags. Always add your code (if applicable) in this uniform way.

Click the ''< >'' shortcut in the text editor:

MSHAyJ3.png

Then put your code within the newly created box. Be sure to select Lua for highlighting from the drop-down list in bottom right corner for automatic syntax colouring, wiki links for built-in functions and events and other cool features.
Please do not use loose [ code] tags for the sake of readability.

- Do not mass-quote code snippets, or else it would fill up the whole topic with repeats of the same code over and over again. Remove the code column from a previous quote before posting or limit your own quote by narrowing down the parts of code you are replying about. Quote selectively.
 

Advice

Last but not least, please try to explain your issue or question the best way you can. A clean and detailed topic can increase the chance that someone will sit down to analyse your problem and actually help you. Clear communication and description is also the key to attracting scripters who may potentially take a look for you.

 

Conduct guidelines

- Treat everyone with respect, no matter their skill in scripting. If someone posts what you think is low level/''stupid'', remember that you have once been there as a novice scripter yourself and everyone should have a chance to learn.
Instead of resorting to humiliating replies, think about how hard it is to learn how to script efficiently, and dedicate yourself even more to help them understand it. You might play a noticeable role in someone's future as MTA scripter (or who knows, maybe an even more prominent role later on too). Long story short, avoid making remarks or rude comments aimed at someone's skill level, incapabilities, etc. It is not appreciated neither by us Moderators nor by regular users of the forums.
 

- The Scripting section is not meant for those unwilling to learn, whose only intent is to try get others to finish the scripts they need, line by line. We see this happening way too often -  someone with seemingly zero scripting skills does not react on-topic to the set of functions they can use that other users provide them, and does not seem to take any pushes in the right direction forward; they are just waiting for a collective effort from other scripters to develop what they want. This is what we do not want to see. 
It is not against the rules, but do not expect all the work to be done for you while you lean back. We tend to motivate you to raise up and at least try to script it by yourself, and the users on the Scripting board are generally happy to aid in every particular issue you come across while coding it. If you still try to let others move the work for you (almost) completely, do not be surprised when you are not getting that much of help from others.

In that context, if you see someone who keeps bumping their topic that is clearly oriented at letting his work be done by others, then please report the post.


- The bumping policy in scripting section is a bit different from other forum sections, because scripting topics serve as a sort of knownledge-base for those dealing with the same issue/question as described in existing topics. It is often suggested (and usual practise for many scripters) that prior to posting a new topic, someone searches the forums to see if their question has been asked/answerred before. Therefore, you may bump old topics if you're certain your approach or solution/code is better than other posted answers, and if it's a fairly common question (not someone just asking how to have their own code fixed or similar case-specific topics). However, we the moderating team may still review if your posts are really useful bumps with new insights, and even if so, we can lock the topic to prevent derailing of an old topic/continuous posts. So expect your useful bumps to possibly be the last ever made in a certain topic (which means if you do it, do it well). If you believe a popular topic for a really common scripting problem should be unlocked for you to post input, or you wish to improve upon someone's earlier bump after which it was locked, then please use the Report button referring to this part of the regulations.

- No support is offered for leaked code or scripts (even if they only partially originate from a leak) and such topics will be locked and trashed on sight. If you notice a topic where something related is being asked, or other clandestine requests (such as questions how to decompile scripts, etc, anything with not-so-noble intentions) then please report the topic and do not reply as it may incite unnecessary arguments. Mention the source proving that it is a leaked code within your report, though you can omit that if you feel that it is fairly obvious that the resource/script was leaked. In the latter case however, keep in mind that we may not be aware of such a leak, so the Moderator who handles your report will have to take his judgement upon it if you do not provide evidence.

Still, keep in mind that you should not openly accuse users who post pieces of your (or someone else's) code as per https://forum.mtasa.com/topic/46410-stolen-resource-accusations/. If this happens, simply report such posts.

 

Failure to abide by the Conduct guidelines may result in a forum punishment. We ask anyone who notices a breach of the Conduct guidelines to report said offending post - it just takes a few seconds, yet it greatly benefits the Section and makes it a better place to seek help from.

  • Like 6
  • Thanks 1

Share this post


Link to post

Unlike the last time it was hidden to work on the post, today these regulations really take effect.

As written in main post, there's a 1-week cooldown period in which we won't enforce most regulations listed here, but only politely warn users breaking them. This is to let everyone adapt and get used to the regulations & guidelines.

  • Like 1

Share this post


Link to post

Finally something is being done about this. Since a few weeks ago, whenever I joined the scripting section there were pages (and no I'm not overreacting) filled with random questions, barely understandable text (there are language specific sub-forums so that's no excuse) and zero information on what the problem is, nor an effort from the poster's part. All that just made me close the tab and ignore all posts despite my original will to read a few topics and try to help. Hopefully these new rules would be obeyed.

Share this post


Link to post

Hello, @Dutchman101.

Is it possible to add a link to the debugging tutorial?

There are a lot of questions which could be solved just by reading it, and it would prevent a lot of questions that are related to some kind of syntax errors.

Edited by Pirulax

Share this post


Link to post

Yet no new guys seem to use code snippets now... xD

Maybe add some kind of detection for code and if it's there, like a function...  Then it'd make a popup suggesting the code snippet button?

Share this post


Link to post

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.