Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spacebanana420/tanuki
Cross-platform launcher for the Touhou Project games
https://github.com/spacebanana420/tanuki
bullet-hell cross-platform ffmpeg game java jvm launcher scala touhou tui wine
Last synced: 2 months ago
JSON representation
Cross-platform launcher for the Touhou Project games
- Host: GitHub
- URL: https://github.com/spacebanana420/tanuki
- Owner: spacebanana420
- License: mit
- Created: 2024-02-06T16:44:31.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-05-21T23:50:31.000Z (7 months ago)
- Last Synced: 2024-05-22T00:36:49.175Z (7 months ago)
- Topics: bullet-hell, cross-platform, ffmpeg, game, java, jvm, launcher, scala, touhou, tui, wine
- Language: Scala
- Homepage:
- Size: 1.69 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tanuki Launcher
Tanuki Launcher is a cross-platform game launcher and WINE helper primarily made for the Touhou Project games. It supports all games from Touhou 6 onwards. Tanuki can also be used to launch any game, not just Touhou games, and it has an extra set of features, such as screen and audio recording, taking screenshots, Touhou scorefile backup, viewing and compressing Touhou screenshots, etc.
# Download
Download the latest instance of Tanuki in the [releases page](https://github.com/spacebanana420/tanuki/releases)
If you have Scala 3 in your system, download ```tanuki.jar```
If you just have Java in your system, download ```tanuki-java.jar```
If you are running an x86_64 Linux system, download ```tanuki-linux-x86_64.zip```
[Information on downloading and running Tanuki](doc/download.md)
# Requirements & how to use
Tanuki requires the following to work:
* Scala 3 or Java 11 or later (unless running the native Linux binary)
* FFmpeg (optional, for all functionality related to image and video)
Tanuki's OS support extends to all operating systems with WINE support + Windows.
[More information on platform support here](doc/platforms.md)
# Configuration
[Full configuration information](doc/config.md)
To play games and manage your data, you need to add game and data entries to your ```config.txt```, which is automatically created where Tanuki is.
You can configure this file from within the launcher, or you can manually write your config text file.
Many more settings are available in the configuration documentation.
### Config example:
```
wine=wine
game=Touhou 7:/path/to/touhou 7/th7.exe
data=Touhou 7 Data:/path/to/touhou 7
```
# Screen recording
[Recorder documentation](doc/recorder.md)
With FFmpeg, Tanuki can record your screen and audio as you play Touhou, to record your gameplay. You can configure the recording settings for a more faithful or lossless video footage, or for a more lightweight footage, whether it's lightweight as in low CPU usage or as in low file size.
After you record your footage, you can view it as many times as you want with [Gensokyo Cinema](doc/movie.md).
# Compile from source
You need [Scala 3](https://scala-lang.org/) to build Tanuki from source. You can use the scalac compiler or scala-cli.
You can compile Tanuki directly with scalac this way:
```
scalac src/*.scala src/*/*.scala src/*/*/*.scala -d tanuki.jar
```
This JAR can be launched with scala or scala-cli
For more information and alternatives on compiling Tanuki, check the link below.
[Compiling Tanuki from source](doc/compile.md)
