Skip to content

Cybernetic-Forge/QuickStocks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

473 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

โœจ Get in contact โœจ

Join Cybernetic-Forge on Discord
for support and discussions!

Join Discord

๐Ÿ“ˆ QuickStocks

The Ultimate Stock Market & Company Management Plugin for Minecraft

Transform your Minecraft server into a sophisticated economic powerhouse. QuickStocks brings Wall Street to your world with realistic market simulation, company management, and financial tradingโ€”all seamlessly integrated into Minecraft.

Version Minecraft Java License


โš ๏ธ QuickStocks is currently in BETA.

This plugin is actively being improved and may receive frequent updates.
The first released versions aim to reach full stability while polishing all core features.
Thank you for participating in the beta phase!

๐ŸŽฎ What Makes QuickStocks Special?

QuickStocks isn't just another economy pluginโ€”it's a fully-featured financial market simulator that rivals real-world trading platforms. With sophisticated algorithms, realistic market behavior, and enterprise-grade architecture, it offers an unmatched economic experience.

๐Ÿ’Ž For Players

  • ๐Ÿ“Š Trade Like a Pro - Real-time market with dynamic pricing influenced by 25+ economic factors
  • ๐Ÿข Build Business Empires - Create companies, hire employees, manage finances, and expand with plots
  • ๐Ÿ’น Launch Your IPO - Take your company public and watch players invest in your vision
  • ๐Ÿช™ Create Cryptocurrencies - Mint your own crypto (personal or company-branded)
  • ๐Ÿ“ˆ Master Investing - Build diversified portfolios, use watchlists, track performance metrics
  • ๐Ÿ’ฐ Seamless Economy - Integrated wallet system with Vault support
  • ๐Ÿ“ฑ Trade Anywhere - Open the market anywhere with /market

โš™๏ธ For Server Administrators

  • ๐Ÿš€ Plug & Play - Works out of the box with sensible defaults
  • ๐Ÿ—„๏ธ Enterprise Database - SQLite, MySQL, or PostgreSQL with automatic migrations
  • ๐Ÿ”Œ Smart Integrations - Optional Vault, ChestShop, and WorldGuard support
  • ๐ŸŽจ Beautiful GUIs - Professional interfaces with full customization
  • ๐Ÿ“Š Performance - Optimized for servers of all sizes with connection pooling
  • ๐Ÿ”ง Highly Configurable - Multi-file config system for fine-tuned control

๐ŸŒŸ Why Choose QuickStocks?

๐ŸŽฏ Realistic Market Simulation

Not just random price changesโ€”QuickStocks uses sophisticated algorithms that consider:

  • Economic indicators (inflation, interest rates, GDP, unemployment)
  • Market sentiment (fear/greed index, investor confidence)
  • Technical analysis (moving averages, support/resistance)
  • Industry trends and sector performance
  • Global events and breaking news
  • Supply/demand dynamics with slippage
  • Circuit breakers to prevent market crashes
  • Trading fees and realistic market mechanics

โœจ Core Features

๐Ÿ“Š Advanced Market Simulation

The heart of QuickStocksโ€”a sophisticated trading engine that behaves like real markets:

  • Real-time Price Updates - Every 5 seconds with realistic volatility and momentum
  • Smart Price Algorithm - 25+ market factors including:
    • Economic indicators (inflation, interest rates, GDP, unemployment)
    • Market sentiment (fear/greed index, investor confidence, media buzz)
    • Technical analysis (moving averages, support/resistance, momentum)
    • Industry trends (sector performance, commodity prices, regulations)
    • Global events (geopolitical changes, natural disasters, pandemics)
    • Random events (flash crashes, social media trends, market manipulation)
  • Circuit Breakers - Automatic trading halts during extreme movements (ยฑ10%)
  • Trading Fees & Slippage - Realistic transaction costs (0.25% default) and price impact on large orders
  • Market Analytics - Price history, trend analysis, top gainers/losers, sector performance
  • Multiple Instrument Types - Stocks, cryptocurrencies, Minecraft items, company shares, indices, funds

๐Ÿข Comprehensive Company Management

Run your business empire with professional-grade tools:

  • Company Types - PRIVATE, PUBLIC, or DAO with distinct governance models
  • Employee System - Hire players, assign roles (CEO, CFO, custom titles), manage permissions
  • Financial Operations - Shared company treasury, deposits, withdrawals, transaction history
  • Plot System - Buy and manage land plots (chunks) for your company
  • Salary System - Automated employee payments with configurable schedules
  • IPO Launch - Go public on the stock market, set share prices, manage shareholders
  • Buyout Protection - Prevent hostile takeovers with ownership safeguards
  • Invitation System - 7-day expiring invites with acceptance/decline
  • Company Settings GUI - Professional interface for all management tasks
  • ChestShop Integration - Company-owned shops with employee permissions

