phpoxford / spires

Spires IRC bot

Spires

PHP IRC client and mock server built by PHPOxford.

Contributing and Forking

Please note that this project is licensed under the MIT license. We encourage forking of this project, but ask that you keep all copyright, attribution notices, and continue to use the MIT license in your fork of the project.

For further details on Contributing guidelines, please read the contributing guide.

Composer Skeleton

PHP IRC client and mock server built by PHPOxford.

Install

I intended this to be installed with Composer.
To create a project named package-name you can run this command:

$ ...

Usage

...

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ ...

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• The PHP Oxford User Group
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

spires's Issues

Plugin ideas

Useful:

• Get summary for the last x hours.
• Tweet from the irc channel.
• Rock Paper Scissors to resolve arguments (Private message spires with the answer)
• GitHub feed (issues, PRs, etc)
• 3v4l API
• PHP documentation
• TLDR man pages
• Give a nice warm friendly welcome to nicks not seen before
• Replace Githubs webhook to IRC with something nicer

Games:

• Play chess with people. Generate and post link to image of current state of the game.
• Wargames (Like the movie).
• Battleships.
• Tic Tac Pro (Print in one line, random row order)
• Long running quiz. Leaderboards.
• Choose your own text adventure. Collaborative.

Passive:

• Database (make it accessible by other plugins)
• Chat log (make it accessible by other plugins)

Other:

• Sing a song if it's too quiet. Maybe include peoples names.
• Code of Misconduct.
• Different modes (e.g. Christmas mode, gumpy mode)
• Imitating regular members of the channel
• Randomly (rare chance) insulting someone
• Liven things up if the chat room gets too dull
• Statistics tracking (top posters, longest-lived lurkers, etc.)

Review Freenode rules

Design plugin architecture

Set-up Code Climate

Set-up Travis

Hook up issues, pull requests and merges to IRC

Since we're being pretty active right now, let's hook this up to IRC. Does anyone know how to do it?

If not I'm happy to research and sort it out.

Create Vagrant box with Ansible

Containing database, PHP, etc.

License needed

Obviously open source, but which?

Permissions to this repo

I've set this repo so that only @ascii-soup and @martindilling have admin access. The idea being that they are the gatekeepers and only they merge stuff in. I'm pretty sure we agreed they would be in charge of merges at the last meetup.

@garethellis36 has asked for access as well, I'm totally cool with that, but can we have an agreement on whether I should just give everyone access to it, or do we actually like having only the gatekeepers with access.

@garethellis36 did you want to merge permissions or another thing that needed admin privileges?

Set-up Scrutinizer

Set-up code style rules & PHPStorm ruleset

Set-up basic repo with composer, phpunit, etc.

Sort out proper README

I just added a placeholder so that there was something in the repo. Without that, Github wouldn't let me fork it.

Edit CONTRIBUTING.MD

I left the version from @martindilling 's skeleton intact. Can someone else take on updating it?

Set-up AWS infrastructure

Dan will handle. Need Dan's github handle

Test issue for IRC notification webhook

Behat

Not sure what needs doing here. Just says "Behat" on white board photo :)

Set-up StyleCI