shilo/sd2-caffeine-mod

A Caffeine-addicting mod that boosts Soda Dungeon 2's energy and smartness. Includes quality of life features and fixes. Guaranteed free, safe, and no cheats.

SD2 - Caffeine Mod [Steam / Windows / Mac OS X]

Caffeine Mod
A Caffeine-addicting mod that boosts Soda Dungeon 2's energy and smartness.
Includes quality of life features and fixes.
Guaranteed free, safe, and no cheats.

Compatible with Steam, Windows and Mac OS X only.
Mac OS X installer coming in the future.

Author: Shilo
Go to Releases

Table Of Contents

• Overview
  • Comprehensive Settings
  • Friendly Information
  • Detailed Statistics
  • Thoughtful Touch Ups
  • Renowned Satisfaction
  • Caffeine Experience
• Disclaimer
• Security
• Compatibility Warning
• Download
• In-game Usage
• Installation
  • Windows
    • Mod Auto Install
    • Manual
  • Mac OS X
    • Manual
• Uninstallation
  • Steam's "Verify Integrity of Game Files..."
  • Windows
    • Mod Auto Uninstall
    • Manual
  • Mac OS X
    • Manual
• Roadmap
• Versioning
• Special Thanks

Overview

See detailed changes in changelog...

Comprehensive Settings

Take full control of your gameplay, with customizations for all important options. Play the game the way you want. If there's a built-in feature you arent enjoying, you are free to go back to "Vanilla Experience" by disabling the mod at any point in time. Limitations are in the past.

Friendly Information

Become more in the loop with the game by taking advantage of helpful notifications and tooltips. Know about important events such as when the game saves. Hover over elements to view details. Don't need the extra information? You can simply turn them off.

Detailed Statistics

Are you a fan of numbers and data? Use the Game Report menu to view a massive list of in-game data in realtime. You can even export the data on request or live. The data is developer friendly so you can create your own third party applications for Soda Dungeon 2.

Thoughtful Touch Ups

We all enjoy Soda Dungeon 2, but no game is perfect. Improve the game's strengths and fix the game's weaknesses. Various Quality of Life changes throughout the entire game. Allowing for more enjoyable gameplay.

Renowned Satisfaction

Approved by the Soda Dungeon 2 developer. Supported and used by the lovely community. Created specifically for them and highly appreciated. This mod continues to grow with the growth of the supportive players backing it. Guaranteed safe to use and always the player in mind.

Caffeine Experience

• Focused on performance optimizations.
• Highly customizable settings.
• Custom and holiday/special event themes.
• Flexible support for third party themes (including Starter theme).
• Enhanced FPH counters (Floors Per Hour).
• Exciting and competitive leaderboard. (Upcoming)
• Complete game report statistics.
• Helpful notifications and tooltips.
• Numerous splash number formats.
• Customizable friendly and enemy status.
• Convenient battle options.
• Optional desktop-standard hotkeys.
• Fully accessible in-game windows.
• Extra and easily readable statistics.
• Lightweight FPS counter (frames per second).
• Simple one-click data copying.
• Automatic backup and recovery support.
• Comforting compatibility protection.
• Various improvements and bug fixes.
• Disable mod in real-time.
• Discord Rich Presence integration.
• Compact battle notification styles.
• Easy in-game automatic mod updater.
• Useful FPS Counter. (Added to Vanilla)
• And more.

Disclaimer

© 2020 CaffeineMod.com Shilo. © 2020 AN Productions | poxpower. All rights reserved.
All code and rights belong to their respective owners: Shilo, AN Productions, Poxpower, Armor Games Studios or other.
I take no credit for any of the original code and assets.
Use this mod at your own risk: I am not responsible for any results of using this mod.
By using this mod, you agree to the above terms.

Security

Guaranteed safe and virus free.
See security report....

Compatibility Warning

Only install this mod with the compatible SD2 version specified (for example, Caffeine Mod v1.0.6.X only supports SD2 v1.0.6). The numerical version of the mod will always match the supported version of the game. If you unintentionally install the mod with an incompatible SD2 version, you can uninstall the mod to revert back to the original working game. Or you can repair your game via Steam's "Verify Integrity of Game Files..." button.

Download

Latest: SD2-Caffeine-Mod.zip

• Navigate to latest version.
• Scroll down to "Assets" and open the first link named "SD2-Caffeine-Mod.zip".

