Project

meshchat

0.0
No commit activity in last 3 years
No release in over 3 years
Meshchat core implementation written in ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

Runtime

>= 5.0.0.rc1
>= 5.0.0.rc1
>= 0.7.7
>= 1.2.0.1
>= 0.7.0
>= 0.9.1
>= 1.3.11
 Project Readme

#Meshchat Core Build Status Code Climate Test Coverage

This is the core functionality for implementing a mesh-chat compatible client in ruby

Documentation

#Usage

See Spiced Rumby (GUI wrapper around this gem)

In order to use meshchat with your own interface, you only need to pass in your own implementation of Display::Base

Optionally, you may pass in a notifier to have the mesh-chat trigger notifications for your system

Meshchat.start(
  # name of your client
  client_name: Meshchat.name,
  # version of your client
  client_version: Meshchat::VERSION,
  # your class implementing `Meshchat::Ui::Display::Base`
  display: Meshchat::Ui::Display::Base,
  # your class implementing `Meshchat::Ui::CLI::Base`
  input: Meshchat::Ui::CLI::KeyboardLineInput,
  # (optional) your class implementing `Notifier::Base`
  # typically, this hooks in to libnotify on *nix
  notifier: Meshchat::Ui::Notifier::Base,
)

For a lightweight, runnable sample for how to invoke this, see the included run script.

Development

Running

./run

Tests

rspec

Line Count

loco