TeraFirmaGreg Alloy Calculator

❗ This project is still a WIP ❗

📖 Table of Contents

• About
• Features
• Usage
• Contributing
• Local Setup
• Deployment
• License

🔍 About

The TerafirmaGreg Alloy Calculator is a powerful tool designed to help players calculate alloy compositions for the TeraFirmaGreg modpack. This calculator streamlines the process of determining optimal alloy ratios, saving time and resources.

✨ Features

• Inventory Based: Input what you have available, and the calculator does the rest!
• Accurate: Precise calculations based on the latest TeraFirmaGreg alloys and minerals
• Time-saving: Quickly determine the optimal alloy compositions
• No Waste: Calculated alloy composition creates no leftover metal

🛠️ Usage

1. Input desired alloy type and quantity
2. Enter your available minerals
3. View the calculated optimal composition

👥 Contributing

Contributions to the TeraFirmaGreg Alloy 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 and process for submitting pull requests.

💻 Local Setup

1. Pull the latest version of main
2. Run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

3. Open 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.

Note

Pull requests and dev (acts as a staging branch), will trigger a preview deployment.

📄 License

This project is licensed under the GNU GPL v3 license.