Source code links are irrelevant as it is just the documentation only.
If your browser indicates that download may be dangerous, instruct it to continue/keep download.
If your antivirus software reports a virus, it is a false positive and should be reported to the antivirus company.

In-game Usage

• Open options and about window by clicking the button at bottom-right of the game.
• Toggle options to turn on/off features and fixes.
• Enjoy the caffeine rush!

Installation

Note: If the game is updated, the mod will be automatically uninstalled.

• Download the latest version.
• Unzip/extract downloaded folder. (Required)
• Install with one of below methods:

Windows

Mod Auto Install

• Launch install.bat.
• Press Y when prompted.
• You should see a success message.
• If game is running, exit and restart it.

Manual

Only follow these steps if you are competent with computers and file management.
How to manual install (video): https://drive.google.com/file/d/1lo__jlMy2TFOTLEbf5WJ7vdEUxU5_P7i/view?usp=sharing

• Navigate to folder: C:\Program Files (x86)\Steam\steamapps\common\Soda Dungeon 2\SodaDungeon2_Data\Managed\
• Create a copy/backup of Assembly-CSharp.dll (preferably in the same folder).
• Replace Assembly-CSharp.dll with the exact file that was downloaded.
• If game is running, exit and restart it.

Warning: Make sure not to confuse Assembly-CSharp.dll with Assembly-CSharp-firstpass.dll, only replace Assembly-CSharp.dll.
If you have issues or made a mistake, repair your files with Steam's "Verify Integrity of Game Files..." and attempt to install again.

Mac OS X

Manual

Only follow these steps if you are competent with computers and file management.
More detailed instructions in the future.

• Locate your Steam apps: Steam -> Preferences -> Downloads -> Steam Library Folders
• Show package contents: Right click SodaDungeon2 -> Show Package Contents
• Navigate to the following folder: Contents -> Resources -> Data -> Managed
• Create a copy/backup of Assembly-CSharp.dll (preferably in the same folder).
• Replace Assembly-CSharp.dll with the exact file that was downloaded.
• If game is running, exit and restart it.

Warning: Make sure not to confuse Assembly-CSharp.dll with Assembly-CSharp-firstpass.dll, only replace Assembly-CSharp.dll.
If you have issues or made a mistake, repair your files with Steam's "Verify Integrity of Game Files..." and attempt to install

Uninstallation

Note: If the game is updated, the mod will be automatically uninstalled.

• Uninstall with one of below methods:

Steam's "Verify Integrity of Game Files..." (Recommended)

• If game is running, exit it.
• Repair your game via Steam's "Verify Integrity of Game Files..." button.

Windows

Mod Auto Uninstall

• Launch uninstall.bat.
• Press Y when prompted.
• You should see a success message if the mod was previously installed.
• If game is running, exit and restart it.

Manual

Only follow these steps if you are competent with computers and file management.

• Locate file: C:\Program Files (x86)\Steam\steamapps\common\Soda Dungeon 2\SodaDungeon2_Data\Managed\Assembly-CSharp.dll
• Replace Assembly-CSharp.dll with a backup/original version. There should be a backup in the same folder if you followed the installation correctly.

If you previously used installer.bat: file named will be _BACKUP_Assembly-CSharp.dll.

• If game is running, exit and restart it.

Warning: Make sure not to confuse Assembly-CSharp.dll with Assembly-CSharp-firstpass.dll, only replace Assembly-CSharp.dll.
If you have issues or made a mistake, repair your files with Steam's "Verify Integrity of Game Files..." and it will automatically uninstall mod also.

Mac OS X

Manual

Only follow these steps if you are competent with computers and file management.
More detailed instructions in the future.

• Locate your Steam apps: Steam -> Preferences -> Downloads -> Steam Library Folders
• Show package contents: Right click SodaDungeon2 -> Show Package Contents
• Navigate to the following folder: Contents -> Resources -> Data -> Managed
• Replace file with a backup/original version. There should be a backup in the same folder if you followed the installation correctly.
• If game is running, exit and restart it.

Warning: Make sure not to confuse Assembly-CSharp.dll with Assembly-CSharp-firstpass.dll, only replace Assembly-CSharp.dll.
If you have issues or made a mistake, repair your files with Steam's "Verify Integrity of Game Files..." and it will automatically uninstall mod also.

