Skip to content

Commit

Permalink
Updated to Quilt
Browse files Browse the repository at this point in the history
  • Loading branch information
LudoCrypt committed Sep 7, 2022
1 parent f5fa27c commit bbd1b06
Show file tree
Hide file tree
Showing 24 changed files with 240 additions and 415 deletions.
34 changes: 34 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
tab_width = 4
trim_trailing_whitespace = true

[*.gradle]
indent_style = tab

[*.java]
indent_style = tab

[*.json]
indent_style = space
indent_size = 2

[quilt.mod.json]
indent_style = tab
tab_width = 2

[*.toml]
indent_style = tab
tab_width = 2

[*.properties]
indent_style = space
indent_size = 2

[.editorconfig]
indent_style = space
indent_size = 4
6 changes: 0 additions & 6 deletions .gitattributes

This file was deleted.

47 changes: 0 additions & 47 deletions .github/workflows/build.yml

This file was deleted.

47 changes: 0 additions & 47 deletions .github/workflows/publish.yml

This file was deleted.

39 changes: 26 additions & 13 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,30 @@
bin
# Gradle
.gradle/
build/
out/
classes/

# Quilt Loom
run/

# Eclipse
*.launch
.settings
.metadata
.classpath
.project
out

# IntelliJ Idea
.idea/
*.iml
*.ipr
*.iws
*.iml
.idea
build
.gradle
eclipse
run
logs

# Visual Studio Code
.settings/
.vscode/
bin/
.classpath
.project

# Eclipse JDT LS
workspace/

# macOS
*.DS_Store
File renamed without changes.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# Elytra Bounce
Lets you bounce with an Elytra!
# Quilt Template Mod

The official Quilt template Mod. You can use it as a template for your own mods!

## Usage

In order to use this mod as a template:

1. Create a new repository from this template with `Use this template`
2. Clone the recently-created repo on your PC
3. Make the necessary changes in order to make it yours:
- Update `gradle.properties` in order to use your Maven group and mod ID
- If you don't know which Maven group to use, and you are planning to host the mod's source code on GitHub, use `io.github.<Your_Username_Here>`
- Update `quilt.mod.json` in order to reflect your mod's metadata
- If you are planning to include (jar-in-jar) a mod, don't forget to declare its dependency on it!
- The icon provided here is a placeholder one. If you aren't able to replace it yet, you can delete it and remove the "icon" property
- Create a LICENSE file for this mod! If you don't know which license to use, check out [here](https://choosealicense.com/).
- If you use `LICENSE.md`, don't forget to update the buildscript in order to use that file name!
- In `quilt.mod.json`, don't forget to put the license's [SPDX identifier](https://spdx.org/licenses/) under the `"license"` property in `"metadata"`.
- The GPLv3 and AGPLv3 are not valid mod licenses, so you can use almost any license except for those.
- Update the Java sub-directory structure so it reflects your Maven group
- If the dependencies on `gradle/libs.versions.toml` isn't up-to-date, feel free to update them! The [linked utility](https://lambdaurora.dev/tools/import_quilt.html) should help you in this easy and quick process.
4. The mod is now ready to be worked on!

## License

This template on the QuiltMC GitHub is licensed under the [Creative Common Zero v1.0 license](./LICENSE-TEMPLATE.md).

Mods created with this template are not automatically licensed under the CC0, and are not required to give any kind of credit back to QuiltMC for this template.
Loading

0 comments on commit bbd1b06

Please sign in to comment.