Git Product home page Git Product logo

fuelrathelper's Introduction

Fuel Rat Helper

HexChat Plugin

This plugin listens for ratsignals from MechaSqueak, parsing the data accordingly and copying the system name to the clipboard. (As far as I know, this will only work on Windows.)

The script can be configured to only trigger alerts for cases on a given platform and game version (Horizons or Odyssey). It is possible to configure the format of the case data to be copied to the clipboard.

Installation

Run the install script with python install.py. This will ensure the correct files are installed under the HexChat addons folder.

Usage

The requested info (by default, the system name) should be copied to the clipboard automatically whenever MechaSqeak fires up the ratsignal. There are a couple of commands which control the behaviour of the plugin:

/fr_log <'true'/'false'>: Enable or disable FuelRat helper logging.

/fr_clip <'format'>: Specify format of clipped string (none to disable)\nc=casenum, s=systemname, n=clientname

/fr_platform <'ALL'/'PC'/'XB'/'PS4'>: Set platform for alerts."

/fr_sound <path>: Set the file to use as an alert tone."

/fr_game_version <'ALL'/'HORIZONS'/'ODYSSEY'/'LEGACY'>: Set which game version for which cases should trigger alerts. (Only relevant for PC platform.)"

Logging

Logging can be enabled if you want to keep records of all the lines sent by MechaSqueak. The lines will be appended to a file at '%USERPROFILE%\AppData\Local\Temp\ratirc.log'.

Clipboard Formats

The /fr_clip command is used to specify the format in which the case data is copied to the system clipboard. At present, the case number, system name, and client name can be included. The elements will be separated by a '|' character.

For example, if the format is 's' output will only include the system name. (e.g., 'Sol'). More information may be required by a third-party tool such as a custom VoiceAttack command. In this case, the format may combine the data. The format 'nsc' will output the case number, system name, and client name. (e.g., '2|Sol|Guntereno'.)

fuelrathelper's People

Contributors

guntereno avatar

Watchers

 avatar

fuelrathelper's Issues

Error when loading rat_lib.py

I was able to load fuelrat_hexchat.py just fine but when I load rat_lib.pi I get the following error:

Module has no __module_name__ defined
 Exception ignored in: <module 'threading' from 'C:\\Program Files\\Python36\\Lib\\threading.py'>
 Traceback (most recent call last):
   File "C:\Program Files\Python36\Lib\threading.py", line 1289, in _shutdown
     assert tlock.locked()
 SystemError: <built-in method locked of _thread.lock object at 0x0000026A731BB170> returned a result with an error set

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.