Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
viandoxdev committed Apr 13, 2024
1 parent b8af7fd commit 0e40515
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 121 deletions.
38 changes: 0 additions & 38 deletions .github/workflows/init.yml

This file was deleted.

45 changes: 5 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,8 @@
Architectury Loom based template for 1.8.9 kotlin forge mods
# SMF (temp name)

**For other templates, do check out the [other branches of this repository](https://github.com/romangraef/Forge1.8.9Template/branches/all)**
Smooth fonts (proper font rendering) for 1.8 forge

## Usage
## Credits

Check out https://moddev.nea.moe/ for a full tutorial on legacy modding.

Alternatively, read here for a basic overview on how to use this repository.

To get started, clone this repository.
In `build.gradle.kts`, replace the values of `baseGroup` and `group` with your own names.
In `settings.gradle.kts` change `rootProject.name` to your desired mod id.

The `com.example` package needs to be renamed to match the value of `baseGroup`.

If you don't want mixins (which allow for modifying vanilla code), then you can remove the references to mixins from
the `build.gradle.kts` at the lines specified with comments and the `com.example.mixin` package.

Please note that Mixins should be kept in their own package, and should exclusively be written in Java, since older versions
of Mixin don't play well with Kotlin.

This project uses [DevAuth](https://github.com/DJtheRedstoner/DevAuth) per default, so you can log in using your real
minecraft account. If you don't need that, you can remove it from the buildscript.

To run the mod you will need two JDKs, one Java 17 jdk and one Java 1.8 jdk. You can download those
from [here](https://adoptium.net/temurin/releases) (or use your own downloads).

When you import your project into IntelliJ, you need to set the gradle jvm to the Java 17 JDK in the gradle tab, and the
Project SDK to the Java 1.8 JDK. Then click on the sync button in IntelliJ, and it should create a run task
called `Minecraft Client`. If it doesn't then try relaunching your IntelliJ. **Warning for Mac users**: You might have to remove the `-XStartOnFirstThread` vm argument from your run configuration. In the future, that should be handled by the plugin, but for now you'll probably have to do that manually.

To export your project, run the `gradle build` task, and give other people the
file `build/libs/<modid>-<version>.jar`. Ignore the jars in the `build/badjars` folder. Those are intermediary jars that
are used by the build system but *do not work* in a normal forge installation.

### For those who have not an attention span

[![Youtube Tutorial](https://i.ytimg.com/vi/nWzHlomdCgc/maxresdefault.jpg)](https://www.youtube.com/watch?v=nWzHlomdCgc)

## Licensing

This template is licensed under the Unlicense (license copy present in this repository), or alternatively under [Creative Commons 1.0 Universal (CC0 1.0)](https://creativecommons.org/publicdomain/zero/1.0/), and all contributions and PR to this template are expected to follow this. This means your mod, based on this template can be licensed whatever way you want, and does not need to reference back to this template in any way.
- This is *heavily* inspired by [caxton](https://gitlab.com/Kyarei/caxton)
- The template is [nea's](https://github.com/nea89o/Forge1.8.9Template) (kotlin branch)
4 changes: 2 additions & 2 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
loom.platform=forge
org.gradle.jvmargs=-Xmx2g
baseGroup = com.example
baseGroup = dev.vndx
mcVersion = 1.8.9
modid = examplemod
modid = smf
version = 1.0.0
36 changes: 0 additions & 36 deletions make-my-own.sh

This file was deleted.

2 changes: 1 addition & 1 deletion settings.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ plugins {
}


rootProject.name = "examplemod"
rootProject.name = "smf"
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.example.init;
package dev.vndx.init;

import org.spongepowered.asm.lib.tree.ClassNode;
import org.spongepowered.asm.mixin.extensibility.IMixinConfigPlugin;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package com.example
package dev.vndx

import net.minecraft.client.Minecraft
import net.minecraft.init.Blocks
import net.minecraftforge.fml.common.Mod
import net.minecraftforge.fml.common.event.FMLInitializationEvent

@Mod(modid = "examplemod", useMetadata = true)
@Mod(modid = "smf", useMetadata = true)
class ExampleMod {
@Mod.EventHandler
fun init(event: FMLInitializationEvent) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.example.mixin;
package dev.vndx.mixin;

import net.minecraft.client.gui.GuiMainMenu;
import org.spongepowered.asm.mixin.Mixin;
Expand Down
File renamed without changes.

0 comments on commit 0e40515

Please sign in to comment.