Difference between revisions of "Autopilot/Avignon"

From #openttdcoop wiki

Jump to: navigation, search
(Basic Layout of Avignon's help page)
 
(Configuration: the alpha release is quie old and might be very buggy...)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{beta}}
 
==Avignon==
 
==Avignon==
Avignon is an advanced re-write of [[ap+]] which is easily extendable with plugins.
+
Avignon is an ground-up re-write of [[ap+]] with an emphasis on being modular.
  
==Basic Usage==
+
It is available from [http://www.codecubes.org CodeCubes].<br />
First of all, checkout the source from the trunk repo.
+
<pre>svn co http://svn.codecubes.org/avignon/trunk/ avignon</pre>
+
  
This will checkout the source to ''./avignon/''
+
== Configuration ==
  
Once you have that set up, configure Avignon with ''default.ini'' located in ''./config''.
+
Checkout via
 +
svn co http://svn.codecubes.org/avignon/trunk
  
To connect your bot to IRC, make sure you have set all the settings in [irc], and type "connect".
+
Once you have a checkout, configuration of Avignon is handled by making a copy of ''config/default.ini'' to ''config/user.ini''
  
==Starting a Server OpenTTD==
+
=== [IRC] ===
To start a server, make sure you have all necesarry OpenTTD binaries in ''./avignon/openttd/''
+
important settings are
Then, load the OpenTTD module
+
* auto.connect = no<br />
 +
set this to yes, to avoid having to make it connect everytime (you may want to leave this on 'no' till you have everything set)
 +
* network.host = HOSTNAME
 +
* network.pass =
 +
* network.port = 6667
 +
* nick = NICKNAME
 +
* nick.alternatives = NICKNAME2 NICKNAME3
 +
* channels = #CHANNEL #CHANNEL2
 +
* channels.key.#CHANNEL = PASSWORD
 +
* nickserv = NICKSERV IDENTIFY {password}<br />
 +
These should be straightforward enough
 +
* command.char = !<br />
 +
trigger character for the bot on IRC
 +
 
 +
=== [plugins] ===
 +
* load = Alias DemoPlugin<br />
 +
Sets the plugins loaded on startup
 +
* prefer.irc.COMMAND = PLUGIN<br />
 +
if there are multiple versions of a command this sets the default plugin used.<br />
 +
i.e. 'version' is in both Avignon and OpenTTD
 +
 
 +
== Starting a Server OpenTTD ==
 +
 
 +
The OpenTTD app is subject to rapid change, see [http://www.codecubes.org/browser/avignon/trunk/extensions/apps/OpenTTD/readme.txt readme.txt] for lastest info
 +
 
 +
The following was correct at time of writing (07 March 2010).
 +
 
 +
To load issue
 
<code>load OpenTTD</code>
 
<code>load OpenTTD</code>
Alternatively, you can auto-load the plugin on startup, just set it in the config:
+
if not alread loaded by default. (see [[#.5Bplugins.5D|[plugins]]])
<pre>[plugins]
+
 
...
+
The OpenTTD app, looks for an openttd install in ./openttd relative to avignon.tcl
load = Alias DemoPlugin
+
<code>openttd start</code>
load = OpenTTD</pre>
+
will start the OpenTTD server.
 +
<code>openttd load [savegame_here.sav]</code>
 +
will load a game. There is no need to give the ''save/savegame.sav'' path, as the app assumes saves are in save.<br />
 +
<b>!</b>Though currently, loading anything other than game.sav sends a bad command and may fail to load
 +
 
 +
OpenTTD's app has a few settings, the default will normally suffice, but can be overridden by adding a new section to the user.ini
 +
 
 +
=== [OpenTTD] ===
 +
Th defaults should be fine, but you may like to tweak;
 +
* irc.bridge = <#irc_channel><br />
 +
This is probably the one you want to attck first, the #channel should already be joined by setting it in the [[#.5BIRC.5D|[irc]]] section.
 +
* password.randomize = <yes>|<no><br />
 +
Do you want to enable password randomzing (default: no)
 +
* password.file = <path/to/file>
 +
The file storing passwords; one word per line (default: ./extensions/apps/OpenTTD/words6)
 +
* password.frequency = <int><br />
 +
Frequency of password change in seconds (default: 300)

Latest revision as of 20:32, 7 March 2010

Avignon

Avignon is an ground-up re-write of ap+ with an emphasis on being modular.

It is available from CodeCubes.

Configuration

Checkout via

svn co http://svn.codecubes.org/avignon/trunk

Once you have a checkout, configuration of Avignon is handled by making a copy of config/default.ini to config/user.ini

[IRC]

important settings are

  • auto.connect = no

set this to yes, to avoid having to make it connect everytime (you may want to leave this on 'no' till you have everything set)

  • network.host = HOSTNAME
  • network.pass =
  • network.port = 6667
  • nick = NICKNAME
  • nick.alternatives = NICKNAME2 NICKNAME3
  • channels = #CHANNEL #CHANNEL2
  • channels.key.#CHANNEL = PASSWORD
  • nickserv = NICKSERV IDENTIFY {password}

These should be straightforward enough

  • command.char = !

trigger character for the bot on IRC

[plugins]

  • load = Alias DemoPlugin

Sets the plugins loaded on startup

  • prefer.irc.COMMAND = PLUGIN

if there are multiple versions of a command this sets the default plugin used.
i.e. 'version' is in both Avignon and OpenTTD

Starting a Server OpenTTD

The OpenTTD app is subject to rapid change, see readme.txt for lastest info

The following was correct at time of writing (07 March 2010).

To load issue load OpenTTD if not alread loaded by default. (see [plugins])

The OpenTTD app, looks for an openttd install in ./openttd relative to avignon.tcl openttd start will start the OpenTTD server. openttd load [savegame_here.sav] will load a game. There is no need to give the save/savegame.sav path, as the app assumes saves are in save.
!Though currently, loading anything other than game.sav sends a bad command and may fail to load

OpenTTD's app has a few settings, the default will normally suffice, but can be overridden by adding a new section to the user.ini

[OpenTTD]

Th defaults should be fine, but you may like to tweak;

  • irc.bridge = <#irc_channel>

This is probably the one you want to attck first, the #channel should already be joined by setting it in the [irc] section.

  • password.randomize = <yes>|<no>

Do you want to enable password randomzing (default: no)

  • password.file = <path/to/file>

The file storing passwords; one word per line (default: ./extensions/apps/OpenTTD/words6)

  • password.frequency = <int>

Frequency of password change in seconds (default: 300)

Powered by MediaWiki
  • This page was last modified on 7 March 2010, at 20:32.