Skip to content

jadegraaf/Spock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

#Spock A PHP based IRC echo bot for the Starmade server

###Introduction Spock intergrates a Starmade server with IRC (Internet Relay Chat). It broadcasts various events to an channel and allows crewmembers to administrate the server without having to be ingame.

###Features

  • Broadcasting of ingame chat, join and part messages
  • A punishment system that keeps track of all previous offences
  • Various commands to make your life easier. The full list is in the wiki

Instalation

Requirements

  • A Linux based operating system
  • The ability to start php scripts from shell
  • FTP/SFTP access to the server
  • A copy of the Nuwani IRC Platform. thrunk is recommended.
  • A Starmade server being run inside a screen

Bringing Spock alive, Step by step

  1. Login using the user that runs the Starmade server
  2. Shutdown the Starmade server if it is running
  3. Make a directory to house the bot in. I suggest you keep this isolated from the Starmade server e.g. /home/starmade/Server for starmade and /home/starmade/Nuwani for the bot
  4. Start a screen with name 'starmade' and de-attach yourself using Control+A D:
$ screen -S starmade
  1. Download a copy of Nuwani. thrunk is recommended. Use could use an online tool like svndownload without having to install tortoisesvn. Simply go to the webpage, enter http://nuwani.googlecode.com/svn/trunk/src and hit download.
  2. Upload the contens of the zip to the directory you've created for the bot.
  3. Edit example_config.php to your needs and rename it to config.php
  • Modify the 'Networks' array to where you want to deploy the bot
  • Modify the 'Bots' array to your liking
  • List all channels you want the bot to join on line 83, separating them with a comma eg '#Myserver', '#Myserver.crew channelpass'
  1. Download a copy of Spock
  2. Upload the contents to the Modules directory
  3. Edit Modules/Spock/Configuration.php to your situation
  4. Start the bot:
$ cd /home/starmade/Nuwani
$ nohup php run.php&

The bot should be joining your channel within a few seconds. If nothing happens, check nohop.out for any error messages.

About

A IRC echo bot for any Starmade server written in PHP

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages