Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jai-x committed Aug 11, 2021
1 parent 8d15154 commit c9e8ead
Showing 1 changed file with 37 additions and 3 deletions.
40 changes: 37 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,45 @@
# hues

A desktop implementation of 0x40 Hues from the [0X40 Hues project](https://0x40hues.blogspot.com/).
## ⚠️ This project is a work in progress ⚠️

A desktop implementation of 0x40 Hues from the [0x40 Hues project](https://0x40hues.blogspot.com/).

Inspired by [mon's Webhues](https://0x40.mon.im/)

## how to use

Go to the release page for this repo and download the version for your OS.
Extract the file and run the `hues` executable, no need to install anything.

## troubleshooting/FAQ

- *Help I changed the screen mode and now it's broken!*
Delete the `framework.ini` file in the base folder to reset to default
settings.

- *How do I import a Respack?*
Drag a `respack.zip` file into the window and it will be automatically
imported.

- *Where are the imported Respacks stored?*
(For now) They are not stored anywhere and only exist in-memory while the
program is running which means you will have to re-import them every time
(sorry :/).

## missing features
- Respack management
- Remote respack loading
- Editor
- Hue visuals options (blur, blur decay, colours palette)
- Program settings (fps, device management etc.)
- Animated images
- Image alignment
- Beatchar effects
- Fade colour (`~`, `=`)
- Slicing (`s`, `S`, `v`, `V`, `#`, `@`)
- Trippy circles (`)`, `(`)
- Clickable source links

## respack

This is the specification for which this hues will interpret respack files.
Expand Down Expand Up @@ -101,8 +137,6 @@ An example format of a `images.xml` is as follows:
* NOTE: Support to handle this element is currently not implemented
* The `<image>` element may OPTIONALLY include a `<align>` element
* NOTE: Support to handle this element is currently not implemented
* The `<image>` element may OPTIONALLY include a `<align>` element
* NOTE: Support to handle this element is currently not implemented
* The `<image>` element may OPTIONALLY include a `<frameDuration>` element
to indicate this image is part of an animated set
* NOTE: Support to handle this element and animated images is currently
Expand Down

0 comments on commit c9e8ead

Please sign in to comment.