Skip to main content

a brewing tool for CivMC/CivCraft

Project description

omokami's brew tool

a cute little cli tool for organizing and timing your brews!

this program:

  • keeps track of all of your known brew recipes in a yaml file (my known brews provided)
  • lets your quickly reference them within the program using a fuzzy search
  • has a clean little cli with cute recipe cards
  • creates concurrent timers using your notification system!
  • has two modes: constant & interval
  • has time drift protection for accurate timekeeping
  • can play custom sounds on brew completion
  • can take an argument if you want your config files somewhere specific
  • is pretty cute!
  • has currently only been tested on endeavourOS running i3wm. (lmk if it works on your system!)

who is this for?

CivMC brewers but any brew mod users can use the basic template.
the default provided yaml file just won't apply to you.

install

you can grab the package off of github and do it the manual way.
or, for your convenience, the most stable current version is on pip
pip install brewt

usage

simply run the main files with an optional '-p' flag to specify a custom config path
use the slash commands in the prompt to control the program
every timer you start has a unique code attached to it
this can be used to disambiguate batches you may have running at the same time
it can also be used to kill specific timers using the "/k" command

there are two timer modes because some notification systems will not update in place. they seem to ignore the "id" tag being passed in the notification, so the "constant" timer which ticks down every second will unfortunately flood users who have a notification system like this. if this happens to you, you will need to use the "interval" timer mode or see if you can tweak your notification systems configuration to be less janky.

planned features

  • slash commands to: done!
    • kill specific timers, done!
    • pretty print all recipe cards, done!
    • quit the program (currently ctrl+c) done!
  • config file to: done!
    • turn on/off persistent notifications (only get a notif @ x time) done!
    • custom sounds done!
  • ~~allow custom brewfile location (currently ~/.config/brewt/brews.yaml)~~ done!
  • set different sounds at different intervals
  • custom countdown value

contact

in game as omokami (ma suno & UTSS) or on the purple at okamime#9484
you're welcome to send me feature requests, bugs you run into, or simply berate me for my poor choices!
also if you found this useful, feel free to send me recipes or hints!

appearance

warning, screenshots are from previous version of the program screenshots for your convenience.
color scheme and font will depend on your terminal configuration.

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

brewt-1.2.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

brewt-1.2.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file brewt-1.2.0.tar.gz.

File metadata

  • Download URL: brewt-1.2.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for brewt-1.2.0.tar.gz
Algorithm Hash digest
SHA256 69ab406817d5f09ca7688f88157f515db6690c9adc4291e33c5f2f006fdc2e55
MD5 d4cf3809cf228043c6d7f18f7dceeb26
BLAKE2b-256 bcd8a9a5175bcd46b45793d84a34781c9132986b44e80050c2030e21bfb3faea

See more details on using hashes here.

File details

Details for the file brewt-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: brewt-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for brewt-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ed7be8fecf47455123ecfbb0307e7aaa6afad04bbb40ba458dea0a21d40d4c2
MD5 0cee8590d48d685ba7fba545e92b2e79
BLAKE2b-256 da47b2d98e2bdb44d7de971404b8faa537ace5893ccdaa0ee5086afccaae603a

See more details on using hashes here.

Supported by

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