Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 3.8 KB

README.md

File metadata and controls

80 lines (51 loc) · 3.8 KB
Raw

README

What is this repository for?

This is a server side application to support rest calls (probably from a web UI "somewhere") that will produce a starter gradle JMonkey project as a zip based on user choices.

It also contains an optional UI written in react, the styling for this is an "interesting" mix of bootstrap and the JMonkey engine website styling. So it looks in keeping with the rest of Jmonkey.org, but is a little eccentric and a lot of bootstrap stuff doesn't work properly

There is a general approach of merge fields which allow both file path segments and file content to be replaced with user data

How do I get set up?

  • You will need a java 17 JDK & IDE of your choice that supports gradle
  • Start the application by running JmeInitializerApplication
  • Go to localhost:8080 to see its UI

How do I run it in prod

Run the gradle task bootjar, that will produce a jar under build\libs. Rename the jar jmeinitializer.jar then put it whereever you want it. Then run:

java -jar -Dspring.profiles.active=prod jmeinitializer.jar

To override the fetch url pass the following -D argument

-Dlibraries.fetchUrl=https://example.com/libraries.json

Running as a docker image

A docker image can be create by (with docker installed) running

docker build -t jmeinitializer .

(Note the final ., it is not a typo, it means use the dockerfile in the current directory)

The image can then be run (forwarding the images internal port 80 to the host machines port 80) by running the following

docker run -p 80:8080 jmeinitializer

Check for vulnerabilities

To check for vulnerabilities in the libraries this application uses (which should then be upgraded) run the gradle task dependencyCheckAnalyze

How does templating work

See the folder jmetemplate, fundamentally that is what ends up in the zip, but:

  • File paths can have [IF=????]
    • If the library in the ???? is active that path is included, otherwise it isn't
    • Special cases of [IF=SINGLEPLATFORM] and [IF=MULTIPLATFORM] are also supported
    • Where a folder only has an if statement, e.g. jmetemplate/[IF=SINGLEPLATFORM]/stuff then (if it is included at all) the empty folder is eliminated, becoming jmetemplate/stuff
  • File paths are scanned for merge fields. e.g. java/[GAME_PACKAGE_FOLDER]/[GAME_NAME]
  • Text files are scanned for merge fields (see MergeField.java) and replaced with their contents. Eg. mainClassName = '[GAME_PACKAGE].[GAME_NAME]'
  • Text files can also have [IF=????] statements in them. Ended by [/IF=????]
    • E.g. [IF=JME_ANDROID]Android module :app : holds build.gradle for the android dependencies & implements the :game module, this module can hold android dependent gui.[/IF=JME_ANDROID]
    • These can be nested, and can be multiline
  • [DOT] is replaced by ".". This is supported because files starting with a . (like .gitignore) don't get into the jar, so don't get into the template

Additionally, optionally, you can end any file .jmetemplate. This has no actual function, but it is stripped from the output file name. Its purpose is to stop IDEs from trying to do error highlighting on known file types (e.g. gradle files) where the IF and merge fields make the files look to the IDE as errored

Testing templates

Gradle task templateTest will check that all the templates at least compile with sensible user options. These tests are not run as part of the build because they rely on getting the most recent versions of external libraries. So they may pass today but not tomorrow

To test the templates with android an installed android sdk is also required (another good reason for this not to be plugged into the build)

API documentation

Go to [DOMAIN]/swagger-ui.html for the api documentation. E.g. https://start.jmonkeyengine.org/swagger-ui.html

Who do I talk to?

  • Original creator: richtea