add scripts for automated export of `.ajmodel` files #64

aidant19 · 2024-01-10T20:22:37Z

Summary

This PR addresses #8 and adds three files:

bb-cli.js
ajexport.js
config.json

The bb-cli.js script must be loaded from file as a plugin within Blockbench and can then be used to execute scripts from the command line. Usage is as follows:

blockbench.exe --bb-cli {path_to_script}

NOTE: Since the scripts are executed from the Blockbench directory, the script must either be moved to the BB directory or a full path must be provided.

The ajexport.js script is a script that automatically exports .ajmodel files indicated by a directory with the config.json file. The config file is also used to provide the target data pack and resource pack files, as well as locate the assets necessary for Animated Java / Blockbench export. These currently must be changed manually.

NOTE: Currently, the ajexport.js script requires a modified version of Animated Java that exposes the safeExportProject() function to the AJ API. A repository containing such a modification can be found here:

https://github.com/aidant19/animated-java

Test plan

Not currently planned at this stage.

Reproducing in-game

N/A

Preview

Supplemental changes

fix json prettier rules config
enable linting rules for eslint (object-shorthand and prefer-const)
supplement readme with automated export instructions
add blockbench and ajexport paths to package-scripts.js
add yarn start export script
delete mouth model

TheAfroOfDoom

lotta stuff as a start, mostly small things and pretty easy though.

have more stuff in the pipeline, but just focus on these for now

.editorconfig

omega-flowey.code-workspace

scripts/ajexport.js

scripts/bb-cli.js

scripts/config.json

aidant19 · 2024-01-11T20:49:02Z

Requested changes made to PR. Does not significantly alter functionality, but significant improvements made to formatting consistency, readability, and code integrity.

Of note:

ajexport.js now exports its main code as an async function and is able to await each export. bb-cli is now able to properly await its conclusion and then exit.
scripts now exist in package-scripts/modules

New supplemental change:
eslint enforces const requirement

TheAfroOfDoom

a few more small things relating to the code quality/style.

let's also add to the README.md setup section how to configure e.g. config.json, load the bb-cli plugin into Blockbench, and run the script.

can we also add labels to the new tickets? #65 and #66

they're both devops and enhancement imo

package-scripts/modules/ajexport.js

scripts/ajexport.js

package-scripts/modules/ajexport.js

package-scripts/modules/config.json

package-scripts/modules/bb-cli.js

package-scripts/modules/ajexport.js

TheAfroOfDoom

added some extra stuff after trying to run locally. got it working, changes are in commit names.

most notably fixed the recursive file search thing. also added a yarn script so we can run the thing more easily: yarn start export (5dde75e (#64))

LGTM. i'm gonna start further work on this on another branch

package-scripts/modules/ajexport.js

aidant19 · 2024-01-17T01:05:33Z

LGTM and works locally

- bb-cli.js to allow for command line functionality with blockbench - ajexport.js & associated config file for automated animated java exporting, to be passed to blockbench and executed from command line - Currently requires a modified version of animated java

- specifies prettier - also auto-changed other formatting? (unclear cause)

- Changing default formatter for json seems to have changed the workspace file which then defaulted to using json default formatting which then changed the formatting of the workspace file :)))

- Is this the best strategy?

- re-added spacing in workspace - moved json and jsonc formatter declaration

- add linting support for modules - ajexport script exported as async (now properly handled by bb-cli) - reverted old workspace file changes (user settings issue resolved)

Co-authored-by: Afro <[email protected]>

- was accidentally added during `friendliness-pellets` development: ca544f5#diff-596e795db462b6f907d978c7c1f0b55f7143b20a2a020cfef06c11074e1e9211 - good example of why we need #8 done to avoid thoose accidents

- should be no difference functionally

TheAfroOfDoom

LGTM thx for rebasing correctly

TheAfroOfDoom requested changes Jan 10, 2024

View reviewed changes

This was referenced Jan 11, 2024

bb-cli: Check that Blockbench is the targeted process #65

Open

bb-cli: Use minimist for arg parsing #66

Open

aidant19 requested a review from TheAfroOfDoom January 11, 2024 20:50

TheAfroOfDoom requested changes Jan 11, 2024

View reviewed changes

aidant19 requested a review from TheAfroOfDoom January 12, 2024 01:33

TheAfroOfDoom changed the title ~~Adds scripts that enable automated export of Animated Java files~~ adds scripts that enable automated export of Animated Java files Jan 15, 2024

TheAfroOfDoom changed the title ~~adds scripts that enable automated export of Animated Java files~~ add scripts that enable automated export of Animated Java files Jan 15, 2024

TheAfroOfDoom changed the title ~~add scripts that enable automated export of Animated Java files~~ add scripts for automated export of .ajmodel files Jan 15, 2024

TheAfroOfDoom approved these changes Jan 15, 2024

