Skip to content

hemna/aprsd-borat-plugin

Repository files navigation

APRSD Borat Plugin

PyPI Status Python Version License

Read the documentation at https://aprsd-borat-plugin.readthedocs.io/ Tests Codecov

pre-commit


Warning

Legal operation of this software requires an amateur radio license and a valid call sign.

Note

Star this repo to follow our progress! This code is under active development, and contributions are both welcomed and appreciated. See CONTRIBUTING.md for details.

Features

The APRSD Borat Plugin provides a fun APRSD plugin that responds to messages with random Borat quotes. Key features include:

  • Random Quote Responses: Responds to messages starting with "b" or "B" with random Borat quotes
  • APRS Message Formatting: Automatically wraps quotes to fit within APRS message length limits (67 characters per line)
  • Easy Configuration: Simple enable/disable configuration option
  • Large Quote Database: Includes a collection of classic Borat quotes

Requirements

  • aprsd >= 4.2.4
  • A running APRSD instance

Installation

You can install APRSD Borat Plugin via pip from PyPI:

$ pip install aprsd-borat-plugin

Or using uv:

$ uv pip install aprsd-borat-plugin

Configuration

Before using the Borat plugin, you need to configure it in your APRSD configuration file. Generate a sample configuration file if you haven't already:

$ aprsd sample-config

This will create a configuration file at ~/.config/aprsd/aprsd.conf (or aprsd.yml).

Plugin Configuration

Add the following section to your APRSD configuration file to enable the Borat plugin:

[aprsd_borat_plugin]
# Enable the Borat plugin (default: False)
enabled = True

Example Configuration

Here's a complete example configuration:

[aprsd_borat_plugin]
enabled = True

Usage

Once installed and configured, the Borat plugin will automatically be loaded when you start APRSD.

How It Works

The plugin responds to APRS messages that start with "b" or "B" (case-insensitive). When triggered, it will:

  1. Select a random quote from its database
  2. Wrap the quote to fit APRS message length limits (67 characters per line)
  3. Send the formatted quote back to the sender

Example Usage

If someone sends you an APRS message like:

b

or

B hello

The plugin will respond with a random Borat quote, such as:

Kazakhstan is number one exporter of potassium,
Other Central Asian countries have inferior
potassium.

Example Interaction

Here's a complete example of an interaction with the plugin:

User sends APRS message:

b

Plugin responds:

Kazakhstan is number one exporter of potassium,
Other Central Asian countries have inferior
potassium.

Another example:

User sends APRS message:

B hello there

Plugin responds:

Yakshemash! In US of A, democracy is very different
from Kazakhstan. In America, woman *can* vote, but
horse - *cannot*!

Another example:

User sends APRS message:

b tell me something

Plugin responds:

Very sorry to interrupt politic. Might I make a
shit in your house?

Note: The plugin responds to any message starting with "b" or "B", regardless of what follows. Each response is a randomly selected quote from the database.

Verifying It's Working

After starting APRSD, check the logs for messages like:

INFO: Loading plugin: BoratPlugin
INFO: BoratPlugin enabled

You can test the plugin by sending yourself an APRS message starting with "b" or "B" and you should receive a Borat quote in response.

For more details, see the Command-line Reference.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, APRSD Borat Plugin is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @hemna's APRSD Plugin Python Cookiecutter template.

About

APRSD Plugin to provide quotes from the Borat movie

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors