Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
(tbf this was chatgpt'd since i didnt feel like writing one)
  • Loading branch information
cainan-c committed Jan 2, 2025
1 parent ee38181 commit fbdc872
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
/obj
/TaikoModManager/bin
/TaikoModManager/obj
/Release
78 changes: 76 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,76 @@
# TaikoModManager
Dedicated Mod Manager for the STEAM release of Taiko no Tatsujin: Rhythm Festival
# Taiko Mod Manager

Taiko Mod Manager is a tool designed to enhance your experience with the Steam Release of *Taiko no Tatsujin: Rhythm Festival*. It provides features for managing mods, plugins, and configurations, with integration for BepInEx.

## Features

- **Auto-Detection**: Automatically detects the game installation path.
- **Plugin Management**: Install and update directly from GitHub repositories as well as directly manage plugins configuration.
- **Mod Management**: Enable, disable, and configure mods through a user-friendly interface.
- **BepInEx Integration**: Automatically installs BepInEx if not present and manages its configuration.
- **TekaTeka Support**: Includes functionality for managing TekaTeka mods.

## Requirements

### Prerequisites

1. **Operating System**: Windows 10 or Windows 11.
2. **.NET Framework**: .NET 8.0 or higher. You can download it from [Microsoft's .NET page](https://dotnet.microsoft.com/).
3. **BepInEx**: The tool will auto-install BepInEx if it's not already set up.
4. **Game Installation**: Ensure *Taiko no Tatsujin: Rhythm Festival* is installed on your system through Steam.

### Additional Dependencies

- `Tomlyn`: For parsing and managing TOML files.
- `System.IO.Compression`: For handling ZIP files when installing plugins.

## Installation

1. Clone or download this repository to your local machine.
2. Ensure all prerequisites are installed.
3. Build the project using Visual Studio or another compatible IDE.

## Usage

1. Launch the application.
2. Follow the on-screen instructions to locate the game executable (`Taiko no Tatsujin Rhythm Festival.exe`).
3. Use the tabs to manage:
- **Plugins**: Install, update, and configure plugins.
- **Mods**: Manage TekaTeka mods and their configurations.
- **BepInEx Config**: Edit BepInEx settings.
4. Enjoy a customized *Taiko no Tatsujin* experience!

## How It Works

### Game Path Detection

The application attempts to locate the game automatically by checking Steam library folders or prompts the user to manually select the game executable.

### Plugins

- Download and install plugins from GitHub repositories.
- Automatically check for updates.
- Edit plugin configurations.

### Mods

- Manage mods stored in the `TekaSongs` folder.
- Enable or disable mods via their `config.toml` files.

### Configuration

- View and edit `BepInEx.cfg` through an intuitive UI.

## Contributing

Contributions are welcome! Feel free to submit issues or pull requests.

## License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

For more information, please refer to [The Unlicense](http://unlicense.org/).

---

0 comments on commit fbdc872

Please sign in to comment.