This Tutorial shows a few things:
1. How to make a good Tutorial.
2. Basics of Conventions.
3. The "Brackets"(braces).
Purpose: This is to inform people that it is not hard to make a "tut'
Difficulty: 0/10
Assumed Knowledge: How to read and understand.
Step One:
When you are getting ready to make a post make sure that you start off with the Guideline:
Purpose: What will this tutorial accomplish?
Difficulty: On a 0-10 scale
Assumed Knowledge: What you must know to do this.
Tested On: So and So.
Modified Classes: classes here
Proof: Photo proof is totally optional, and not needed, but provides the reader with a better idea of the outcome.
This will help the readers of the Tutorial know before hand what they have to know, and what classes of their server need to be modified.
Step Two:
The second step in a Tutorial would be the information, Please provide good, tested information, as most people will want to learn something that works, Don't post something that you have no idea if it will work or not, that is no good to anyone. Also remember to provide an explanation of your work, it will help people further understand what you are talking about.
Example Tutorial alot of you need!
Conventions!
Purpose: To clean up your work and make it easier to read.
Difficulty: 1/10
Assumed Knowledge: Basic Java understanding.
Modified Classes: Every bad written class you have.
Step one:
This is a basic Tutorial that alot of Rune-Server needs to understand. if you ask yourself "What are conventions?" Conventions are greatly explained at this link.
Conventions by java.sun
Conventions by csse
Before I show you bad and good Conventions, what is a convention?
Answer:
Conventions are a way to improve your code to make it more readable for someone to have a clear idea at what the software(or in our case game) will do, before running it. it will be faster to read, make it alot clearer for people to understand.
All codes will be improved, or looked at. for someone to edit it, improve it, or learn form it, we use conventions to make it easier to do this. without conventions Program languages would take along time to understand, and also the brackets, you wouldn't get a good idea of what code is in which method.
if you made a sample class file to read something to you in the Command Prompt then this is a bad one:
Code:
public class Test {
public static void main(String args[]) {
System.out.println("Bad Convention!");
}
}
While a good well done convention
Code:
public class Test {
public static void main(String args[]) {
System.out.println("Good Convention");
}
}
Which one would you rather look at?
This is a good site for some basic info on What the "Brackets" are and why and when to use them.
Braces, basic information on them
The "brackets" we use { and } are not called 'Brackets' they are commonly known as 'Curly Brackets', 'Brace Brackets', or just 'Braces'
If you are using them on an if statement then you may use no Braces, but most experts recommend you to use them anyways
Code:
// Legal, but dangerous.
if (condition)
Exactly one statement to execute if condition is true
else
Exactly one statement to execute if condition is false
(code credits to the maker form the link above code)
RECOMMENDED PROGRAMS TO US FOR PROGRAMMING
NotePad++ (5.2)
Eclipse
I hope this is helpful to some, and Please do not spam or flame this thread. it's more or less for the ones that do not know.