Skip to content

Commit

Permalink
Expose the template generator via a REST api
Browse files Browse the repository at this point in the history
  • Loading branch information
modmuss50 committed Apr 4, 2024
1 parent 7186ade commit 36f1931
Show file tree
Hide file tree
Showing 11 changed files with 3,552 additions and 0 deletions.
12 changes: 12 additions & 0 deletions template-api/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# http://editorconfig.org
root = true

[*]
indent_style = tab
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.yml]
indent_style = space
172 changes: 172 additions & 0 deletions template-api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
\*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
\*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

\*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

\*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.cache
.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

.cache/

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp
.cache

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.\*

# wrangler project

.dev.vars
.wrangler/
6 changes: 6 additions & 0 deletions template-api/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"printWidth": 140,
"singleQuote": true,
"semi": true,
"useTabs": true
}
71 changes: 71 additions & 0 deletions template-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Fabric template generator API

TBD: Host on cloudflare workers?

## POST /v1/generate
Returns a zip file containing the generated mod template zip

### Request:

```json
{
"minecraftVersion": "1.20.4", // Optional, defaults to the latest stable version
"modName": "Example Mod", // Optional, defaults to "Example Mod"
"modId": "example_mod", // Optional, defaults to being generated from the mod name
"packageName": "com.example", // Optional, defaults to being generated from the mod id
"options": { // Optional
"kotlin": false, // All sub keys are optional
"dataGeneration": false,
"splitSources": true
}
}
```

### Response (200):

A zip file containing the generated mod. The `Content-Disposition` header will be set with the intended filename e.g:

`Content-Disposition: attachment; filename="example-mod-1.20.4.zip"`

### Response (400):

An human reasonable error message, e.g "Invalid package name"

```json
{
"error": 400,
"message": "A message that can be shown to the user",
"field": "packageName" // An optional field to indicate what input was incorrect.
}
```

Example field names:
- `minecraftVersion`
- `modName`
- `packageName`
- `options.kotlin`
- `options.dataGeneration`
- `options.splitSources`

You should gracefully handle unknown field names.

## GET /v1/minecraftVersions
Returns a list of the supported Minecraft versions, older snapshots arent supported.

### Response (200):
```json
{
"versions": [
"24w13a": {
"stable": false
},
"1.20.4": {
"stable": true
},
"1.20.3": {
"stable": true
},
// And others
]
}
```
Loading

0 comments on commit 36f1931

Please sign in to comment.