FTB Tool

A simple CLI tool for searching for and downloading Feed the Beast modpacks.

Table of Contents

• FTB Tool
  • Contributing
    • Setup
    • Code Styling
    • Testing
  • Building Standalone Binaries
  • License

Contributing

This project accepts outside contributions. Please see the following sections for information about how to get setup for contributing.

Setup

Getting setup to develop is fairly straight forward. Follow these steps:

1. Run npm install to install required dependencies.

That's about it! To run the tool locally simply use:

npm run dev -- <ARGS>

Code Styling

This project uses a combination of Husky, ESLint, and Prettier for code styling. To run ESLint you can use:

npm run lint

To automatically fix any lint issues that can be fixed you can run:

npm run lint:fix

This project is configured with a pre-commit hook to run the linting tool and abort a Git commit if it finds issues. You can bypass this with the --no-verify flag:

git commit --no-verify

Please do not use this unless you only changed non-linted files and there was already a linting error in the codebase.

All pull requests should not fail linting. The linting rules can be changed with discussion.

Testing

To run unit tests use:

npm test

All existing tests should pass before you submit a pull request.

Building Standalone Binaries

This project uses @yao-pkg/pkg to create standalone binaries for use on various operating systems.

To create a standalone binary for your current operating system:

npm run build:standalone

To create a standalone binary for your all supported operating systems:

npm run build:standalone:all

The final binaries will be placed in the dist folder, suffixed with the operating system they are destined for.

License

Copyright (c) 2023 G'lek Tarssza

Licensed under the MIT License.

See LICENSE.md for the full license.