Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
[no ci]
  • Loading branch information
MrExplode committed Nov 11, 2024
1 parent 459d09b commit f301d2a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# ShowManager [![Build Status](https://github.com/MrExplode/ShowManager/actions/workflows/build.yml/badge.svg)](https://github.com/MrExplode/ShowManager/actions) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/06b58e31d1834512bc7016d8240cb6f8)](https://www.codacy.com/gh/MrExplode/ShowManager/dashboard?utm_source=github.com&utm_medium=referral&utm_content=MrExplode/ShowManager&utm_campaign=Badge_Grade) [![Codecov](https://img.shields.io/codecov/c/github/MrExplode/ShowManager)](https://app.codecov.io/gh/MrExplode/ShowManager)
This project aims to be the "brain" of a prerecorded show by playing Art-Net timecode, sending scheduled OSC messages and playing audio tracks synced to timecode.

<img src="docs/ui_1.png" height="800">

## About
Please note that this is a hobby project of mine, and it is WIP. Only `wav` files are supported. Some options can be only changed from the configuration file, notably
- Audio output
Expand All @@ -24,20 +26,25 @@ You can build the Java artifact with:
```
the artifact will be in `build/libs`

### ShowManager-Frontend
ShowManager uses a [web UI](https://github.com/MrExplode/SM-Frontend). Currently you have to build it separately and tell it's location to ShowManager.
The frontend is built with `npm`, obviously you have to install it first.

Setting up the repo:
```shell
npm install
### UI
ShowManager uses a [web UI](webapp). In order to use you have to build it first, using standard [web tooling](https://pnpm.io).

```bash
# First setup
pnpm install
```

Building the project:
```shell
npm build
```bash
pnpm run build
```
Set the `dist` folder's path to the environment value `showmanager.dist`

After setting up the project with `pnpm install`, you can use the `build-webapp` gradle task for building. It runs the pnpm
build command internally.
```bash
# example full clean build, without tests
./gradlew clean build build-webapp -x test
```

Set the `build` folder's path to the environment value `showmanager.dist`

# Usage
Run the java artifact with:
Expand Down Expand Up @@ -82,3 +89,5 @@ You have to set the audio output, and add your tracks. Example:
}
```

Run again, and open the web UI on the host+port that's specified in the project settings. It defaults to `http://127.0.0.1:7000`.

Binary file added docs/ui_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f301d2a

Please sign in to comment.