Skip to main content

Client-side plugin adding extra features to Ryver

Project description

awesome-ryver

PyPI - Python Version Python package gitHub license Code style: black

This package mostly started as a joke, and from the desire of adding some extra and funny formatting features to Ryver, without requiring administrator rights or any access to the server. This is done by either installing AwesomeRyver.user.js with Tampermonkey for the web version, or by script injection with this Python package for the desktop version.

In your browser

This is the simplest and quickest method:

On your desktop: with prebuilt binary

With near to zero install:

  • Download the lastest AwesomeRyver-arch-version.zip release for your system
  • Extract the archive
  • Move both the AwesomeRyver binary and AwesomeRyver.user.js script next to your Ryver binary
  • Run AwesomeRyver

On your desktop: with pip

If you have Python installed on your system, you may prefer to install this Python package with pip:

> pip install awesome-ryver

Make sure to download and move AwesomeRyver.user.js in the folder from where you will be running AwesomeRyver, then you can launch it with:

> awesome-ryver -e C:\Path\To\Ryver.exe

Or:

> python -m awesome_ryver -e C:\Path\To\Ryver.exe

Either way, you can show the help with:

> awesome-ryver -h
> python -m awesome_ryver -h

usage: awesome-ryver [-h] [-t TIMEOUT] [-e EXE] [-d] [-p PLUGIN]

Help

optional arguments:
  -h, --help            show this help message and exit
  -t TIMEOUT, --timeout TIMEOUT
                        Timeout when trying to launch Ryver
  -e EXE, --exe EXE     Path to Ryver executable
  -d, --devtools        Enable devtools access from Ryver
  -p PLUGIN, --plugin PLUGIN
                        Path to the plugin script

Commands

Those commands work when they are detected in received messages:

Command Description Preview
[color=FF0000]colored text[/color] Generate a colored text with an hexadecimal color Preview
[red]red text[/red] Generate a colored text Preview
[green]green text[/green] Generate a colored text Preview
[blue]blue text[/blue] Generate a colored text Preview
[rainbow]rainbow text[/rainbow] Generate a rainbow text Preview
[wave]wavy text[/wave] Generate a wavy text Preview
[html]<b>bold text</b>[/html] Your message is replaced by the HTML code Preview
[python/] Print a magnificient Python in ASCII art Preview

Those commands only work when clicking on the green Send button:

Command Description Preview
[version/] Print AwesomeRyver version Preview
[spoil]some secret[/spoil] Hide the text until clicked Preview
[rand10/] Choose a random float between [0.0, 10.0[ Preview
[random10/] Choose a random int between [0, 10[ Preview
[d10/] Choose a random int between [1, 10] Preview

More to come !

How to build the AwesomeRyver binary

First clone this repository:

> git clone https://github.com/Nauja/awesome-ryver.git
> cd awesome-ryver

Install pyinstaller:

> python -m pip install pyinstaller

Run pyinstaller:

> pyinstaller --onefile awesome_ryver/main.py

This generates a dist folder containing a main binary.

Simply rename the binary to AwesomeRyver and put it next to AwesomeRyver.user.js.

License

This content is released under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

awesome-ryver-0.1.3.tar.gz (7.5 kB view hashes)

Uploaded Source

Built Distribution

awesome_ryver-0.1.3-py3-none-any.whl (8.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page