Code Monkey home page Code Monkey logo

tanuki's Introduction

Tanuki Launcher

Tanuki Launcher is a cross-platform launcher 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 features worthy of a WINE helper.

Tanuki has many extra features, such as screen and audio recording, Touhou scorefile backup, viewing and compressing screenshots, etc.

Download

Download the latest instance of Tanuki in the releases page

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

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 screen recording, video playback and screenshot functionality)
  • FFplay (optional, for viewing video and images)

Tanuki's OS support extends to all operating systems with WINE support + Windows.

More information on platform support here

Configuration

Full configuration information

To play games and manage your data, you need to add game and data entries to your config.txt, which is automatically created where the jar is.

You can configure this file from within the launcher, or you can manually write your config text file.

The configuration also supports settings for command execution, etc.

Config example:

command=wine

game=Touhou 7:/path/to/touhou 7/th7.exe
data=Touhou 7 Data:/path/to/touhou 7

Running on Linux, MacOS, FreeBSD, etc

Tanuki is cross-platform, but the Touhou games are only distributed for x86 Windows. If you are not running Windows, you can run Touhou with WINE.

To run your Touhou games with WINE, add the following setting to your config.txt:

command=wine

If you are playing Touhou with a custom WINE build, make sure to read the full documentation. You can set the path to the build like this:

command=/path/to/custom-wine/bin/wine

Screen recording

Recorder documentation

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.

Compile from source

You need Scala 3 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

tanuki's People

Contributors

spacebanana420 avatar

Stargazers

 avatar Lucas V. avatar

Watchers

 avatar

tanuki's Issues

WINE prefix setting does not work

For some unknown reason I have yet to discover, environment variables aren't being truly set when running games, meaning that the wine_prefix setting does not work at all.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.