GithubHelp home page GithubHelp logo

geometrically / voodoo Goto Github PK

View Code? Open in Web Editor NEW

This project forked from daemoniclabs/voodoo

0.0 1.0 0.0 16.51 MB

Modpack building magic. Maintained by Nikky.

License: MIT License

Kotlin 97.71% Shell 0.44% Java 1.86%

voodoo's Introduction

Discord Jenkins GitHub issues Patreon

About

Creating Modpacks with Voodoo requires minimal effort, just create one .voodoo.json or .voodoo.kts definition per modpack

You can Test Any pack in MultiMC, creating a instance and launching it is completely automated, no more clicking than necessary

Modern Minecraft versions (1.6.+), Forge and Fabric are supported

packages to custom (TODO: add link and readme) Pack Format

No Rehosting of Mods! completely automated by preparing .url.txt files pointing to the original file location

Reproducability: with a modpacks lockfile and src folder you can reproduce the modpack on any platform, server install or local testing (assuming that the urls do not get taken down or redirect anywhere else)

Minimalistic Packs: on all platforms that support it (currently only the multimc-wrapper) mods will be downloaded by the user from the original location,

Is Voodoo for you?

Want to make a modpack ? quickly test locally and then make it available on multiple platforms for users ?

voodoo is a set of tools to quickly prepare, build, test and deploy modpacks to users and servers

Voodoo might be for you if:

✔️ You want a fast and mostly automated process
✔️ You want to be able to update the modpack whenever you want
✔️ You don't want to depend on anyone else

or

✔️ You already use SKCraft Launcher

Cons

It may not be for you if:

🔸 You do not feel comfortable using a shell
🔸 You do not feel comfortable using a IDE or text editor with syntax highlighting
🔸 You don't have a website or place for people to download files from and do not want to publish files to curse
🔸 You don't want anything to do with distributing the launcher or pack

This applies to different modules of voodoo individually.. without a place to host files you can still export a pack and upload it to curse, it will just be a much slower process due to approval and waiting time

Wiki

https://daemoniclabs.github.io/Voodoo

Downloads

you can grab binaries from the releases: https://github.com/DaemonicLabs/Voodoo/releases

Usage examples

# generate json schema for autocompletion
java -jar voodoo.jar generateSchema

# create a new pack
java -jar voodoo.jar create pack --id newPack --mcVersion 1.16.2

# builds a pack
java -jar voodoo.jar build --id mypack

# packages for upload
java -jar voodoo.jar package --id mypack -p voodoo -p mmc-voodoo -p curse

# launches pack in multimc
java -jar voodoo.jar launch multimc --id mypack

bash, zsh and fish Autocomplete

the autocompletions should be regenerated manually on voodoo update

# creating a alias
alias voodoo='java -jar voodoo.jar'

# generating autocompletion for bash
_VOODOO_COMPLETE=bash voodoo > ~/voodoo-completion.sh
source ~/voodoo-completion.sh

# generating autocompletion for zsh
_VOODOO_COMPLETE=zsh voodoo > ~/voodoo-completion.sh

# generating autocompletion for fish
_VOODOO_COMPLETE=fish voodoo > ~/.config/fish/voodoo-completion.fish

if you use a different alias then use the correct environment variable to generate completions the rules are

  • command capitalized
  • - replaced with _
  • prefixed with _
  • suffixed with _COMPLETE

eg invoke-voodoo would be _INVOKE_VOODOO_COMPLETE

Developing

Developer Guide

Support

Feel welcome to post ideas and suggestions to our tracker.

contact me directly in chat Discord
or on irc #unascribed @ irc.esper.net

How to contribute?

buy me a drink: Patreon

voodoo's People

Contributors

alexbobp avatar nikkyai avatar

Watchers

 avatar

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.