https://github.com/esotericpig/twandy
Twitch bot for playing games.
https://github.com/esotericpig/twandy
Last synced: 11 months ago
JSON representation
Twitch bot for playing games.
- Host: GitHub
- URL: https://github.com/esotericpig/twandy
- Owner: esotericpig
- License: lgpl-3.0
- Created: 2021-05-03T09:06:02.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-05T12:33:04.000Z (almost 2 years ago)
- Last Synced: 2024-12-27T07:34:26.241Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 405 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Twandy
[](https://github.com/esotericpig/twandy)
[](COPYING.LESSER)
Twitch bot for playing games.
## Setup
Install **Java 17+** from [Adoptium](https://adoptium.net) or with [SDKMAN!](https://sdkman.io) or whatever.
TODO: Download Release and run.
## Build
Install **Java 17+** and **Gradle v8.10+** with [SDKMAN!](https://sdkman.io) or whatever.
The root-level Bash script, [twandy](twandy), will build the Jar (as fast as possible) if it doesn't exist, and then run it. If the Jar already exists, it will not rebuild it.
```
$ ./twandy
$ ./twandy --help
```
Or build manually (use `./gradlew.bat` on Windows):
```
$ ./gradlew build
```
The `twandy` script uses `./gradlew` if it exists, else it uses `gradle`. So if you don't want `twandy` to use `./gradlew`, just delete `./gradlew`.
## Run
Run the app using one of these methods:
```
## 0) Use the top-level script.
$ ./twandy
## 1) Use the Jar.
$ java -jar app/build/libs/twandy.jar
## 2) Use one of the build scripts.
$ app/build/install/twandy/bin/twandy
$ app/build/install/twandy/bin/twandy.bat
## 3) Use Gradle.
$ ./gradlew run
```
## Usage
These examples use the `twandy` script, but any of the other running methods will also work with these same options/commands.
```
$ twandy --help
```
TODO: user/pass
TODO: play Solarus; download and run DX file
TODO: play lichess
TODO: run fhat
## License
[GNU LGPL v3+](COPYING.LESSER)
> Twandy []
> Copyright (c) 2021 Jonathan Bradley Whited
>
> Twandy is free software: you can redistribute it and/or modify
> it under the terms of the GNU Lesser General Public License as published by
> the Free Software Foundation, either version 3 of the License, or
> (at your option) any later version.
>
> Twandy is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU Lesser General Public License for more details.
>
> You should have received a copy of the GNU Lesser General Public License
> along with Twandy. If not, see .