Skip to content

dr-hextanium/sunset

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sunset

Sunset is a customizable "macro" expander. Basically, it does action whenever you type trigger.

This action can be anything from turning idk -> i don't know, to automating a tedious task.

Sunset isn't meant for your average person, and requires a fair amount of programming knowledge to configure. However, it provides lots of tools to make the job much easier.

Installation

Make sure you have Node.js and Git installed on your system.

Run the following command:

git clone https://github.com/TechnoDrive/sunset

or, alternatively with the GitHub CLI:

gh repo clone TechnoDrive/sunset

Once you have done so, install all of the packages:

npm i

Note: If you get an error, and you're on Linux / MacOS, use sudo.

Usage

Once you're in the freshly installed directory, run:

node index.js

or:

npm run dev

if you're creating commands (this enables auto-reloading).

Command Creation

Create a new .js file in the commands directory with the contents of example.js.

  • name should not contain any whitespace.
  • The length parameter in run is the total length of the command.

For your ease of use, these packages come pre-installed:

There are also utility functions found in ./utilties/utils.js.

Tweaks

There is one small tweak that you need to perform if you wish for <robot>.typeString to execute without the long delay. After installing robotjs, head over to ./node_modules/robotjs/src/keypress.c. Then follow the steps on this issue response. Then run:

npm rebuild

About

A customizable "macro" expander.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors