https://github.com/zuygui/flowupdater-json-creator
Create JSON file compatibles with Flow Updater from command line.
https://github.com/zuygui/flowupdater-json-creator
cli command-line-tool curseforge curseforge-api flowupdater minecraft minecraft-mod mods
Last synced: about 1 year ago
JSON representation
Create JSON file compatibles with Flow Updater from command line.
- Host: GitHub
- URL: https://github.com/zuygui/flowupdater-json-creator
- Owner: zuygui
- License: mit
- Created: 2023-05-21T09:30:56.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-31T11:52:09.000Z (about 2 years ago)
- Last Synced: 2025-04-12T17:59:52.967Z (about 1 year ago)
- Topics: cli, command-line-tool, curseforge, curseforge-api, flowupdater, minecraft, minecraft-mod, mods
- Language: Rust
- Homepage: https://zuygui.is-a.dev/blogs/introducing-flowupdater-json-creator/
- Size: 140 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Flow Updater JSON Creator : Generate JSONs compatible with Flow Updater.
TODO •
Key Features •
Installation •
Usage •
Contributing •
License
## 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](https://github.com/zuygui/flowupdater-json-creator/releases) page.
### Build from source
Requirements:
- [Rust](https://www.rust-lang.org/tools/install)
1. Clone the repository:
```bash
git clone https://github.com/zuygui/flow-updater-json-creator.git
```
2. Navigate to the project directory:
```bash
cd flow-updater-json-creator
```
3. Build the application:
```bash
cargo build --bin flowupdater-json-creator --release
```
## Usage
1. Run the application:
```bash
/path/to/flow-updater-json-creator/flowupdater-json-creator
```
2. Follow the on-screen instructions to generate your JSON files.
3. 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:
```bash
git checkout -b feature/your-feature-name
```
3. Make your changes and commit them:
```bash
git commit -am 'feat: :sparkles: implement new feature'
```
4. Push to your forked repository:
```bash
git push origin feature/your-feature-name
```
5. Create a pull request detailing your changes.
## License
This project is licensed under the [MIT License](./LICENSE).
---
🤓 Happy Hacking ! - Handcrafted with 💖 by [Zuygui](https://github.com/zuygui).