Ultimate Help Guide

[Gildarts]

Ultimate Help Guide

I get way too many people in the chatbox asking for help on problems and client issues that have I have just resolved, so I've decided to make a guide it.

I will spoiler all of the fixes in order to make it easier to find the section you are looking for.

P.S: If I get HTML permissions on this thread from an administrator, I will make an actual jumptable from the table of contents.

 

Table of Contents:

I. Client

  i. Downloading

  ii. Scripts

    1. Adding SDN scripts

    2. Adding local scripts

    3. Running SDN scripts

    4. Running local scripts

    5. Troubleshooting script issues

      a. Script doesn't appear in client after purchasing

      b. Local scripts is empty, although scripts are in the folder.

  iii. Troubleshooting errors

   Preface: Things to make sure of before reading further

    1. Not injecting/downloading client

    2. Error loading settings

    3. Not being able to sign in/freezing on sign in

    4. Blank gray window

    5. JAR is corrupted

    6. Failed to load client

    7. Broken randoms

    8. Client not downloading

    9. Failed to connect to remote server

    10. Not being able to add accounts

    12. General fixes to try if none of the above work

II. Forum

  i. Payments

    1. Subscription Cancellation

  ii. BB Code

    1. Linking members

    2. Spoilers

  iii. Miscellaneous

   1. Styling

III. Scripting

  i. Importing OSBot

  ii. Using a skeleton

 

I. Client

  i. Downloading and running

• To download the client, simply go to OSBot's home page and scroll to the bottom and click "Download". It will look like this: This will download the latest version of OSBot.
• Alternatively, if the previous method is not working, you can use the direct download link by clicking here.
• If you are prompted to "Save" or "Run", select "Save".
• Once osbot x.x.x.jar has finished downloading (it will not show a progress bar but it will be finished at about 13.3mb), it will be located in C:\Users\yourusername\Downloads (or your default downloads folder) listed as osbot 1.x.x (number of the latest version). This is the program, or client, that is used to run scripts (bots).
• Then, for easier access, you can either move that file to your desktop, or right click the file and choose Send To > Desktop (create shortcut).

Running the client:

IMPORTANT: To run the client, you will need the latest version of Java.

• Simply sign in with your Forum account by clicking the button on the top right that says signed out ().
• Then, to start up Runescape, add a new game tab by clicking the green plus button ().
• In a few moments, Runescape should be loaded up and ready for botting!

 

ii. Scripts

    1. Adding SDN (store) scripts

• Scripts from the store can be found here.
• Find the script you would like to add to your account, and then click the name or picture of it. If the price is $0.00, (like this: ) then the script is free. If not, you will need to pay with PayPal or a credit/debit card.
• Then, when you have found a script you would like to add, click add to cart () and then checkout () on the bottom right.
• Finally, agree to the Terms and conditions and then confirm the order ().
• You will be taken to a page that says the following on it:
• This means that the script has been added to your account.
  
  NO DOWNLOAD IS NECESSARY FOR SDN SCRIPTS!

 

    2. Adding local scripts

Local scripts are scripts that are not featured and are not in the store. They can be found here.

There are 3 types of local scripts:

1. A .jar file

For a jar file, after you have downloaded it (if it prompts to "Run" or "Save", select "Save"), move it into your OSBot folder located at C:\Users\yourusername\OSBot\scripts.

If you do not know how to do this, no need to fear.

For Windows 7/Vista users:

• Open the start menu, type run, and hit enter.
• Then type %userprofile%\Downloads into the text box that appears.
  

• Open run again (keep the Downloads window open), but this time type %userprofile%\OSBot\scripts into the text box that appears.
• Now, drag the script you downloaded (will be scriptname.jar) from your Downloads window into your scripts window.

 

For Windows XP users:

• Hold down the windows key () and press r. This will open Run.
• Now type %userprofile%\Downloads into the text box that appears.
  

• Open run again (keep the Downloads window open), but this time type %userprofile%\OSBot\scripts into the text box that appears.
• Now, drag the script you downloaded (will be scriptname.jar) from your Downloads window into your scripts window.

 

2. A .zip file

• For a zip file, if it prompts to "Save" or "Run", choose "Run". (if it does not give this option then go into your downloads folder and run it)
• It should then open with your default zip extractor (Windows Explorer, 7zip, WinRar, etc.).
• Extract the files inside directly into C:\Users\yourusername\OSBot\scripts
• If you are using Windows Explorer, use "Extract all files" () towards the top left of the window.
• 7zip users should use this button:

 

3. Plain text (code)

For plain text, like this:

public class SherlockC extends Script {
public void onStart() {
     }
}

