https://github.com/tmodloader/mod-skeleton-generator
An app made in Kotlin that can generate a mod skeleton for tModLoader
https://github.com/tmodloader/mod-skeleton-generator
java kotlin rxjava tmodloader
Last synced: 11 months ago
JSON representation
An app made in Kotlin that can generate a mod skeleton for tModLoader
- Host: GitHub
- URL: https://github.com/tmodloader/mod-skeleton-generator
- Owner: tModLoader
- License: gpl-3.0
- Created: 2019-01-05T17:48:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-18T10:04:50.000Z (almost 7 years ago)
- Last Synced: 2025-06-20T07:42:43.351Z (11 months ago)
- Topics: java, kotlin, rxjava, tmodloader
- Language: Kotlin
- Size: 44.9 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introductory
The mod skeleton generator is an app made in Kotlin that can generate a mod skeleton
(for [tModLoader mods](https://tmodloader.net/)) in a given path.
# PLEASE NOTE: The mod skeleton generator is now embedded in the client (versions 0.11 and up), which can be found in the mod sources menu. It is recommended to use this feature instead of this app.
# Java is required
Kotlin compiles to java bytecode. You will need [Java](https://www.java.com/en/download/) installed to run the application.
The application looks something like this:
Fill in all the fields, then press the "Generate mod" button to generate the skeleton.
The rules are that you should not use any special characters for the mod name.
The build ignore is optional.
The application will remember the path you set (using the [Java Preferences API](https://docs.oracle.com/javase/8/docs/technotes/guides/preferences/index.html)),
for easier future use to generate new skeletons. The 'Reset cache' button will make the application forget this location.
# Technologies used
[Kotlin](https://kotlinlang.org/) (The programming language used),
[RxJava](https://github.com/ReactiveX/RxJava) (Reactive streams),
[RxKotlin](https://github.com/ReactiveX/RxKotlin) (Adds RxJava bindings for Kotlin),
[Gradle](https://gradle.org/) (Dependency management),
[Spring Boot](https://spring.io/) (Micro Service framework for easy MVC flow)
The app makes good use of the [TornadoFX](https://github.com/edvin/tornadofx) project.
It is a framework based off of the original [JavaFX](https://openjfx.io/) (but in this case for Kotlin) which is used to create GUIs in Java applications.
# License
The license for this application is the GNU GPLv3 license.
You are free to make derivative works, but you'll have to disclose the source, use the same license and provide a copyright notice.
# Credits
Thanks to Trivaxy for the initial work on the application.
© tModLoader Team - 2019