https://github.com/michaelbull/modbot

Automated moderation for VBulletin based forums using the VBulletin Mobile API.
https://github.com/michaelbull/modbot

automated forum java moderation vbulletin

Last synced: about 1 month ago
JSON representation

Automated moderation for VBulletin based forums using the VBulletin Mobile API.

• Host: GitHub
• URL: https://github.com/michaelbull/modbot
• Owner: michaelbull
• Created: 2014-05-04T04:03:56.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-01-30T23:52:10.000Z (almost 8 years ago)
• Last Synced: 2023-09-13T12:38:27.516Z (over 1 year ago)
• Topics: automated, forum, java, moderation, vbulletin
• Language: Java
• Homepage: https://michael-bull.com/projects/modbot
• Size: 209 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# ModBot

## Introduction

Automated moderation for VBulletin based forums using the [VBulletin Mobile API][api]. This application makes use of the Mobile API included in VBulletin forums running version 4.1 and later. The Mobile API must be enabled by the administrator and an API key must be generated.

The full list of available methods that the Mobile API may utilise can be found [here][methodlist].

The application has been developed using the [Model–view–controller][mvc] pattern.

## Building

[Gradle][gradle] is used as the build system.

Run `gradle` to build the application and run the unit tests.

## Running

The application takes two program arguments:

* `url` The website URL the forum is installed on.

* `apikey` The API key generated by the forum administrator via ACP.

## Dependencies

The following Java libraries are used by the application:

* [Google Gson][gson]

* [Google Guava][guava]

* [SLF4J][slf4j]

* [Twinkle][twinkle]

## Credits

### Contributors

* [Michael Bull][michaelbull]

* [Cube][cube]

### Miscellaneous Credits

* [Heinrich Spreiter][spreiter301] - author of the Twinkle library used for displaying notifications.

* [Hai Trieu][haitrieu] - sample code for the VBulletin Mobile API.

* [Adam Parsons][aparsons] - personal maven repository that includes artifacts such as the Twinkle library.

* All of the contributors behind [Google Gson][gsoncontributors] & [Google Guava][guavacontributors].

## Screenshots

![Login Form][login]

![Notification][notification]

[login]: /img/screenshot1.png

[notification]: /img/screenshot2.png

[api]: http://www.vbulletin.com/vbcms/content.php/334-mobile-api

[methodlist]: http://www.vbulletin.com/vbcms/content.php/352-Method-List

[mvc]: http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller

[gradle]: http://www.gradle.org/

[gson]: https://code.google.com/p/google-gson/

[guava]: https://code.google.com/p/guava-libraries/

[slf4j]: http://www.slf4j.org/

[twinkle]: http://www.swingfx.ch/

[michaelbull]: https://github.com/michaelbull

[cube]: https://github.com/cubeee

[spreiter301]: https://github.com/spreiter301

[haitrieu]: http://ios4vn.com/?p=55

[aparsons]: https://github.com/aparsons

[gsoncontributors]: https://code.google.com/p/google-gson/people/list

[guavacontributors]: https://code.google.com/p/guava-libraries/people/list