• Simply copy all of the text in the box by highlighting it all and then right clicking it > Copy.  
• Then, open your Start menu > All programs > Accessories > Notepad.
• Once notepad is open, paste the code in the notepad file by right clicking in it > Paste. 
• Then, go to file on the top right > Save As...
• Now, before you give a name to the Java file, first go to the bottom drop down box and select "All files". ()
• Next, save it as whatever was specified in the thread (will usually be the name of the bot) and then add .java immediately at the end of it.

For example, if my script that I was saving was called SherlockC, I would write this:

And finally, browse to C:\Users\yourusername\OSBot\scripts in the save window and hit save.

 

    3. Running SDN scripts

• The SDN scripts are already on your account and within the client after your order is confirmed.
• You can find then by clicking the green play button () when you are ready to run them and then going under the tab "Premium scripts" or "Free scripts" ().
• Next, hit refresh on the bottom left () and then the script you added should show up.
• Click the one you want to run and the script should start running.

 

  4. Running local scripts

• To run the local scripts, go into your client and sign in with your Forum account (if it doesn't automatically sign you in).
• Open a new game tab (), and then log in to Runescape.
• When you are ready to run the script/bot, go to the green play button on the top left () and then go under the tab "Local Scripts" ().
• Hit refresh () which is towards the bottom left.
• Your local scripts should show up, so select which one you wanted to run, and hit start () located towards the bottom right of the window.

  

   5. Troubleshooting scripts

      a. Script doesn't appear in client after purchasing

To fix this issue, simply sign out of your Forum account within the client and then sign back in and try.

If that doesn't work, restart the client.

If you are having persisting problems regarding this, contact @Raflesia, @Smart, or @Catastrophe.

      b. Local scripts is empty, although scripts are in the folder

This means that one of your scripts is corrupted, and messing up the other scripts in the folder.

Delete your scripts one-by-one, starting with the newest ones you added.

 

iii. Troubleshooting errors

   Preface: Things to make sure of before reading further

Make sure you have the latest version of Java as well as the latest version of OSBot.

    1. Not injecting/downloading client

This is a newer error, brought upon by a recent RS update.

To fix this, simply let the client sit for a while.

If it's been 10 minutes or more, then restart the client or close the current tab and then open a new one.

    2. Error loading settings

This error is easily fixable.

All you have to do is browse to C:\Users\yourusername\OSBot\data and then delete the file local.dat.

    3. Not being able to sign in/freezing on sign in

This error is generally caused by having an outdated version of Java.

Check to see if you have the latest version here.

If the above does not work, then you may need JDK.

    4. Blank gray window

This error is caused by not having the latest version of Java.

Get it here.

    5. JAR is corrupted

This was fixed for some people by getting JDK and then redownloading the client, but others claimed that it was not fixed by that.

You can get JDK here and redownload the client here.

    6. Failed to load client

For the error: Failed to load client!

It is a clashing error, so delete your OSBot folder located at C:\Users\yourusername\OSBot and then redownload the client.

Back up your local scripts if you have any by moving them to a temporary folder and then moving them back when the folder is recreated.

    7. Broken randoms

Broken randoms are not a problem on your end.

You will need to make a post on the Forums (here) and wait for the development team to fix the randoms in newer client releases.

    8. Client not downloading

This can be a tricky error.

First, try a different browser. (Firefox is a good choice if you don't already have it)

If that does not work, then disable any anti-virus or network blockers you have for about 15 minutes when downloading the client.

They can often block the connection to OSBot, resulting in a failed download.

     9. Failed to connect to remote server

This error is caused by something blocking a connection to the OSBot servers.

Try disabling any program you have that blocks connections (anti-virus included) as well as running of a new IP.

Port forwarding might help.

     10. Not being able to add accounts

Something is corrupted in your OSBot folder, so delete the folder at C:\Users\yourusername\OSBot.

Then redownload the client here.

     11. General fixes to try if none of the above work

For some general fixes that will fix most client problems, try the following in order:

1. Make sure your client is up to date. Find the latest version here.
2. Make sure your Java is up to date. It is here.
3. Download and install JDK here.
4. Delete your OSBot folder located at C:\Users\yourusername\OSBot and then redownload the client. Backup any local scripts by moving them to a temporary folder and then moving them back when the folder is recreated.
5. Report the problem to this Forum section, and the community will help you with the problem.

 

II. Forum

  i. Payments

    1. Subscription cancellation

FULL credits to for this:

• Open your client area.   http://osbot.org/forum/index.php?app=nexus&module=clients .
• Go to 'purchases'.
• Search for your whatever purchase you wanted to cancel and click on it.
• On the right there is a 'cancel' button. Click on it. It will cancel your subscription, meaning that your subscription won't renew itself.

 

  ii. BB Code

    1. Linking members

To @Link members on the forum like so, use the following code:

[member='name']

    2. Spoilers

To create a spoiler on the Forum, use the following code:

[spoiler]Text here[/spoiler]

Spoilception

    3. YouTube Videos

To embed a YouTube video into your post, simply paste the link like this: (I am aware this is not BBCode)

http://www.youtube.com/watch?v=o-99pXoawt8

Then, it will appear on the Forum like this:

http://www.youtube.com/watch?v=o-99pXoawt8

  iii. Miscellaneous

    1. Styling

To add different styles and colors to tweak your theme, you will need to be using the "Subway" theme.

• To choose a theme (either Subway or Animate), scroll to the very bottom and towards the bottom left is a button that says "Change Theme" ().
• Once you click Subway, you should get a tile bar looking similar to this:

• Next, click the "Edit Style" tile.
• Now, it should bring up a wide variety of editing options.
• Pick and choose from them to tweak your theme to your liking.
  Some of my favorite combinations:
  
  Chocolate, Slate, Waves:
  Marble, Chocolate, Squares :
  And of course: (Marble, Red, Wood)
  

 

III. Scripting

  i. Importing OSBot (using Eclipse)

To import OSBot (using Eclipse) to gain access to the API's functions, follow the following steps.

• Create a new Java Project, name it, and then click "Next >" (NOT "Finish").
• Now, go under the tab "Libraries" () and go to "Add External JARs..." ().
• Then browse to the latest version of OSBot you downloaded () and add it to the build path by selecting "Open". ()
• Finally, hit "Finish" () and you are all ready to use the API from OSBot!

 

  ii. Using a skeleton

To use a skeleton for beginning scripts, use the following: (FULL credits to @Divine for this, original thread here)

import java.awt.image.BufferedImage;
import javax.imageio.ImageIO;

import org.osbot.script.Script;
import org.osbot.script.ScriptManifest;

@ScriptManifest(name = "Script Name", author = "Author", version = 1.0D, info = "Description goes here.")
public class ClassName extends Script {

	/*
	 * Variables
	 */

	private BufferedImage paint;
	private long startTime;

	/*
	 * Inherited Methods
	 */

	// Called at start
	public void onStart() {
		try {
			startTime = System.currentTimeMillis();
			this.paint = ImageIO.read(new URL("IMAGE URL GOES HERE."));
		} catch (Exception e) {
			// Catch
		}
	}

	// Called more than once.
	public int onLoop() {
		try {

		} catch (Exception e) {
			// Catch
		}
		return 1;
	}

	// Called at script stop
	public void onExit() {

	}

	// Called more than once, even during pause.
	public void onPaint(java.awt.Graphics g) {
		if (paint != null)
			g.drawImage(paint, 0, 0, null); //0,0 = X,Y
	}

	/*
	 * Non-Inherited Methods
	 */
	
	//Non-Inherited methods go here.

	/*
	 * Useful Methods
	 */

	//XP for level
	public int getXPForLevel(int level) {
		int points = 0;
		int output = 0;
		for (int lvl = 1; lvl <= level; lvl++) {
			points += Math.floor((double) lvl + 300.0
					* Math.pow(2.0, (double) lvl / 7.0));
			if (lvl >= level)
				return output;
			output = (int) Math.floor(points / 4);
		}
		return 0;
	}

}

 

I am aware that these are not all of the client problems.

I will build onto this guide as well as add more pictures and further detail when I get the time.

If you have any questions, errors, or things to add onto this list you can PM me on the Forums, find me in the chatbox, or post on this thread.

Hope this helps!

 

-@Sherlock

 

Edit log:

9/2/13: Added more client problem resolving (9, 10), added styling, added colors, removed things that didn't sound smooth, added bulletpointing in more places, double-checked capitalization and caught & fixed some errors

Edited September 2, 2013 by Sherlock

[Catastrophe]

Ahhhh excellent thread, well done

[Jeff]

Very big guide. A lot of words! thanks 

[Travis Scott]

Well done Sherlock. You help me a lot!

 

#Sherlock4Mod

[Baller]

Very nice there are a lot of things I didn't know how to do, Thank you

[ScorpioZ]

Very nice but....

[Wu Tang Cummins]

Magnificent guide, Matt.  Awesome,

[Cory]

very nice

[Sex]

Very Helpful.

[BotRS123]

Holy shit... this is one long tutorial. Nice to see you using spoiler tags instead of letting it all out in the open.

[Led Zeppelin]

Woah so much info, good job!

 

 

 

sherlock4mod

[Zappa]

#SHERLOCK4MOD

[Anne]

Awesome thread , I love that my name is on there :p

[Kittens]

thanks sherlock! good work as always man sherlock for global

[beastlymaul]

This thread is awesome