๐Ÿ’ฐ Cryptocurrency System

Create and trade digital assets:

  • Default Cryptocurrencies - Pre-seeded popular cryptos (Bitcoin, Ethereum, Dogecoin, etc.)
  • Personal Crypto - Create your own cryptocurrency ($500k requirement)
  • Company Crypto - Companies can mint branded tokens
  • Full Trading Support - Cryptos trade like any other instrument
  • Symbol Validation - Prevents conflicts and ensures uniqueness
  • Market Integration - Real-time prices, history, analytics

๐Ÿ’ผ Portfolio & Wallet Management

Track your wealth with precision:

  • Vault Integration - Seamless connection to economy plugins (optional)
  • Built-in Wallet - Standalone wallet system if Vault unavailable
  • Holdings Tracking - Real-time portfolio with P&L calculations
  • Performance Metrics - Total value, unrealized gains/losses, ROI percentages
  • Watchlist System - Monitor favorite instruments without buying
  • Transaction History - Complete audit trail of all trades
  • Query Service - Advanced analytics and reporting

๐Ÿ”Œ Smart Plugin Integrations

Optional but powerfulโ€”all soft dependencies with graceful degradation:

  • Vault Economy

    • Automatic detection and integration
    • Falls back to built-in wallet if unavailable
    • Dual-mode operation for maximum compatibility
  • ChestShop Integration

    • Company-owned chest shops
    • Employee-based management with permission system
    • Shop revenue/costs tied to company balance
    • Automatic transaction validation
    • Works perfectly without ChestShop installed
  • WorldGuard Integration

    • Region-based permission control
    • Custom flags: quickstocks-plots for plot purchases
    • Protection for company-owned land
    • Graceful degradation without WorldGuard

๐ŸŽจ Beautiful User Interfaces

Professional GUIs that make complex operations simple:

  • Market Browser GUI - Browse instruments, view live prices, execute trades
  • Company Settings GUI - Permission-aware management interface
  • Plot Management GUI - Visual plot editor for company lands
  • Color-Coded Displays - Green for profits, red for losses, intuitive indicators
  • Helpful Tooltips - Context-sensitive help on every item
  • Tab Completion - Smart command completion for all commands
  • Pagination Support - Handle large datasets smoothly
  • Configurable Layouts - Full customization via guis.yml

๐Ÿš€ Quick Start

๐ŸŽฎ For Players - Start Trading in Seconds

# Check your wallet balance
/wallet

# Browse the market
/market                          # Interactive GUI
/stocks                          # Top 10 gainers

# Research and track instruments
/stocks DIAMOND                  # View detailed info
/watch add DIAMOND               # Add to watchlist

# Make your first trade
/market buy DIAMOND 100          # Buy 100 shares

# View your portfolio
/market portfolio                # Holdings and P&L

# Create a company
/company create MyCorp PUBLIC    # Start your business

# Go public and trade shares
/company setsymbol MyCorp MCORP
/company market enable MyCorp

# Create cryptocurrency (requires $500k)
/crypto create MYCOIN "My Coin"
```a

### โš™๏ธ For Server Administrators - 5-Minute Setup

1. **Download** the latest QuickStocks JAR from [Releases](https://github.com/Cybernetic-Forge/QuickStocks/releases)
2. **Place** in your server's `plugins/` folder
3. **Start/Restart** your server
4. **Configure** (optional) in `plugins/QuickStocks/`
   - `config.yml` - Database, logging, feature toggles
   - `market.yml` - Trading economy, circuit breakers, analytics
   - `companies.yml` - Company types, costs, permissions
   - `guis.yml` - GUI layouts and appearance
5. **Add Dependencies** (optional):
   - Vault (for economy integration)
   - ChestShop (for company shops)
   - WorldGuard (for plot protection)
6. **Done!** Players can start trading immediately with sensible defaults

๐Ÿ“– **[Feature Documentation Index โ†’](Documentation/README.md)**

#### Default Configuration Highlights
- โœ… SQLite database (no setup required)
- โœ… Market updates every 5 seconds
- โœ… 0.25% trading fee
- โœ… $1,000 company creation cost
- โœ… Circuit breakers at ยฑ10% price movement
- โœ… All features enabled by default

---

## ๐ŸŽฏ Use Cases & Server Types

### ๐Ÿซ Educational Servers
Perfect for teaching economics and finance:
- Real-world market simulation for hands-on learning
- Company management teaches business principles
- Safe environment to learn trading without real money
- Great for economics courses and financial literacy programs

### ๐ŸŽญ Roleplay Servers
Enhance immersion with realistic economy:
- Players can roleplay as CEOs, traders, employees
- Company system supports business roleplay scenarios
- Realistic financial transactions and investments
- Plot system for company headquarters and offices

### โš”๏ธ Competition & Event Servers
Host exciting economic challenges:
- Trading competitions with leaderboards
- Company growth competitions
- "Rags to riches" challenges
- Stock market prediction games
- Economic warfare between factions

### ๐Ÿฐ Survival & Towny Servers
Add economic depth to gameplay:
- Trade Minecraft items on the market
- Town economies integrated with companies
- Player-driven market prices
- Corporate alliances and competitions

### ๐ŸŽช Mini-Game & Hub Servers
Create unique economy-focused games:
- Stock trading mini-games
- Company building challenges
- Economic simulation games
- Financial literacy challenges

---

## ๐Ÿ’ก Real-World Examples

### ๐Ÿ“ˆ Trading Stocks & Items
```bash
# Morning routine: Check the markets
/stocks                          # View top movers
/watch list                      # Check watchlist

