Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terminalmc/framework
A client-side multi-loader template mod with example configuration system, keybind and command registration.
https://github.com/terminalmc/framework
fabricmc minecraft neoforge
Last synced: 28 days ago
JSON representation
A client-side multi-loader template mod with example configuration system, keybind and command registration.
- Host: GitHub
- URL: https://github.com/terminalmc/framework
- Owner: TerminalMC
- License: cc0-1.0
- Created: 2024-04-19T08:36:38.000Z (8 months ago)
- Default Branch: mc1.21
- Last Pushed: 2024-11-25T03:00:39.000Z (29 days ago)
- Last Synced: 2024-11-25T03:29:49.465Z (28 days ago)
- Topics: fabricmc, minecraft, neoforge
- Language: Java
- Homepage: https://modrinth.com/mod/raDGbHBr
- Size: 462 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## Framework
A custom and relatively unstable template mod, based on [Jaredlll08's MultiLoader Template](https://github.com/jaredlll08/MultiLoader-Template).
[]()
[](https://modrinth.com/mod/raDGbHBr/versions)
[](https://fabricmc.net/)
[](https://neoforged.net/)
[](https://modrinth.com/mod/raDGbHBr)
[](https://curseforge.com/minecraft/mc-mods/tmc-framework)
[](https://github.com/TerminalMC/Framework)
### Why?
This template was created to accelerate development of new client-side mods by providing more base functionality than
the original Multiloader-Template from which it is derived.
It is not better, nor necessarily worse, than the original, it just serves a different purpose.
### Features
- Configuration UI using [Cloth Config](https://modrinth.com/mod/9s6osm5g) or [YACL](https://modrinth.com/mod/1eAoo2KR)
(both included, remove the one you don't want)
- Keybind registration
- Command registration
- GitHub, Modrinth and CurseForge publishing via GitHub actions
### Usage
This project was created and is maintained for TerminalMC use, so consider it provided as-is, without any warranty or
guarantee of support or maintenance. If you choose to use it, you do so at your own risk.
#### Changing Project Details (IntelliJ IDEA)
1. Change the root directory name
2. `SHIFT`+`F6` to rename the source package(s)
3. `SHIFT`+`F6` to rename the assets directory (`common/src/main/resources/assets/framework`)
4. Edit `rebrand.properties` with the new details
5. Run the `rebrandProject` gradle task
6. Replace the LICENSE and NOTICE files with your choice of license (optionally from `licenses`)
7. Run the `updateLicenses` gradle task
8. Update the license lines in `gradle.properties` and `README.md` accordingly
### Dependencies
- Mod dependencies must be specified in the loader-specific `build.gradle` file. APIs may be specified in the common
`build.gradle` for usage by the common subproject. If for any reason a mod dependency does not provide a `common`
version, it is usually possible to depend on the project's NeoForge version in the common `build.gradle`.
- Dependency repositories must be specified in `buildSrc/main/groovy/multiloader-common.gradle`.
- Project properties required by `resources/` files must be added to the `expandProps` map in
`multiloader-common.gradle`.
### Licenses
This project is licensed [CC0-1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/legalcode), with the
mixin classes carrying the [MPL-2.0](https://mozilla.org/MPL/2.0) header as an example of attributing a modified work
from another mod licensed MPL-2.0.
License summaries (not legal advice)
[CC0-1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/legalcode)
- No restrictions.
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
- Copyright notices must be retained.
- License file must be retained (both source and executable form).
- Modification notices must be added to modified files.
- Subject to previous points, combined or derivative works may be provided under a different license.
[LGPL-3.0-only](https://www.gnu.org/licenses/lgpl-3.0)
- Complicated, basically;
- Copyright notices and license file must be retained.
- Modification notices with modification date must be added to modified files.
- Copies or derivative works must be distributed under the same license.
- Source code must be provided when distributing copies or derivative works in executable form.
[MIT](https://mit-license.org)
- Copyright notices and permission notices must be retained in all copies or substantial portions.
[MPL-2.0](https://mozilla.org/MPL/2.0)
- Copyright notices must be retained.
- Distributions of source code (complete or partial, original or modified) must remain under the same license.
- Source code must be provided when distributing copies or combined works in executable form.
- Subject to previous points, a combined work may be distributed under a different license.
### Contact
[](https://discord.terminalmc.dev)
[](https://github.com/TerminalMC/Framework/issues)
[](https://github.com/TerminalMC/Framework/blob/HEAD/LICENSE.txt)