diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 0ec1b45..fa01091 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -2,7 +2,7 @@ github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] patreon: # Replace with a single Patreon username -open_collective: # Replace with a single Open Collective username +open_collective: tebibytemedia # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry diff --git a/README.md b/README.md index d824187..a4968b1 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,27 @@ A Minecraft mod manager for the terminal. +Hopper can automatically search, download, and update Minecraft mods from https://modrinth.com/ so that keeping your mods up-to-date and compatible with each other is easy. With Hopper, you won't have to manually visit CurseForge and download each mod one-by-one every time you set up a new instance, or deal with the hassle of swapping out different mod versions for hours while trying to get Minecraft to accept them all at once. + +Hopper is still very early in development, but important features are coming along smoothly, and we'll have lots of progress to show off in the coming weeks. It's written in Rust and released under the AGPLv3. + +We're looking for people to help contribute code, design the terminal interface, write documentation, and design a logo. Please reach out to us in [our Discord server](https://discord.gg/JWRFAbve9M) if you're interested in helping out. If you have a taste in CLI-based apps like Hopper, your input is especially appreciated. + +Inspired by CLI apps like: +- [paru](https://github.com/morganamilo/paru): Feature packed AUR helper +- [topgrade](https://github.com/r-darwish/topgrade): Upgrade everything + ### Donate # High-level Goals +Continuous: +- small binary size +- minimal compile times + +Features: - modrinth mod searching - modrinth mod installation - curseforge api too? @@ -20,6 +35,7 @@ A Minecraft mod manager for the terminal. - manpage - configurable mod search result display like [Starship](https://starship.rs) - `display` command or something that displays (cached?) mod info +- parallel mod downloading Long-term/host-dependent: - conflict resolution