# Research a specific item
/stocks DIAMOND                  # DIAMOND: $450.25 (+5.3%)
                                 # Volume: 15,234 | 24h Change: +$22.75
                                 # Market Cap: $68.5M

# Execute trades
/market buy DIAMOND 100 450      # Buy 100 @ max $450
/market sell DIAMOND 50          # Sell 50 at market price

# Review portfolio
/market portfolio                # Total Value: $125,432.50
                                 # Unrealized P&L: +$5,234.00 (+4.35%)

# Check transaction history
/market history                  # Last 10 trades with P&L

๐Ÿข Running a Company

# Start your business empire
/company create TechCorp PUBLIC  # Cost: $1,000

# Build your team
/company invite TechCorp Alice CFO
/company invite TechCorp Bob DEVELOPER

# Alice accepts the invitation
/company invitations             # View pending
/company accept 1                # Accept invitation #1

# Manage company finances
/company deposit TechCorp 15000  # Invest in the business
/company info TechCorp           # Balance: $15,000
                                 # Employees: 3 (CEO, CFO, DEVELOPER)

# Expand with real estate
/company plot buy TechCorp       # Buy current chunk
/company plot list TechCorp      # View owned plots

# Create custom roles
/company createjob TechCorp "Lead Engineer" MANAGE_PLOTS,DEPOSIT

# Go public on the market
/company setsymbol TechCorp TECH
/company market enable TechCorp  # IPO Launch!

# Monitor your stock
/market shareholders TECH        # See who owns shares
/stocks TECH                     # Current price and performance

# Company profits can be distributed
# Shareholders can trade TECH like any stock
/market buy TECH 500             # Buy 500 shares of TechCorp

๐Ÿ’ฐ Creating Cryptocurrency

# Personal cryptocurrency (requires $500,000 balance)
/wallet                          # Check balance: $500,000+
/crypto create MYCOIN "MyCustomCoin"
                                 # MYCOIN created successfully!
                                 # Initial supply: 1,000,000 MYCOIN

# Company cryptocurrency (requires company balance)
/company info TechCorp           # Balance: $500,000+
/crypto company TechCorp TECHCOIN "TechCorp Token"
                                 # TECHCOIN created for TechCorp!

# Trade your crypto
/stocks MYCOIN                   # View market data
/market buy MYCOIN 1000          # Buy 1000 coins
/market sell MYCOIN 500          # Sell 500 coins

# Watch it grow
/watch add MYCOIN                # Track performance
/watch add TECHCOIN

# Crypto behaves like any tradeable instrument
# Subject to market forces, fees, and slippage

๐Ÿ” Advanced Features

# Set up watchlist for portfolio tracking
/watch add DIAMOND
/watch add EMERALD
/watch add TECH
/watch list                      # Quick overview of all tracked instruments

# Open the market anywhere
/market                          # Open the market GUI directly
# Right-click device anywhere    โ†’ Opens market GUI

# Admin operations (requires permissions)
/wallet add PlayerName 10000     # Add balance
/wallet set PlayerName 50000     # Set balance
/wallet remove PlayerName 1000   # Remove balance

# Company administration
/company employees TechCorp      # List all employees
/company jobs TechCorp           # View job titles and permissions
/company kick TechCorp Bob       # Remove employee

๐Ÿค Contributing & Support

๐Ÿ› Found a Bug?

Open an issue with:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Server version, Java version, plugin version
  • Any error messages or logs

โœจ Have a Feature Request?

We love new ideas! Submit a feature request with:

  • Clear description of the feature
  • Use case and benefits
  • How it fits with existing features

๐Ÿ’ฌ Need Help?


๐Ÿ”— Quick Links

Documentation

Community & Support


โญ Star this repository if you find QuickStocks useful!

Made with โค๏ธ for the Minecraft community

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Contributors

Languages