https://patreon.com/mode60

Thank you for your support!


NAVIGATION INFORMATION FEED CURRENT PROJECT INFO
PYTHON
AUTOIT mIRC
Programming Resources Dev Resources


--------------------------------------------------------------------------
Plugin Module
Test User Guide
--------------------------------------------------------------------------

This article is currently the Trivia-Master user test guide

To go along with zCore alpha-testing release, is Trivia-Master, one of the first zCore plugin modules using zCore's scriptable plugin system. This plugin module is in ultra beta status, meaning it is not 100% finished but is currently an 'operationally stable' script. The features or gameplay in this Trivia-Master module may not resemble the features and abilities of the official public release.

Trivia-Master is a run of the mill IRC trivia game that allows bot hosts to customize the category and question selection. Only game mode available currently is random trivia. Random trivia picks a random category and selects a random question from that category. (Future game modes like Category 123 in the works.) Using !myscore will detail your player stats.

User Commands (Botmaster commands scroll down)
    In channel commands:
  • !myscore - Shows your score in channel
  • !help - Currently links you to this article.
Installation

Requires: Python 3.12

First install the Trivia-Master files into the zcore folder/directory. Click here for more information on installing, mounting and using zCore plugin modules. After installation proceed with the Trivia-Master configuration described below:

Configuration
  • Open ./zcore/trivia.cnf with a text editor

    [trivia]
    serverlist = servername1 Must match a server name listed in zcore.cnf serverlist (lowercase only)
    categories = acronym-soup,anatomy,animals,art-and-literature,etc Do not change at this time

    [servername1]
    channels = #triviachannelname Must match a channel name listed in the server data in zcore.cnf (lowercase only)

    [servername1_triviachannelname] Must match the server and channel listed above, without the # (lowercase only)
    cache = 0

    Click here to view zcore config examples!

  • After configuration is complete go to your IRC terminal on the server where zCore is connected

  • In the IRC terminal type in this command:
    /privmsg botname mount-p trivia
Botmaster Commands
    In channel commands:
  • !trivia on - turn on the game
  • !trivia off - turn off the game
  • !trivia skip - skip current question

  • /privmsg commands:
  • /privmsg botname rem-q category-name
  • /privmsg botname add-q category-name ^Question text goes here`Answer text here
  • /privmsg botname clean category-name
  • /privmsg botname clean all


°²·»¸_¸«·³°°²·»¸_¸«·³°°²·»¸_¸«·³°°²·»¸_¸«·³°°²·»¸_¸«·³°°²·»¸_¸«·³°°²·»¸_¸«·³° ><))°> *SPLASH*



--------------------------------------------------------------------------
Scriptable and Modular Python IRC Bot Platform
--------------------------------------------------------------------------

Click here to visit the zCore v0.1x User's Guide

zCore is a free and open source software, written in Python and can run on any Windows, Linux (or macOS) operating system with Python 3.12.0 installed. Out of the box zCore can connect to single or multiple IRC networks and channels that you specify in the configuration, and runs the zCore System Module that has basic IRC features and importable scripting functions for plugins.

zCore uses a multi-threaded and asyncronous processing structure that allows for multiple connections and features to run simultaneously. The core software alone does everything needed for IRC connection. If no system module or plugin(s) are used, zCore will connect, and stay connected to IRC networks, join channels, and idle. With the pre-installed zCore System Module, there are some basic built in channel operation commands (simple stuff like !op, !kick etc). The zCore System Module also features an access priviledge system that can also be used in scripting plugins.

The access system consists of 3 levels of access to the zCore system administration functions, Global Botmasters (Full access), Local Admins (Limited access), and Voice users (+v). There is also a auto kick/ban list. Any botmaster or admin listed receive +o (channel operator) when joining their accessed channels, and voice users receive +v on the channel.

zCore features a scriptable plugin system that can load and run custom designed Python modules. zCore accepts two forms of python modules, one is called the system module and the other is a plugin module. The system module is a single universal supplement to the main core but can also be imported into plugin modules for scripting. These system modules handle the global attributes for all connection threads, such as userlist updating or administration access functions. The plugin modules are desgined to trigger on specified IRC events, such as JOIN, PART, PRIVMSG etc as a normal IRC bot/client would. The scriptable system will have documentation on how users can make their own plugin modules.

Plugin modules are where users can really get creative. Along with some available plugins, users can also make their own plugins. The core software is capable of running one system module and multiple zCore plugins simultaneously, and can be configured to run certain plugins on certain channels, or all channels etc. Thru this scriptable and modular system you could run multiple IRC channel and network bots all on one platform effeciently, or host the same bot in multiple places without having to run extra shell processes. Also there will be a tutorial and coding guide for users who want to learn how to make plugins for this software.


Version: 0.1x
Author: Mode60/Neo Nemesis
Alpha Testing

Source Code | User Guide



FEATURED MODULE FOR TESTING


Version: 1.00 Ultra Beta
Developer: Mode60
Beta Testing

Source Code | User Guide