Roadmap

See detailed tasks in roadmap...

Use Issues page to submit requests for features and bug fixes, as well as other ideas.

Versioning

See product names in version format...

Special Thanks

• Shawn Tanner for creating Soda Dungeon 2 and allowing this mod and community to thrive. Check out his fun game!
• DeathTruction for creating flexible new installer and other support behind the scenes. Check him out on Github.
• LJ for creating powerful backend for website and leaderboard API. Check him out on Discord: ElJay#7711.
• Kubis_sakti for help in creating beautiful high-quality character. Check him out on Fiverr.
• Benvictus for creating a new and improved high-quality logo/button (soda sprite). Check him out on Fiverr.
• Nikoleta Jovanovic for helping create lovely high-quality initial logo. Check out her portfolio.
• Nathaniel Hunt for the helpful business advice and strategic direction. Check him out on LinkedIn.
• Dasky for the very appreciated help, testing and support behind the scenes. Check him out on GitHub.
• Tilli for the very appreciated help and support behind the scenes. Check out the Discord server.
• XenosTec for the very appreciated help and support behind the scenes. Check out the Discord server.
• caviyacht for the very appreciated help and support behind the scenes. Check him out on GitHub.
• Etatauri for the very appreciated help with documentation and other support behind the scenes. Check her out on GitHub.
• Eric Matyas for Starter theme music. https://soundimage.org
• Soda Dungeon 2 community for all the love and support. Thank you from the bottom of my heart!

sd2-caffeine-mod's Issues

source code

Usually the source code is added to git which does all the versioning for you. That's the reason github is there at all.
It would be great if you directly add your git repo instead of attached zip folders on releases.

Add town productivity features/options - Essence fountain, etc.

Essence fountain improvements:

• Add "Remaining affordable gold" counter (based on expenses).
  • Change "Remaining affordable gold" text to red when not enough gold for expenses.
  • Show "Remaining affordable clicks" text (based on expenses), and show it as red when not enough gold for expenses.
  • "Protect spending" checkbox that:
    • On arrow click, warn user when affordable gold will be less than 0 (can't afford expenses) and prompt confirmation.
    • On "Throw In", warn user when affordable gold will be less than 0 (can't afford expenses) and prompt confirmation.
• "Afford Throw All (+5% cost)" quick essence convert button.
  • Confirm message: "Are you sure you want to convert X gold to X essence, but keep enough gold for expenses? (+5% cost)"
• Trigger arrow clicks on mouse down intervals instead of mouse up. Less clicking. Help prevent Carpal Tunnel.
• Possible option to increase tick count on arrow clicks.

Expenses formula:

var expenses = HIGHEST_FLOOR_WARP_COST;
var openPartySlots = AVAILABLE_PARTY_SLOTS;
if (openPartySlots > 0) {
    expenses += TAVERN_REFRESH;
    if (X_AVAILABLE && !X_RECRUITED) {
        expenses += X_COST;
        openPartySlots -= 1;
    }
    expenses += HIGHEST_COST_SPAWNABLE_CHARACTER * openPartySlots;
}
return expenses;

Other:

• Option to increase tick count for relic leveling.
• Move all Soda Junkies to the back of the tavern (in-front of the stools) when they aren't enabled in the book.

Options details:

• Possibly add in-game shop to purchase town-productivity options instead of a lock button.
• Or opt-in options:
  • Separate "Town Productivity" settings page with a lock icon.
  • Attempting to unlock specific page will warn the user that it affects "Town Productivity", and asks if user wants to continue.
  • If user confirms to unlock feature. The Caffeine option button will permanently turn orange instead of green. The warning will never show again on further lock changes.
  • This is not to shame users who use the feature(s), but only to credit the users who want to keep a vanilla experience.
  • Also allow users to re-lock options page. (Re-locking will not change options button back to green.)

Distribution of time spent

Is your feature request related to a problem? Please describe.
Sometimes it's hard to figure out what happened to your FPH.

Describe the solution you'd like
A pie chart showing how much of the total time is spent in each area.

• Attack, Defend, Individual spells, etc... (characters and enemies doing stuff)
• non-character related animations
• boss death
• using portals
• chest opening
  and anything else in the main game loop that takes time.

The more detailed this is the better we can do at optimizing our FPH.