awesome-ryver 0.1.1

Client-side plugin adding extra features to Ryver

awesome-ryver

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.

Install in your browser

Easy, first make sure Tampermonkey is installed in your browser, then download AwesomeRyver.user.js and install it via Tampermonkey.

Install on your desktop

The simplest method with near to zero install is to download the lastest release for your system, extract the archive, and run the AwesomeRyver binary. This is a packaged version of this Python package which avoid the need of installing Python, plus the dependencies, on your computer.

Please note that AwesomeRyver.user.js is bundled in the archive and must be located near the AwesomeRyver binary for it to work. Alternatively, you can pass the path to AwesomeRyver.user.js with:

> AwesomeRyver.exe -p C:\Path\To\AwesomeRyver.user.js

If Ryver.exe is not in your PATH, you may have to launch the binary with:

> AwesomeRyver.exe -e C:\Path\To\Ryver.exe

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

> pip install awesome-ryver

Make sure to have AwesomeRyver.user.js in the folder from where you are running AwesomeRyver, and 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:

> AwesomeRyver.exe -h
> 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

Here is the list of commands you can use in your messages.

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

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.