Seldszar / alterse

Filesystem-based interactive graphics engine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Alterse

Yet another dynamic graphics application

Alterse lets you create dynamic overlays by using the filesystem.

Table of Contents

Installation

Download the latest release or clone this repository and install the dependencies by calling npm install, then build the widget by calling npm build.

Usage

Put the executable in a folder and create a profiles directory. A profile is a folder containing a profile.json similar to this one and two folders (content and public).

The content folder acts like a database where you can put your files, the application will generate a state tree which will be used by the graphics.

The public folder contains all the graphics and assets you which to use in your overlays. Each webpage must include the client script in order to enjoy what the application have to offer.

The application also includes a Discord plugin for retrieving voice states. If you whish to use it, you have to create an application, invite it to your server, paste the Bot Token and the voice channel ID of your choice. With that, the application will be able to provide the voice states.

If you want to see how to make it work, there's examples available here.

Author

Alexandre Breteau - @0xSeldszar

License

MIT © Alexandre Breteau

About

Filesystem-based interactive graphics engine

License:MIT License


Languages

Language:TypeScript 95.2%Language:JavaScript 4.2%Language:Shell 0.6%