Skip to content

zuygui/flowupdater-json-creator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flow Updater JSON Creator : Generate JSONs compatible with Flow Updater.

TODOKey FeaturesInstallationUsageContributingLicense

TODO

  • Support other mods providers (Modrinth, etc.)
  • Add custom json targets (MCP, External Files, etc.)
  • Add compatibles version getter from ModLoader's API

If you have any suggestions, feel free to open an issue or a pull request.

Key Features

  • 📁 Generate JSON files compatible with [Flow Updater].
  • 🚀 Easy-to-use interface for creating configuration files.
  • 🔧 Customize JSON settings to match your requirements.
  • 📝 Documented code for easy integration into other projects.

Installation

Download from Releases

  1. Download the latest release from the Releases page.

Build from source

Requirements:

  1. Clone the repository:
git clone https://github.com/zuygui/flow-updater-json-creator.git
  1. Navigate to the project directory:
cd flow-updater-json-creator
  1. Build the application:
cargo build --bin flowupdater-json-creator --release

Usage

  1. Run the application:
/path/to/flow-updater-json-creator/flowupdater-json-creator
  1. Follow the on-screen instructions to generate your JSON files.

  2. Once generated, you can use the produced JSON files with the Flow Updater Java library.

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork this repository.

  2. Create a new branch:

git checkout -b feature/your-feature-name
  1. Make your changes and commit them:
git commit -am 'feat: :sparkles: implement new feature'
  1. Push to your forked repository:
git push origin feature/your-feature-name
  1. Create a pull request detailing your changes.

License

This project is licensed under the MIT License.


🤓 Happy Hacking ! - Handcrafted with 💖 by Zuygui.