/Stynal

CLI loader for custom Signal themes and CSS files written in python

Primary LanguagePythonMIT LicenseMIT

stynalSplashBevel Signal, but ✨ stylish ✨

Overview

stynalOverviewE.mp4

Installation

Prerequisites

Clone the repository

(Optional if you downloaded the repository yourself and extracted it)

git clone Gapva/Stynal

Navigate to wherever you cloned Stynal, then to the cli subfolder

(Alternatively, you can navigate to the extracted directory in a file manager)

cd Stynal
cd cli

Install the required dependencies using PIP (pre-packaged with Python)

(If you do not have a terminal interface open yet, you will need to open one to complete this step)

pip install -r requirements.txt

Run Stynal

python stynal.py --help

At this point, you are finished with the required setup.
For something more convenient, you should add the Stynal directory to your PATH environment variable.
If done correctly, you should be able to just run stynal.py --help (or any other Stynal command) from anywhere on your system.
I will not be providing extensive documentation on how to do this, but you can find out how from these resources:

Alternatively, you can edit your Powershell $PROFILE. Install Powershell on any OS if you haven't already.
To do so, check that it exists. It probably doesn't, but try opening it in notepad (or whatever text editor you prefer) to be safe, as shown below.

notepad $PROFILE

If it fails, you can create your $PROFILE by running the below command.

New-Item -ItemType File -Path $PROFILE -Force

Now that it is created, repeat the previous step to open it in your preferred text editor.

Paste the following information into the file, and make necessary changes:

function stynal {
  $stynalPath = "A:\path\to\Stynal\cli\stynal.py" # EDIT THIS TO REFLECT THE ACTUAL STYNAL PATH
  & python $stynalPath @args
}

Save the script and restart Powershell to apply changes. 🎉

Finding Themes

You can find (and contribute to) a list of themes here.

Updating

You can update Stynal by navigating to wherever you have its master branch installed, and pulling changes.

cd path\to\Stynal
git pull