57
edits
Robonaut: Difference between revisions
From London Hackspace Wiki
no edit summary
(Updated robonaut information to reflect chomsky and not babbage.) |
No edit summary |
||
| Line 1: | Line 1: | ||
'''[ | '''[https://github.com/londonhackspace/irccat]''' is now in the progress of being migrated to [[Lamarr#Chomsky|Chomsky]], to help link [[IRC]] to things happening in the space. The documentation below reflects the refreshed instance on [[Lamarr#Chomsky|Chomsky]]. | ||
== Contributing commands == | |||
During the migration to [[Lamarr#Chomsky|Chomsky]] we decided to overhaul the command system to make it more flexible and maintainable. We have introduced '''breaking''' changes, so it is important to upgrade your scripts. | |||
=== Persistent commands === | |||
We (the maintainers) of Robonaut maintain a supervised set of persistent commands on [https://github.com/londonhackspace/irccat-commands]. If one wants to add a command to the persistent set of commands, one would need to fork this repository and issue a pull request so we can safeguard the quality of essential and commonly used commands. Each revision will have to go through this process. | |||
=== Contributed commands === | |||
Users can create commands for Robonaut in the <code>/opt/irccat/irccat-commands-contrib</code> directory. No guarantee will be provided on the availability of these commands, and if the system needs to be migrated in the future, we will potentially discard the commands in this folder. This would be a great location for temporary and/or fun commands, or to test your own commands before committing them to the main command set. | |||
=== Write access === | |||
One of the major changes to Robonaut compared to the old instance running on babbage is that write access to the persistent commands directory is prohibited, and that all data should be written to <code>/opt/irccat/irccat-data</code>. While it would also be possible to write to <code>/opt/irccat/irccat-commands-contrib</code>, this would be a very bad idea since this would prevent you from promoting your command to a persistent command. All commands writing outside of the <code>/opt/irccat/irccat-data</code> will be rejected, as well as commands which don't perform proper input filtering and thus offer an opportunity to write outside this directory. | |||
== Starting Robonaut == | == Starting Robonaut == | ||
| Line 114: | Line 128: | ||
*morning - plays the first few seconds of [http://www.youtube.com/watch?v=PAbwMGZtIsY Edvard Grieg - Morning Mood], and cycles the light through dawny colours, and sets the board to say "Good Morning, hackspace" | *morning - plays the first few seconds of [http://www.youtube.com/watch?v=PAbwMGZtIsY Edvard Grieg - Morning Mood], and cycles the light through dawny colours, and sets the board to say "Good Morning, hackspace" | ||
*patriot - initiates enforced patriotism mode | *patriot - initiates enforced patriotism mode | ||
== Important Paths == | |||
* Data directory: <code>/opt/irccat/irccat-data</code> | |||
* Contributed scripts directory: <code>/opt/irccat/irccat-commands-contrib</code> | |||
* Persistent scripts directory: <code>/opt/irccat/irccat-commands</code> | |||
* IRCcat installation directory: <code>/opt/irccat/irccat-bin</code> | |||
=== Proposed commands to be implemented soon === | === Proposed commands to be implemented soon === | ||