View reviewed changes

package-scripts/modules/ajexport.js Outdated Show resolved Hide resolved

aidant19 requested a review from TheAfroOfDoom January 17, 2024 01:06

aidant19 added 17 commits January 16, 2024 22:05

Indent size 4 -> 2

8be6ae7

Config change for json quotation rule

69398d9

New line added for prettier

a542a20

Workspace file change with prettier

974fe2a

- specifies prettier - also auto-changed other formatting? (unclear cause)

Workspace file formatting revert

57f4a85

- Changing default formatter for json seems to have changed the workspace file which then defaulted to using json default formatting which then changed the formatting of the workspace file :)))

Defined globals for purpose of passing linting

269c7a7

- Is this the best strategy?

Re-added indent_size and indent_style in editorconfig

3bc5134

workspace file edits

d3862ca

- re-added spacing in workspace - moved json and jsonc formatter declaration

extra comma removed

9666b7e

Added message link to troubleshooting w/ elenterius

2f778ce

require fs

c0c1f73

Removed unnecessary functions in ajexport

e29cb79

Removed TODO

3625bac

Remove commented code

f6dbb79

vars -> const

a766125

more var -> const

969d559

aidant19 and others added 26 commits January 16, 2024 22:05

ajexport and bb-cli functionality

efaf5a9

- add linting support for modules - ajexport script exported as async (now properly handled by bb-cli) - reverted old workspace file changes (user settings issue resolved)

Export related files moved to new modules dir

d2d9e16

config path changed to relative

806cef2

direct eslint yml to base file from new location

9e1f19b

Const enforcement added to .eslintrc.yml

ec90683

Remove unecessary log

b20efb7

includes ajmodel -> endsWith .ajmodel

91ff059

Co-authored-by: Afro <[email protected]>

enforcing object-shorthand rule

d86b648

Co-authored-by: Afro <[email protected]>

x -> relativePath

1a67ef9

Add object-shorthand rule to .eslintrc.yml

679341c

recursively search for ajmodel files

2845d25

Co-authored-by: Afro <[email protected]>

config + directory renaming

3bf5434

Undo recursive directory search - not currently working

20c2193

argv retrieval syntax update

16e36c6

commented on try/catch of bb-cli

948ab30

delete mouth.ajmodel

eede35b

- was accidentally added during `friendliness-pellets` development: ca544f5#diff-596e795db462b6f907d978c7c1f0b55f7143b20a2a020cfef06c11074e1e9211 - good example of why we need #8 done to avoid thoose accidents

fix typo assetsPath -> assetsDir

8bc891d

move Project.close() to bottom of loop

7492f7a

add getFiles dependency-free method from stack overflow

2a5fb94

fix getFiles to work with whatever ES-stuff Blockbench uses

684c8e5

add yarn start export script to run ajexport stuff

371e0e4

change ajexport to recursively search files

6c3a89d

run export script and update exported files

2ecebce

- should be no difference functionally

alphabetize eslintrc

be38d6c

update README with install steps for custom plugins

7efb35b

add TODO for better console.logging

be2355d

aidant19 force-pushed the 8-aj-cli-export branch from d477984 to be2355d Compare January 17, 2024 03:10

TheAfroOfDoom approved these changes Jan 17, 2024

View reviewed changes

aidant19 merged commit 6848faf into main Jan 17, 2024
5 checks passed

aidant19 deleted the 8-aj-cli-export branch January 17, 2024 03:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add scripts for automated export of `.ajmodel` files #64

add scripts for automated export of `.ajmodel` files #64

aidant19 commented Jan 10, 2024 •

edited

Loading

TheAfroOfDoom left a comment •

edited

Loading

aidant19 commented Jan 11, 2024 •

edited

Loading

TheAfroOfDoom left a comment

TheAfroOfDoom left a comment

aidant19 commented Jan 17, 2024

TheAfroOfDoom left a comment

add scripts for automated export of .ajmodel files #64

add scripts for automated export of .ajmodel files #64

Conversation

aidant19 commented Jan 10, 2024 • edited Loading

Summary

Test plan

Reproducing in-game

Preview

Supplemental changes

TheAfroOfDoom left a comment • edited Loading

Choose a reason for hiding this comment

aidant19 commented Jan 11, 2024 • edited Loading

TheAfroOfDoom left a comment

Choose a reason for hiding this comment

TheAfroOfDoom left a comment

Choose a reason for hiding this comment

aidant19 commented Jan 17, 2024

TheAfroOfDoom left a comment

Choose a reason for hiding this comment

add scripts for automated export of `.ajmodel` files #64

add scripts for automated export of `.ajmodel` files #64

aidant19 commented Jan 10, 2024 •

edited

Loading

TheAfroOfDoom left a comment •

edited

Loading

aidant19 commented Jan 11, 2024 •

edited

Loading