Skip to content

dreyyan/fizz-up

Repository files navigation

FizzUp!

Offline Crypto Miner-Like Drink Machine Game via Java TUI

FizzUp! is a fun, text-based game developed in Java that simulates a crypto mining experience but themed around a virtual drink machine. Players "mine" drinks through an engaging Text User Interface (TUI), managing resources, upgrading equipment, and optimizing production in an offline environment. Ideal for casual gamers and developers exploring Java console applications, FizzUp! combines strategy and simulation elements to create an addictive gameplay loop.

The primary purpose of FizzUp! is to provide an entertaining, educational project that demonstrates Java programming for TUI-based games, resource management, and simulation mechanics.

FEATURES

Drink Mining Simulation – "Mine" virtual drinks by managing a drink machine with crypto-miner-like mechanics.
Resource Management – Upgrade equipment, optimize production, and balance resources for maximum output.
Text-Based Interface – Interact via a user-friendly Java TUI for commands and progress tracking.
Offline Play – No internet required; all gameplay is local and self-contained.

FUTURE IMPLEMENTATIONS

🚀 Advanced Upgrades – Introduce more complex upgrade trees and customization options.
🚀 Multi-Machine Support – Manage multiple drink machines for scaled production.
🚀 Achievements System – Add goals, rewards, and leaderboards for replayability.
🚀 Graphical Elements – Enhance TUI with ASCII art or transition to a simple GUI.

UPDATES

🔄 Core mining simulation and TUI implemented.
🔄 Basic resource management and upgrade mechanics added.
🔄 Ongoing refinements to gameplay balance and user interface.

PROJECT DETAILS

📌 Author: dreyyan
📌 Started: 2025-07-23
📌 Finished:

TECH STACK

🛠️ Language: Java
🛠️ Libraries: Standard Java libraries (no external dependencies required for core TUI)

INSTALLATION

Prerequisites

  • Java Development Kit (JDK) 8 or higher
  • Create a development environment (recommended):
    • Install JDK from Oracle or use OpenJDK.

Install Dependencies

FizzUp! uses standard Java, so no additional libraries are required. Compile and run with javac and java commands.

Verify Installation

Check Java version:

java -version

USAGE

Running the Application

Compile the source files:

javac *.java

Run the main class:

java Main  # Adjust based on actual main class name

Example Workflow

  1. Launch the Game: Run the compiled Java application to start the TUI.
  2. Start Mining: Use menu options to initiate drink mining and monitor progress.
  3. Manage Upgrades: Spend earned resources to upgrade your drink machine.
  4. Track Stats: View production rates and resource balances in real-time.

Configuration

  • No external configuration needed; settings are managed within the TUI.
  • Ensure your terminal supports the required display size for optimal viewing (if specified).

DEBUGGING

For issues, check console output for error messages related to gameplay or TUI rendering. Run with:

java Main

Report issues via GitHub Issues for detailed troubleshooting.

PROJECT STRUCTURE

  • Main.java: Entry point for the application (assumed; adjust based on actual structure).
  • Other files may include classes for game logic, TUI rendering, and simulation mechanics (not specified in provided details).

CONTRIBUTING

Contributions are welcome! Fork the repo, make changes, and submit a pull request:

  1. Create a feature branch: git checkout -b feature/new-feature
  2. Commit changes: git commit -m "Add new feature"
  3. Push: git push origin feature/new-feature
  4. Open a pull request

Report issues or suggest features via GitHub Issues.

LICENSE

This project is licensed under the MIT License. See LICENSE for details.

About

[ Offline Crypto Miner–Inspired Drink Machine Game via Java TUI ]

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors

Languages