OSBot's API is one of the most bare-bones collections of information I've ever seen. Add to this the fact that many beginning scripters try to get into Java through scripting, and you've got a nightmare when introducing the concept to new OSBot users. This, in turn, allows the script market to dwindle, which leads to less and less community activity. 

 

Also, there would be far fewer "how do I..." threads in the scripting questions/errors section(s) if we had more documention.

 

TL;DR: 

If we want to generate activity within OSBot, we need to provide resources for scripters.

 

 

 

Well could you provide specific examples? I've been personally overhauling the API over the last month. Do people need a skeleton/tutorial?

I think people need tutorial like:

 

1. Script skeleton.

2. Walking.

3. Interacting.

4. Banking.

5. Talking.

6. Questing (configs + talking + items).

7. Simple antiban.

8. Web-walking.

9. Grinding monsters.

10. Woodcutting.

11. ...

 

Many simple scripts with description what every line do and why use exactly this function but not other similar.

Written in pretty good style.

And keep those examples up-to-date with API changes.

Well could you provide specific examples? I've been personally overhauling the API over the last month. Do people need a skeleton/tutorial?

 

I wasn't aware that any work was currently being done to improve it, in that case I appreciate it a lot

 

As an example of what I was talking about, let's take a look at http://osbot.org/api/org/osbot/rs07/api/model/Model.html#finalise()

 

 

The only information given is that it's a method:

 

 

 

finalise() - Method in class org.osbot.rs07.api.model.Model

 

Now, here's where it begins to be a problem. As a relatively novice scripter, I have no idea 

 

1) what this method does

2) whether or not using this in some way would improve the efficiency of my script

3) whether or not it should be used it at all

 

 

So, let's assume it serves no real purpose to the highest-level (in terms of code, not skill) scripters. In that case, it would be incredibly helpful to have even just a little blurb that says,

 

 

This method does nothing at the level of scripting, ignore it

Now, as an alternate, let's assume finalise() does something along the lines of forces the current cycle to complete (I'm just making this up for the sake of the example). This use of the method should be identified, as well as appropriate usage of it, i.e.

 

The finalise() method is used to force the current cycle/loop to complete, regardless of [x,y,z conditions]. Use this to [prevent bad stuff/save the world]. 

Basically, just a more in-depth look at methods would help struggling scripters a lot.

Edited September 18, 201411 yr by adc

Nearly all methods that we are supposed to use are documented

Certain methods are also deprecated for internal use only. This means that although as a scripter you can access certain methods, you shouldn't use them. I think I will release a skeleton soon with some basic methods after version 2.2.28 when I release the new path walking.

The API has been getting more and more scripter-friendly as of lately.

For simple code most of the classes and methods seem quite straightforward, for more advanced code you currently have to experiment a bit, which is fun, but time consuming and sometimes a pain, there's still a lot of room for improvement.

 

This is in no way a priority though, it's clear enough as it is for most scipters.

Once the API is actually close to perfect (you're getting there Alek ) only then should thisx be worked on imho.

 

 

I've already planned on adding support for new languages like JavaScript for example which will make scripting with the API easier as well as lower the entry-level barrier into script programming. Languages like those are also in high-demand as they're used for web programming and more. I'm planning a lot of things specifically for 2.3 and 2.4.

I've already planned on adding support for new languages like JavaScript for example which will make scripting with the API easier as well as lower the entry-level barrier into script programming. Languages like those are also in high-demand as they're used for web programming and more. I'm planning a lot of things specifically for 2.3 and 2.4.

 

 

OH BABY

Added three tutorials:

http://osbot.org/forum/forum/250-tutorials/

 

Also check out the newest updates:

http://osbot.org/forum/topic/59408-whats-new-osbot-api-developer-log-version-2228/

I think people need tutorial like:

 

1. Script skeleton.

2. Walking.

3. Interacting.

4. Banking.

5. Talking.

6. Questing (configs + talking + items).

7. Simple antiban.

8. Web-walking.

9. Grinding monsters.

10. Woodcutting.

11. ...

 

Many simple scripts with description what every line do and why use exactly this function but not other similar.

Written in pretty good style.

And keep those examples up-to-date with API changes.

fuck no, people need complex antiban lol