Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 3.79 KB

README.md

File metadata and controls

42 lines (35 loc) · 3.79 KB
Raw

What's this?

This is an OpenSource project for ServerJars that will be in charge of building every single jar available in our site.

How does it work?!?

Magic ✨...
Actually it's just a bunch of Kotlin code (don't tell anyone, but I think I'm in love with Kotlin... but don't tell Swift!!).
You're free to check out our code! But if you use it, make sure to take a look at our license!

But how does it actually work?! Well, it's pretty simple, we have a model 'SoftwareBuilder', which is implemented by our different services, like the PaperService, or PurpurService, then the system goes through all the services (or just the ones you specified to build) and asynchronously builds them, then it uploads them to the storage service.

How can I help?

Feel free to clone this repo and make some changes, then open a PR and done! Someone from the team will check it out, and if it meets our ✨High standards✨ (actually, it just needs to work and be pretty 😜) we'll merge it!

How can I run it?

You can run it locally, but you'll need to have Docker installed and running.
Then, just run ./gradlew run and it should work! I hope so... Hmm, it seems it prints just a help page, welp, I guess if you're reading this... you can also READ THE HELP PAGE! Sorry for screaming, I just put a lot of work in that help page, actually, it was GitHub Copilot (thanks copilot)

How do I compile it?

Just run ./gradlew shadowJar and it should just export a jar file to build/libs/ServerJars.jar.
Then you can run it with java -jar ServerJars.jar and it should work! Probably, if not, your computer will explode in 5..4..3..2..1...💥... Hmm, didn't work; I guess it just runs the jar file 😅

How do I configure my .env?

It's easy, here's a table with all the variables you can use, and their description:

Variable Description Default value
STORAGE_TYPE The storage where the jars will be stored. If you use local, a local folder will be used. If you use s3 the S3 settings will be used local
S3_ACCESS_KEY The S3 access key, only used if DISK is set to cloud -
S3_SECRET_KEY The S3 secret key, only used if DISK is set to cloud -
S3_BUCKET The S3 bucket, only used if DISK is set to cloud -
S3_REGION The S3 region, only used if DISK is set to cloud -
S3_ENDPOINT The S3 endpoint, only used if DISK is set to cloud -
SERVERJARS_FOLDER The folder where the jars will be stored. serverjars
NO_INPUT If this is set to true, the system will not ask for any user input, and will just use the terminal properties. false
NO_CACHE If this is set to true, the system will not use any cache. false