Skip to content

chiefpansancolt/dinkum-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

207 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Dinkum Tracker

A comprehensive tracking application for your Dinkum adventures. Manage multiple playthroughs, track collections, and monitor progress all in one place - all saved locally in your browser.

Dinkum Tracker Overview

๐ŸŒŸ Features

  • Multiple Playthrough Support: Create and manage separate playthroughs for different Dinkum game saves
  • Comprehensive Collection Tracking:
    • ๐ŸŸ Fish (45+ species)
    • ๐Ÿฆ‹ Bugs (50+ species)
    • ๐Ÿฆ€ Critters (25+ species)
  • Progress Monitoring:
    • ๐Ÿ“… Calendar with events and birthdays
    • ๐Ÿ† Milestones (65+ in-game achievements)
    • ๐ŸŽ“ Skills tracking
    • ๐Ÿ“œ License progression
    • ๐Ÿ  Building construction
    • ๐Ÿ‘ซ NPC relationships
  • Complete Item Database:
    • ๐Ÿ“š Books
    • ๐Ÿ”จ Tools
    • โš”๏ธ Weapons
    • ๐ŸŽ’ Equipment
    • ๐Ÿš— Vehicles
    • ๐Ÿ‘• Clothing
    • ๐Ÿช‘ Furniture
    • ๐Ÿ“ Recipes (Cooking, Crafting, Sign Writing)
    • ๐Ÿ’Ž Resources (Minerals, Relics, Foragables, etc.)
  • Detailed Analysis:
    • ๐Ÿ“Š Dashboard with progress statistics
    • ๐Ÿงฎ Items breakdown for crafting purposes
    • ๐Ÿท๏ธ Advanced filtering and search capabilities
  • Local Storage: All data saved in your browser - no account needed
  • Data Management:
    • ๐Ÿ’พ Export/import data for backup and transfer
    • ๐Ÿ”„ Reset functionality
  • Responsive Design: Works on desktop and mobile devices
  • Dark Mode Support: Toggle between light and dark themes
  • Weight Calculator: Ability to calculate Weighted Items price

๐Ÿ”ง Technology Stack

  • Next.js 15.3.0: Modern React framework with App Router
  • React 19: Latest React features and improvements
  • TypeScript: Type-safe code development
  • Tailwind CSS 4.1.0: Utility-first styling approach
  • Flowbite-React: UI component library built on Tailwind
  • Zustand: State management for persistent UI state
  • React-Toastify: Toast notifications for user feedback
  • React-Icons: Comprehensive icon library
  • LocalStorage API: Client-side data persistence

๐Ÿ“‹ Project Structure

dinkum-tracker/
โ”œโ”€โ”€ app/                   # Next.js pages
โ”‚   โ”œโ”€โ”€ (home)/            # Home page components
โ”‚   โ”œโ”€โ”€ playthrough/       # Playthrough management
โ”‚   โ”‚   โ”œโ”€โ”€ [id]/          # Dynamic routes for each playthrough
โ”‚   โ”‚   โ”œโ”€โ”€ list/          # Playthrough listing
โ”‚   โ”‚   โ””โ”€โ”€ new/           # Create new playthrough
โ”‚   โ”œโ”€โ”€ settings/          # App settings
โ”‚   โ”œโ”€โ”€ itemsBreakdown/    # Items analysis
โ”‚   โ”œโ”€โ”€ weight-calculator/ # Weight Calculator for weighted items
โ”‚   โ””โ”€โ”€ globals.css        # Global styles
โ”œโ”€โ”€ components/            # React components
โ”‚   โ”œโ”€โ”€ playthrough/       # Playthrough-specific components
โ”‚   โ”‚   โ”œโ”€โ”€ dashboard/     # Dashboard components
โ”‚   โ”‚   โ””โ”€โ”€ ui/            # Reusable UI components for playthrough
โ”‚   โ””โ”€โ”€ layout/            # Layout components (Sidebar, Navigation)
โ”œโ”€โ”€ data/                  # Game data
โ”‚   โ”œโ”€โ”€ constants/         # App constants
โ”‚   โ””โ”€โ”€ dinkum/            # Game-specific data
โ”‚       โ”œโ”€โ”€ pedia/         # Collectible item data
โ”‚       โ””โ”€โ”€ ...            # Other game data (buildings, licenses, etc.)
โ”œโ”€โ”€ lib/                   # Utility functions
โ”‚   โ”œโ”€โ”€ localStorage.ts    # Storage operations
โ”‚   โ””โ”€โ”€ services/          # Application services
โ”œโ”€โ”€ types/                 # TypeScript type definitions
โ”‚   โ”œโ”€โ”€ app/               # Application-specific types
โ”‚   โ”œโ”€โ”€ dinkum/            # Game data types
โ”‚   โ””โ”€โ”€ ui/                # UI component types
โ””โ”€โ”€ public/                # Static assets

๐Ÿš€ Getting Started

Prerequisites

  • Node.js 22 or later
  • pnpm 10.0.0 or later (recommended) or npm/yarn

Installation

  1. Clone the repository:

    git clone https://github.com/chiefpansancolt/dinkum-tracker.git
    cd dinkum-tracker
  2. Install dependencies:

    pnpm install
    # or
    npm install
  3. Start the development server:

    pnpm dev
    # or
    npm run dev
  4. Open your browser and navigate to http://localhost:3000

๐Ÿ’พ Data Storage

This application stores all data in your browser's localStorage. This means:

  • All data is saved locally on your device
  • Data persists between browser sessions
  • Clearing browser data will remove your saved playthroughs
  • Data is not synced between devices
  • Use the export/import feature to backup or transfer your data

๐Ÿ” Usage

Managing Playthroughs

  1. Create a Playthrough: Start by creating a new playthrough with a memorable name
  2. View Dashboard: See your overall progress and statistics at a glance
  3. Navigate Features: Use the sidebar to access different tracking features

Tracking Collections

  • Fish, Bugs, and Critters: Mark items as collected and donated to the museum
  • Advanced Filtering: Filter by season, biome, time of day, or rarity
  • Search: Find specific items by name

Monitoring Progress

  • Milestones: Track achievement completion
  • Licenses: Monitor license acquisition
  • Skills: Record skill level progression
  • Buildings: Track building construction
  • NPC Relationships: Manage relationships with town NPCs

Managing Items

  • Recipes: Track unlocked cooking, crafting, and sign writing recipes
  • Equipment: Keep track of tools, weapons, equipment, and vehicles
  • Items Breakdown: Analyze resource usage and requirements

Calendar

  • Season and Day: Keep track of the current day and season in your game
  • Events: View upcoming events and birthdays
  • Planning: Plan your activities based on seasonal availability

๐Ÿ“‹ Changelog

See CHANGELOG.md for a full history of releases and changes.

๐ŸŒ Live Demo

Try Dinkum Tracker Online

๐Ÿค Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add some amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

๐Ÿ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ“ข Disclaimer

This project is not affiliated with, endorsed by, or connected to Dinkum or its creators. All game data is sourced from the Dinkum Wiki. Game images and names are used for reference purposes only.

About

A comprehensive tracking application for your Dinkum adventures. Manage multiple playthroughs, track collections, and monitor progress all in one place - all saved locally in your browser.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors

Languages