Add a script to automate the setup of a new mod #135

New Issue

2021-10-25T13:21:11Z

Jummit commented

2021-10-25 13:21:11 +00:00

(Migrated from github.com)

Many languages/tools have setup utilities, for example npm init, cargo init etc. Creating a new fabric mod can be tedious, as the number of files to rename or change is very large. Myself and others have created scripts to automate this process. Running it could look like this:

> ./mod-init.py
Enter mod info, ^C to quit.
Mod Name: Better Potions
Mod Id (betterpotions): 
Mod Description: Improves potions.
Author: Jummit
License (CC0-1.0): MIT
Website: 
Java Package (com.jummit.betterpotions):

I think it would be useful to a lot of people to provide a script like this alongside the example mod, which can be run to quickly get up and running.

Many languages/tools have setup utilities, for example `npm init`, `cargo init` etc. Creating a new fabric mod can be tedious, as the number of files to rename or change is very large. [Myself](https://gist.github.com/Jummit/f1ef6b0a9ec037b0cc4a0a7ea8d799cc) and others have created scripts to automate this process. Running it could look like this: ```yaml > ./mod-init.py Enter mod info, ^C to quit. Mod Name: Better Potions Mod Id (betterpotions): Mod Description: Improves potions. Author: Jummit License (CC0-1.0): MIT Website: Java Package (com.jummit.betterpotions): ``` I think it would be useful to a lot of people to provide a script like this alongside the example mod, which can be run to quickly get up and running.

unixquuw commented

2021-10-29 10:59:33 +00:00

(Migrated from github.com)

Well @Jummit, you should take a look on this.

Well @Jummit, you should take a look on [this.](https://github.com/ExtraCrafTX/GeneratorFabricMod)

Jummit commented

2021-10-29 11:02:47 +00:00

(Migrated from github.com)

Well @Jummit, you should take a look on this.

I have written my own script, so I'm not searching for one. I opened this issue to discuss shipping an official script with the example mod.

> Well @Jummit, you should take a look on [this.](https://github.com/ExtraCrafTX/GeneratorFabricMod) I have written my own script, so I'm not searching for one. I opened this issue to discuss shipping an official script with the example mod.

👍 1

modmuss50 commented

2021-10-29 11:41:38 +00:00

(Migrated from github.com)

I think the best solution is a website that provides a set of options, and then offers a zip download of a project.

Take a look at https://www.lwjgl.org/customize as an example of this.

There would be massive scope for options, such as gradle script lanuage (groovy/kotlin). Additonal language adapters such as kotlin. Checkbox to include stuff such as github actions workflows. It could possibly offer the dev with some help to explain some of the more complex options and help them decide if the need it or not.

I think the best solution is a website that provides a set of options, and then offers a zip download of a project. Take a look at https://www.lwjgl.org/customize as an example of this. There would be massive scope for options, such as gradle script lanuage (groovy/kotlin). Additonal language adapters such as kotlin. Checkbox to include stuff such as github actions workflows. It could possibly offer the dev with some help to explain some of the more complex options and help them decide if the need it or not.

👍 2

Sign in to join this conversation.