TweeseCake

Introduction

TweeseCake is a light-weight, multi-purpose, robust software suite, for Windows and macOS. It can either be controlled entirely without a window (Windows only), or from a handy, easy-to-use UI! Some highlights include:

Notes

The invisible interface is only available on Windows, and it will probably remain that way (Apple doesn’t let us bind many shortcuts).

In addition, replace control with command and alt with option in keyboard shortcuts on Mac.

It’s also worth noting that to get to a list of all possible commands from within the UI, press alt+m. This is session specific, so it will only show you what you need to know.

Getting started

Upon first launch, you will be asked for your TweeseCake username and password. If you do not have an account already, go to TweeseCake.app to create one.

Once that’s done, you’ll need to find your config session if using the window, or press Alt+Windows+Shift+Right arrow to get to the config session. After that, to create a new session/account, use control shift N if using the window, or Alt+Win+Shift+N if not. This will bring up the session type chooser. Simply choose what type of session you want from the list, and press OK.

Twitter

The Twitter login page will be opened in your browser. Once logged into twitter, copy the code that twitter shows into the authorization code window, and press enter.

Telegram

You will be asked for your phone number, this includes your country code, and then for an authorization code that is sent directly to your Telegram account. For example, an example US phone number would look like this: +19998765433. Enter it, and you’re good to go. Note: You must have two factor authentication disabled for login to work at this time. If you are unable to log into telegram, please try downloading the Microsoft Redistributable package and install it.

File Explorer

A new session will simply be created, no input required.

Radio

A new session will also just be created with no input required.

Mastodon

First, you’ll be asked for the mastodon instance you wish to log in with. If you don’t know what this means, just press enter for the default. You’ll be asked for your Mastodon account’s email and password. Enter these, and you should be good to go.

Github

To log into Github, you need a personal access token. To get this token, Go to Github’s tokens page and generate a new token. Save this token in case you need to log in again. Note: When creating your token, Make sure the private repositories check box is checked, if you’d like TweeseCake to be able to read your private repositories.

Feeds

A new session will just be created, at which point you can just add feeds to it.

Home Assistant

To log into your home assistant instance, you will need a URL (E.G: http://homeassistant.local:8123) or an IP address on your local network. You will also need a Long-Lived access token, which can be obtained from your profile page: Open your Home Assistant instance and show your Home Assistant user’s profile.

Session types

Twitter

The Twitter session allows you to interact with Twitter. It contains all the basic functionality, such as tweeting, replying, retweeting etc. The default buffers are as follows:

UI Keys

Telegram

This session allows you to interact with Telegram. While it doesn’t contain all of Telegrams functionality (e.g. calling), it contains quite a good bit. The default buffers are as follows:

UI Keys

File explorer

This session allows you to explore your file system without needing a window. The default buffers are as follows:

UI Keys

Radio

The radio session allows you to listen to internet radio. The default buffers by default are:

UI keys

Github

The Github session allows you to view your repositories, as well as the files in that repository. It also allows you to view issues of repositories, make new ones, and comment on existing ones. Finally, it allows you to search github for repositories.

UI keys

Feeds

The feeds session allows you to listen to podcasts and view RSS feeds all from one session! We’ve made it as easy to use as possible.

UI Keys

Home Assistant

The Home Assistant session allows you to view the state and interact with your smart home from within the TweeseCake application.

UI Keys

Config

You will already have a session by default called “TweeseCake: Config”. This is your configuration / options session. It doesn’t require any kind of setup; it’s just there by default. The default buffer is general, and there is a second buffer called buffers. They currently contain the following options:

General

Buffers

UI Keys

Mastodon

The Mastodon session type allows you to interact with Mastodon. It doesn’t support absolutely everything you can do on mastodon for the moment, but it can do quite a bit!

UI keys

Misc UI keys

Invisible Keyboard shortcuts

Invisible Keyboard shortcuts are always being added and updated based on your keymap or currently focused session. To get a current list of keyboard shortcuts rellivent to the session you’re currently focused in, press windows alt shift H from anywhere.

Creating custom keymaps

To create a custom keymap, create a new text file in the keymaps folder, and rename it to the name of your keymap. After that, change the extension from .txt to .keymap. If you get a warning about files possibly becoming unusable, press yes.

Your file should contain this at the top of it.

[info]
name = Name of your keymap
desc = Description of what your keymap does.
author = Your name

[keymap]
Keys go here.

Do note that you don’t have to fill in all the keys, just the ones you want to change. Any keys left out will be assigned to the default.

Note

Currently, keymaps only work for global keys.

At the time of this writing, there’s no way to remap the UI keys.

Soundpacks

To create a soundpack, create a folder with the type of session you want to support, followed by a dash (-), followed by the name of your pack (e.g. twitter-mypack). Do note that names are not case-sensative.

The currently available session types are:

Your packs need to contain the following files:

Twitter

Telegram

fileExplorer

Github.

Mastodon.

Default Sounds.

Inside the sounds folder, you will find a folder named default. This contains sounds that you don’t have to fill in, but you can on a per-soundpack basis. If you don’t fill them in, the sounds in here will play. It contains the following sounds:

Portable mode.

To run TweeseCake in portable mode, create a folder called “userdata” in the same folder (without the quotes). Alternatively, you can copy your appdata TweeseCake folder, and rename it to userdata.

Getting support.

Need help? Have a question? Want to report a bug? You can contact us and do just that, in one of the following ways: