Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremynoesen committed Aug 14, 2024
1 parent 61cbfa9 commit dbfcda9
Showing 1 changed file with 45 additions and 22 deletions.
67 changes: 45 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,55 @@

## About

AI Sponge Lite is a Discord bot that generates audio-only episodes with transcripts inspired by AI Sponge and AI Sponge
Rehydrated.
AI Sponge Lite (sometimes called "Lite") is a Discord bot that generates audio-only AI Sponge episodes with transcripts
inspired by AI Sponge and AI Sponge Rehydrated (sometimes called "Rehydrated").

### Characters

The available characters are SpongeBob, Patrick, Squidward, Loudward, Gary, Sandy, Mr. Krabs, Plankton, Karen,
Mrs. Puff, Larry, Bubble Bass, Bubble Buddy, and the French Narrator. Some characters will sound different from
Rehydrated due to them using private models.

### Background Music

The available background music is the SpongeBob SquarePants closing theme and the Tip Top Polka. One of these is chosen
at random per episode.

### Sound Effects

The available sound effects are the steel sting and boowomp. One of these is chosen at random to play at a random point
per episode.

### Random Events

The available random events are speech cutoffs and loud events. Both of these can happen in an episode any number of
times. Loudward is always loud and will not be affected by loud events.

### Strokes

Lite supports strokes, which are when FakeYou glitches out and generates abnormal audio. The volumes of characters are
normalized, so strokes will not be full volume (unless a loud event occurs).

## Usage

- `/generate`: Generate an episode. Only one episode can be generated at a time globally. There is a 5-minute cooldown
if the command succeeds. Characters that can appear in episodes are:
- SpongeBob
- Patrick
- Squidward
- Loudward
- Gary
- Sandy
- Mr. Krabs
- Plankton
- Karen
- Mrs. Puff
- Larry
- Bubble Bass
- Bubble Buddy
- French Narrator
- `/status`: Check if an episode can be generated.
upon successful generation. Generation may take around 15 minutes.
- `/status`: Check if an episode can be generated. This will show if the bot is busy, if you are on cooldown,
or if the bot is idle.

## Installation

Click the link in the "About" section of the repository, then click "Add App" on the next page. After that, follow the
instructions in the popup.

## Troubleshooting

- If you encounter the error "Missing required permissions.", make sure the bot has the following permissions: View
Channels, Embed Links, Attach Files, and Read Message History.
- If you encounter the error "Failed to generate episode.", try using the generate command again. If it happens right
after generation jumps from 0%, try changing the wording of your topic.

## Demonstration

<div align="center">
<img src="img/generating.png" alt="Generating" title="Generating" />
<img src="img/output.png" alt="Output" title="Output" />
</div>
![Generating](img/generating.png)
![Output](img/output.png)

0 comments on commit dbfcda9

Please sign in to comment.