Skip to content

Meatwo310/custom-mdk

BranchesTags

Repository files navigation

Custom MDK

A customized Minecraft Mod Development Kit (MDK) that extends the official Forge MDK with additional features for modern mod development. Currently supports Forge for Minecraft 1.20.1.

Latest version: https://github.com/Meatwo310/custom-mdk/

✨ Features

  • 🔄 Automated build & release via GitHub Actions
  • 🧪 Pre-configured Mixin environment
  • 📛 Jar naming with version and loader info
  • 📚 Parchment mappings
  • ⚙️ Build scripts migrated to Kotlin DSL
  • 📝 Unified code style with EditorConfig
  • 📦️ Pre-configured development mods (JEI, etc.)

📖 Usage

🗂️ Setup

  1. Click the Use this template button to create a new repository.
  2. Clone the repository to your local machine.
  3. Edit the ModConfig object in build.gradle.kts.
    • MOD_ID: The internal name of your mod. Used for item/block IDs, etc.
    • MOD_NAME: The display name of your mod. Used in JEI/Jade mod list, Mod Menu, etc.
    • MOD_LICENSE: The license of your mod. Open source licenses like MIT are recommended.
    • MOD_VERSION: The version of your mod. Semantic versioning is recommended.
    • MOD_GROUP_ID: The group ID of your mod. Recommended format is io.github.<GitHub-username>.<MOD_ID>. If you own a domain, you can also use the reverse of that (e.g., meatwo310.net + examplemod → net.meatwo310.examplemod).
    • MOD_AUTHORS: The author(s) of your mod. You can specify multiple authors separated by commas.
    • MOD_DESCRIPTION: A description of your mod. Displayed in Mod Menu, etc.
  4. Move the package structure in src/main/java/ to match MOD_GROUP_ID.
  5. Rename ExampleMod.java to match MOD_ID.
  6. Rename and edit examplemod.mixins.json (both filename and contents) to match MOD_ID.
  7. Replace the LICENSE file with your preferred license. If using MIT License, change the name Meatwo310 in the LICENSE file to your own name/handle.
  8. Delete this README.md file or rename it to something like TEMPLATE-README.md.

🔨 Build

# Build the mod
./gradlew build

# Output will be in build/libs/
# Format: {mod_id}-{minecraft_version}-forge-v{mod_version}.jar

Tip

Commits pushed to GitHub are automatically built by GitHub Actions and uploaded as artifacts.

🐞 Running Development Environment

# Run client
./gradlew runClient

# Run server
./gradlew setupServer  # Agree to EULA and generate server.properties
./gradlew runServer

# Run data generation
./gradlew runData

🚀 Release

You can create a release by pushing a tag.

# Create and push a tag for version 1.20.1-forge-v0.1.0
git tag 1.20.1-forge-v0.1.0
git push origin 1.20.1-forge-v0.1.0

⚖️ License

This template is published under the MIT License. See the LICENSE file for details.

For projects generated from this template, Meatwo310 does not enforce any license. (Open source licenses are recommended!)

Warning

Don't forget to change the license name to your own!

🤝 Contributing

Don't like the template? Feel free to fork and customize it! I'll happily incorporate useful improvements 👀

Issues and pull requests are welcome!

🇯🇵日本語版

公式の Forge MDK を拡張し、モダンな Mod 開発向けの追加機能を備えたカスタマイズ版 Minecraft Mod Development Kit (MDK) です。現在は Minecraft 1.20.1 の Forge をサポートしています。

最新版: https://github.com/Meatwo310/custom-mdk/

✨ 機能

  • 🔄 GitHub Actions による自動ビルド・リリース
  • 🧪 セットアップ済み Mixin 環境
  • 📛 バージョン・ローダー付き jar 名
  • 📚 Parchment マッピング
  • ⚙️ Kotlin DSL 移行済みのビルドスクリプト
  • 📝 EditorConfig による簡易的なコードスタイル統一
  • 📦️ JEI など開発用 Mod セットアップ済み

📖 使い方

🗂️ セットアップ

  1. Use this template ボタンをクリックして、新しいリポジトリを作成します。
  2. リポジトリをローカルへクローンします。
  3. build.gradle.kts の ModConfig オブジェクトを編集します。
    • MOD_ID: Mod の内部的な名前です。アイテムやブロックの ID 等にも使用されます。
    • MOD_NAME: Mod の表示名です。 JEI/Jade の Mod 名表示や、 Mod メニュー等に使用されます。
    • MOD_LICENSE: Mod のライセンスです。 MIT などオープンソースライセンスを推奨します。
    • MOD_VERSION: Mod のバージョンです。セマンティックバージョニングを推奨します。
    • MOD_GROUP_ID: Mod のグループ ID です。 io.github.<GitHubユーザー名>.<MOD_ID> を推奨します。ドメインを所有している場合は、それを逆にしたものから始めることもできます (例: meatwo310.net + examplemod → net.meatwo310.examplemod) 。
    • MOD_AUTHORS: Mod の作者名です。コンマ区切りで複数人を指定できます。
    • MOD_DESCRIPTION: Mod の説明です。 Mod メニュー等で表示されます。
  4. src/main/java/ 内のパッケージ構造を MOD_GROUP_ID に合わせて移動します。
  5. ExampleMod.java を、 MOD_ID に合わせてリネームします。
  6. examplemod.mixins.json のファイル名・中身を、 MOD_ID に合わせてリネーム・編集します。
  7. LICENSE ファイルを好きなライセンスに差し替えます。 MIT ライセンスを使用する場合は、 LICENSE ファイルの名義 Meatwo310 を、ご自身の名前/ハンドルネーム等へ変更します。
  8. この README.md ファイルを削除するか、 TEMPLATE-README.md 等へリネームしてください。

🔨 ビルド

# Mod をビルド
./gradlew build

# 成果物は build/libs/ に生成されます
# フォーマット:  {mod_id}-{minecraft_version}-forge-v{mod_version}.jar

Tip

GitHub にプッシュされたコミットは、自動的に GitHub Actions でビルドされ、アーティファクトとしてアップロードされます。

🐞 開発環境の起動

# クライアントを実行
./gradlew runClient

# サーバーを実行
./gradlew setupServer  # EULA に同意し、 server.properties を生成
./gradlew runServer

# Data Genを実行
./gradlew runData

🚀 リリース

タグをプッシュすると、リリースを作成できます。

# バージョン 1.20.1-forge-v0.1.0 用のタグを作成し、プッシュ
git tag 1.20.1-forge-v0.1.0
git push origin 1.20.1-forge-v0.1.0

⚖️ ライセンスについて

このテンプレートは MIT ライセンスの下に公開されています。詳細は LICENSE ファイルを参照してください。

テンプレートから生成されたプロジェクトについて、 Meatwo310 はライセンスを強制しません。 (オープンソースライセンスを推奨します！)

Warning

ライセンスの名義をご自身の名前へ変更することを忘れないでください！

🤝 貢献

テンプレートが気に入りませんか？ ぜひフォークし、カスタムしてお使いください！ 有用な改善点は勝手に取り込みます 👀

イシュー・プルリクエストも歓迎です！

About

Customized MDK that supports workflows, mixins and versioned jar names. Currently supports 1.20.1 Forge.

Resources

Readme

License

MIT license
Activity

Stars

2 stars

Watchers

0 watching

Forks

1 fork
Report repository

Contributors

Languages