https://github.com/supermarcel10/tfccalculator

A publicly available metal calculator for TerraFirmaCraft based Modpacks
https://github.com/supermarcel10/tfccalculator

minecraft terrafirmagreg tool

Last synced: 9 months ago
JSON representation

A publicly available metal calculator for TerraFirmaCraft based Modpacks

• Host: GitHub
• URL: https://github.com/supermarcel10/tfccalculator
• Owner: Supermarcel10
• License: agpl-3.0
• Created: 2024-09-10T18:17:00.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-29T14:07:16.000Z (over 1 year ago)
• Last Synced: 2024-12-29T15:19:15.654Z (over 1 year ago)
• Topics: minecraft, terrafirmagreg, tool
• Language: TypeScript
• Homepage: https://tfc-calculator.devmarcel.net
• Size: 672 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: .github/README.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
![Maintainability Badge](https://sonarcloud.io/api/project_badges/measure?project=TFGCalculator&metric=sqale_rating)

![Reliability Badge](https://sonarcloud.io/api/project_badges/measure?project=TFGCalculator&metric=reliability_rating)

![Bug Badge](https://sonarcloud.io/api/project_badges/measure?project=TFGCalculator&metric=bugs)

![Tech Debt Badge](https://sonarcloud.io/api/project_badges/measure?project=TFGCalculator&metric=sqale_index)

# TerraFirmaCraft Metal Calculator

## Project is available at:
https://tfc-calculator.devmarcel.net/

## 📖 Table of Contents

- [About](#-about)

- [Support](#-support)

- [Features](#-features)

- [Usage](#%EF%B8%8F-usage)

- [Contributing](#-contributing)

- [Local Setup](#-local-setup)

- [Deployment](#-deployment)

- [License](#-license)

## 🔍 About

The TerraFirmaCraft Metal Calculator is a powerful tool designed to help players calculate metal compositions for the TerraFirmaCraft modpack.

This calculator streamlines the process of determining optimal metal ratios, saving time and resources.

## ⚙️ Support

At present the calculator supports:

- **TerraFirmaGreg 1.20.x** - Up to date with version 0.10.5

- **TerraFirmaCraft 1.20.1** - Up to date with version 3.2.12

**Further support for TerraFirmaGreg 1.12.x and custom import/export is planned for future releases!**

## ✨ Features

- **Inventory Based**: Input what you have available, and the calculator does the rest!

- **Accurate**: Precise calculations based on the latest TerraFirmaCraft metals and minerals

- **Time-saving**: Quickly determine the optimal metal compositions

- **No Waste**: Calculated metal composition creates no leftover metal

## 🛠️ Usage

1. Input desired metal type and quantity

2. Enter your available minerals

3. View the calculated optimal composition

## 👥 Contributing

Contributions to the TerraFirmaCraft Metal Calculator are more than welcome!

Here's how you can help:

1. Fork the repository

2. Open your IDE of choice

3. Commit and push your changes to your forked branch

4. Open a Pull Request targeting `dev` branch

5. Fill out important information

Please read and respect the [code of conduct](?tab=coc-ov-file) and process for submitting pull requests.

## 💻 Local Setup

1. Pull the latest version of `main`

2. Ensure that Next.js is installed. If not, install using `npm install next react react-dom`

3. Run the development server:

```bash

npm run dev

# or

yarn dev

# or

pnpm dev

# or

bun dev

```

3. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result

## 🚀 Deployment

This project is set up for automatic deployment on Vercel.

> [!CAUTION]

> Every push to the `main` branch will trigger a new production deployment.

## 📄 License

This project is licensed under the [GNU GPL v3](/LICENSE) license.