Giter Club home page Giter Club logo

thunderstorenodejsmodmanager's Introduction

Thunderstore Nodejs Mod Manager

Thunderstore Nodejs Mod Manager is a command-line tool that makes it easy to download and manage mods for your favorite games from Thunderstore, a popular mod hosting website.

Table of Contents

Features

  • Install mods from Thunderstore with a single command
  • Update installed mods to the latest version
  • Remove installed mods
  • Create and manage modpacks
  • Start the mod manager with a menu-driven interface

Installation

  1. Clone the repository:
git clone https://github.com/DooDesch/ThunderstoreNodejsModManager.git
  1. Install dependencies:
npm install
  1. Create a .env file based on the .env-example file, and modify the values as needed.

Usage

Thunderstore Nodejs Mod Manager can be run with the following command:

node index [command] [options]

For a list of available commands, run:

node index --help

Here are some examples of how to use the tool:

  • Install a mod: node index install mod-name [download = true]
  • Update all or a specific mod: node index update [mod-name] [download = true]
  • Remove a mod: node index remove mod-name
  • Create a manifest file: node index create:manifest
  • Update the modpack: node index update:modpack
  • Create a modpack: node index create:modpack:zip [updateManifest = true]
  • Start the mod manager with interactive prompts: node index start

When you start the mod manager with the start command, you will be prompted with a list of questions to guide you through the process of installing, updating, or removing mods, creating a manifest file, or creating a modpack.

Configuration

The .env file contains several configuration options that you can customize to fit your needs. Here are the available options:

  • MOD_INSTALL_PATH: The path where the downloaded mods will be installed. Defaults to "./config/plugins".
  • MAX_DOWNLOAD_RETRY_COUNT: The number of times to retry downloading a mod before giving up. Defaults to 20.
  • GAME: The name of the game for which you want to download mods. Defaults to "Valheim".
  • MODPACK_FOLDER: The folder where the modpack files are located. Defaults to "./modpack".
  • MODPACK_DIST_FOLDER: The folder where the modpack zip file will be located. Defaults to "./dist".
  • MANIFEST_FILE_NAME: The name of the manifest file for the modpack. Defaults to "manifest.json".

Contributing

Contributions to this project are welcome! To contribute:

  1. Fork the repository
  2. Create a new branch: git checkout -b my-new-feature
  3. Make changes and commit them: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

License

Thunderstore Nodejs Mod Manager is licensed under the MIT License. See LICENSE for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.