Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
game-version: '1.20.1'
java: '17'
forge-loaders: "forge\nneoforge"
- branch: mc/1.21.1
- branch: main
game-version: '1.21.1'
java: '21'
runs-on: ubuntu-latest
Expand Down Expand Up @@ -187,6 +187,24 @@ jobs:

files: ${{ steps.jars.outputs.fabric_jar }}

# Keep the checked-in mod_version in sync with what was just published, so
# local/dev builds on this branch are stamped with the released version.
- name: Commit version bump
if: github.event_name == 'push' || inputs.publish
run: |
version="${{ inputs.version || github.ref_name }}"
version="${version#v}"
sed -i "s/^mod_version=.*/mod_version=${version}/" gradle.properties
if git diff --quiet gradle.properties; then
echo "mod_version already ${version}, nothing to commit"
exit 0
fi
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add gradle.properties
git commit -m "Bump mod_version to ${version}"
git push origin "HEAD:${{ matrix.branch }}"

release:
needs: build
runs-on: ubuntu-latest
Expand Down
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

### Upload
- **Automatic upload** - schematics are uploaded to [createmod.com](https://createmod.com) the moment you save them in-game
- **360° preview rendering** *(NeoForge 1.21.1+ only)* - 120 isometric frames are rendered client-side and uploaded alongside the schematic for an interactive 3D rotation view on the website
- **Preview rendering** *(NeoForge 1.21.1+ only)* - 4 isometric screenshots are rendered client-side and uploaded alongside the schematic; with [Create: Blueprinted](https://modrinth.com/mod/create-blueprinted) installed, its rendered schematic image is used instead
- **Progress bar** *(NeoForge 1.21.1+ only)* - a live progress bar on the action bar tracks rendering, processing, and uploading stages
- **One-click sharing** - a clickable link appears in chat so you (or anyone) can view the schematic in a browser
- **Claim flow** - log in on the website to claim ownership, then publish to the community
Expand All @@ -40,14 +40,14 @@ This is a **client-side only** mod. It does not need to be installed on the serv

## Supported Versions

| Branch | Minecraft | Loaders | Create | Java | 360° Viewer |
|--------|-----------|---------|--------|------|-------------|
| `main` / `mc/1.21.1` | 1.21.1 | NeoForge, Fabric | 6.0.10+ | 21 | Yes |
| Branch | Minecraft | Loaders | Create | Java | Preview Images |
|--------|-----------|---------|--------|------|----------------|
| `main` | 1.21.1 | NeoForge, Fabric | 6.0.10+ | 21 | Yes |
| `mc/1.20.1` | 1.20.1 | Forge, NeoForge, Fabric | 6.0.8+ | 17 | No |
| `mc/1.19.2` | 1.19.2 | Forge, Fabric | 0.5.1+ | 17 | No |
| `mc/1.18.2` | 1.18.2 | Forge, Fabric | 0.5.1+ | 17 | No |

> **Note:** On 1.20.1 and below, schematics are uploaded without preview images. The 360° rotation viewer and progress bar are available on NeoForge 1.21.1+ only.
> **Note:** On 1.20.1 and below, schematics are uploaded without preview images. Preview rendering and the progress bar are available on NeoForge 1.21.1+ only.

## Installation

Expand All @@ -67,13 +67,10 @@ This is a **client-side only** mod. It does not need to be installed on the serv
| `enabled` | `true` | Enable or disable the upload feature entirely |
| `autoUpload` | `true` | Upload schematics to createmod.com when saved. If `false` and local screenshot saving is enabled, only screenshots are generated |
| `baseUrl` | `https://createmod.com` | API base URL |
| `render360` | `true` | Render 360° rotation view (disable for faster uploads with only 4 featured angles) *(1.21.1+ only)* |
| `frameCount` | `120` | Number of frames in the 360° rotation view (min 4, max 720) *(1.21.1+ only)* |
| `aspectRatio` | `16:9` | Aspect ratio for rendered images (e.g. `16:9`, `4:3`, `1:1`) *(1.21.1+ only)* |
| `overrideWidth` | `0` | Override image width in pixels (0 = automatic based on schematic size) *(1.21.1+ only)* |
| `overrideHeight` | `0` | Override image height in pixels (0 = automatic based on schematic size) *(1.21.1+ only)* |
| `saveFeaturedFrames` | `false` | Save the 4 featured perspective images locally to the schematics folder *(1.21.1+ only)* |
| `saveAllFrames` | `false` | Save all rotation frames locally to the schematics folder *(1.21.1+ only)* |
| `saveFeaturedFrames` | `false` | Save the 4 perspective screenshots locally to the schematics folder *(1.21.1+ only)* |
| `imageFormat` | `jpeg` | Image format for rendered frames: `jpeg` (smaller files, recommended) or `png` (lossless) *(1.21.1+ only)* |
| `backgroundImage` | *(empty)* | Absolute path to a custom background image (JPEG or PNG). Leave empty to use the default blueprint grid. *(1.21.1+ only)* |
| `promptBeforeUpload` | `true` | Show a clickable chat prompt before uploading or generating screenshots. If `false`, proceeds automatically *(1.21.1+ only)* |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,10 @@ public class ConfigValues {
public static boolean autoUpload = true;
public static String baseUrl = "https://createmod.com";
public static String modVersion = "1.0.0";
public static boolean render360 = true;
public static int frameCount = 120;
public static String aspectRatio = "16:9";
public static int overrideWidth = 0;
public static int overrideHeight = 0;
public static boolean saveFeaturedFrames = false;
public static boolean saveAllFrames = false;
public static String imageFormat = "jpeg";
public static String backgroundImage = "";
public static boolean promptBeforeUpload = true;
Expand Down
Loading
Loading