SnailUSB-Tamarush icon

Tamarush

A Tamagotchi emulator mod for Bomb Rush Cyberfunk

Last updated 2 weeks ago
Total downloads 191
Total rating 0 
Categories Mods Tools Misc
Dependency string SnailUSB-Tamarush-1.1.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100
LazyDuchess-CommonAPI-1.3.1 icon
LazyDuchess-CommonAPI

FOR PLUGIN MAKERS - General purpose library to make modding certain aspects of the game easier. Custom save data, phone apps, interactables and more!

Preferred version: 1.3.1

README

TamaRush

A Tamagotchi emulator mod for Bomb Rush Cyberfunk

Tamarush is a Bomb Rush Cyberfunk mod that adds in a Tamagotchi emulator, built from the ground up to fit in unity/BRC, while also keeping and even adding onto the core features of the projects it based off, which are: Tamalib, Tamatool.

Features :newspaper: :

Game / Saves
  • Tamagotchi P1 Emulator: Emulator supports P1 Tamagotchi ROMs
  • Run In Background: You can have your game be running in the background as you play BRC.
  • Manage Saves: You can easily delete/back up save files from the phone.
  • Swap Between ROMs: Option in game settings to select a ROM to run.
  • All From The In Game Phone: Everything can be done from within the in-game phone.
Cheats
  • Speed Settings: You can set the game to run at either normal, 2x, 4x, 6x speed.
Customize
  • Custom Backgrounds/Icons: You can add, and switch between mutliple Background/Icons images.
  • Audio Control: Disable audio entirely or set volume on a 1 - 10 scale.
  • Pixel Size Control: Change the size of pixels/Display.
  • LCD Color Options: Multiple color options for the LCDs.

How To Use :question: :

  • The Tamarush mod can be downloaded from Thunderstore, or directly in your thunderstore based mod managers like R2ModMan

  • You most get your own legally obtained ROM: This mod does not have any of the game code, just code to mimic the hardware needed to run the game. You will need to get your own legally obtained rom, and then place it/them in your BepInEX/TamaRush/Roms folder.

  • You most get your own legally obtained Background/Icon Images: You will need to get your own Backgrounds/Icon images, and place them in BepInEX/TamaRush/Icons & BepInEX/TamaRush/Backgrounds. You can easily find some in Tamatool's repo here: Link

  • Tamarush adds a new phone app to the in-game phone, which is where you can do everything you need to releating to this mod

  • Controls for the emulator, are the phone buttons: When you are in the play mode, BRC's inputs are rewired to only let you intereact with the emulator, which you with either:

- Dance Button: Leave play mode/close tamagotchi emulator

- Phone Left: Left button on a tamagotchi

- Phone Center: Center button on a tamagotchi

- Phone Right: Right button on a tamagotchi

- Phone Down: Tap input in the form of a button (used for Angel devices/roms)

Important Info :bangbang: :rotating_light: :

  • ROM Files can be named what ever you want, but they must end in either ".b" or ".bin": Tamarush only supports .bin based roms, however there is a system in place to automically rename any .b files into .bins when they are found, so you can still use .b roms like normal.

  • Only 5 Save files, per ROM, will be stored at one time (Not including backups): For each rom, only 5 save files will be saved at a given time, with new save files always overwriting the oldest one

  • ROM's Save folders, where the save files are stored, are based on the ROM's name: Your save files for each rom, and the folder they are placed in, will be named after whatever is the rom is named.

Credit :memo: :

  • Tamalib: TamaRush's emulator is heavily based off of Tamalib, just built from the ground up to only work in unity/BRC

  • TamaTool: Extra features in TamaRush like LCD colors, speed, save states, were based on features from TamaTool, which is a stand alone emulator also built on top of Tamalib

  • BRC-CODE-DMG: After getting stuck on the rendering pipe line between BRC and the emulator, I looked at this project and figured out Delta Transform was my fix. I also used this project to figure out how to wire up audio from the emulator, into BRC.

  • Tamalib: https://github.com/jcrona/tamalib

  • Tamatool: https://github.com/jcrona/tamatool/

  • BRC-CODE-DMG: https://github.com/AbsentmindedGCN/BRC-CODE-DMG/