Skip to content
This repository has been archived by the owner on Mar 30, 2019. It is now read-only.

Usage guide

Tom Crane edited this page Sep 8, 2017 · 2 revisions

Usage guide

This page is designed to provide a more in depth view of some of the settings available and other tips on using the bot, rather than instructions.

For installation instructions, a basic usage guide and an overview of the settings, see the README.

Bot Commands

The bot has some commands which can be used to get the bot started and edit some of the settings.

All commands

  • /bind
  • /start
  • /gui
  • /famebot set <option>

/bind

This binds the bot to the flash player. The bot will automatically attempt this, but if it fails then you must use this command before you can start the bot.

/start

This starts the bot. This can be used to start the bot if you are not using the GUI. Otherwise you can just press the Start button on the GUI.

Note that there is no /stop command. While the bot is in use, opening the chat will cause the bot to type letters to the chat, so it is impossible to type any commands.

/gui

This is currently not working

This can be used to open the GUI.

/famebot set <option>

This can be used to change the settings of the bot without having to directly edit the config file.

The currently supported options are

  • /famebot set realmposition This changes the position the bot will go to when it is trying to go towards the realms. This should be used any time the Nexus is changed and the bot no longer goes to the right place.
  • /famebot set fountainposition This changes the position the bot will go to when it is trying to go to the fountains to heal. This should be used any time the Nexus is changed and the bot no longer goes to the right place.

Customising the settings

The bot has many settings which can be customised and affect how the bot behaves and how the clustering algorithm searches for clusters.

Bot settings

Follow distance will make the biggest impact on how the bot behaves. This is the maximum distance in game tiles the bot can be from its target position before it will try to move closer to the target position.

It is worth knowing that the target position is the average position of all players in the cluster. The bot will never intentionally 'ghost' specific players in a cluster. The smaller the cluster, the more significant the impact each player in that cluster will have on the target position. Because of this, it is better to use a larger follow distance when following small clusters.

Cluster settings

Max distance between points and Minimum players per cluster are the settings which affect how the clustering algorithm looks for clusters. It is easy to mistake the two settings as being inversely related, but this is only true when only looking at the empirical effectiveness of the bot.

Because of the nature of the game there is no real 'best value' for these settings. Understanding how each setting affects the bot and changing the settings according to the situation is the best way to increase effectiveness of the bot. It is worth knowing that the bot always chooses the cluster with the most players. (Note: Find clusters near centre filters out clusters which are more than a certain distance away from the centre of the map)

Increasing the max distance between points will allow the bot to find clusters of players which are spaced further apart. The effect of this is that the bot might find more clusters, but in clusters where the players are further apart the rate of fame gain is likely to be lower.

Decreasing the minimum players per cluster will allow the bot to find smaller clusters. This can result in the bot targeting clusters which are too small to be effective, or even just a few players which are passing by each other.

If the bot is not finding many clusters, it is generally better to decrease minimum players per cluster before increasing max distance between points.