TechnicFlux by Zandercraft
A feature-rich and easy-to-use implementation of Technic's Solder API using Node.js.
Explore the Docs
.
Report Bug
.
Request Feature
Table Of Contents
About The Project
TechnicFlux is a feature-rich and easy-to-use implementation of the TechnicSolder API including a modern, interactive dashboard.
What is TechnicSolder?
TechnicSolder is an API that sits between a modpack repository and the Technic Launcher. It allows you to easily manage multiple modpacks in one single location.
Using Solder also means your packs will download each mod individually. This means the launcher can check MD5's against each version of a mod and if it hasn't changed, use the cached version of the mod instead. What does this mean? Small incremental updates to your modpack doesn't mean re-downloading the whole thing every time!
Solder also interfaces with the Technic Platform using an API key you can generate through your account there. When Solder has this key it can directly interact with your Platform account. When creating new modpacks you will be able to import any packs you have registered in your Solder install. It will also create detailed mod lists on your Platform page! (assuming you have the respective data filled out in Solder)
Source: TechnicPack/TechnicSolder
How does TechnicFlux compare with TechnicSolder?
| Feature | TechnicFlux | TheGameSpider/TechnicSolder | Vanilla TechnicSolder |
|---|---|---|---|
| Multiple Accounts | ✅ | ✅ | ❌ |
| Web-based Mod Management | ✅ | ✅ | ⚠️ (Limited)* |
| Web-based Mod Upload | ✅ | ✅ | ❌ |
| Fabric Modloader Support | ✅ | ✅ | ⚠️ (Limited)** |
| Quilt Modloader Support | ✅ | ⚠️ (Limited)** | ⚠️ (Limited)** |
| NeoForge Modloader Support* | ✅ | ⚠️ (Limited)** | ⚠️ (Limited)** |
| *Requires manual zip file construction and an FTP connection to package and upload mods. | |||
| **Supported by manual zip construction, but not automatic fetch within the web interface. |
Built With
TechnicFlux is built using:
Getting Started
To get a local copy up and running follow these simple example steps.
Prerequisites
You will need the following software to get started:
Installation
- Clone the repo
git clone https://github.com/Zandercraft/TechnicFlux.git
- Install the project dependencies
npm install
- Copy and rename the example configuration file
cp ./.env.example ./.env
-
Create a MongoDB database for TechnicFlux to use.
-
Change the values within your .env file to your desired configuration.
-
Run the server
npm start
Usage
Here are some examples of how you can use TechnicFlux:
(examples)
For more examples, please refer to the Documentation
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.
Creating A Pull Request
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt for more information.
Authors
- Zander - (ZandercraftGames) - Project Developer
Extra Thanks
A special thanks to TheGameSpider and his TechnicSolder implementation for providing an easier way for me to hop into the Minecraft modpack scene. Your enthusiasm for developing it and your kindness toward your community really inspired me and showed me what OSS development was all about.
We are not affiliated with Mojang, AB or Syndicate LLC.