New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ESM Script Documentation #644

Open

marklundin wants to merge 74 commits into main from esm-script-examples

Member

marklundin commented Mar 27, 2024 •

edited

Loading

This PR updates the documentation with the following

ESM Script based intro
Updates Script Attributes docs to reflect new system
Removes migrations guide from legacy -> scripts 2.0
Adds migration docs from scripts 2.0 - ESM Scripts
Move's older scrips 2.0 docs into legacy subfolder

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

marklundin added 2 commits

March 27, 2024 12:28


          Upgrading Script examples to include ESM variants

28ecc52


          Add esm variants for tutorials

7dd39e0

marklundin self-assigned this

marklundin added 2 commits

March 27, 2024 16:16


          linting

36f094f


          linting

fa3a447

marklundin marked this pull request as ready for review

March 27, 2024 16:34

marklundin requested review from mvaligursky, willeastcott and kpal81xd

March 27, 2024 16:34


          Merge branch 'main' into esm-script-examples

58c6e7b

willeastcott reviewed

View reviewed changes

docs/tutorials/collision-and-triggers.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/collision-and-triggers.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/Using-forces-on-rigid-bodies.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/entity-picking.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/facebook-api.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/facebook-api.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/facebook-api.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/facebook-api.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/facebook-api.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/facebook-api.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/facebook-api.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/facebook-api.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/first-person-movement.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/google-ads-for-games.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/keepyup-part-four.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/keepyup-part-six.md Outdated Show resolved Hide resolved

willeastcott reviewed

View reviewed changes

docs/tutorials/keepyup-part-three.md Outdated Show resolved Hide resolved

marklundin and others added 3 commits

April 8, 2024 06:32


          Update docs/tutorials/collision-and-triggers.md

dbf459a

Co-authored-by: Will Eastcott <[email protected]>


          Update docs/tutorials/collision-and-triggers.md

4ea970d

Co-authored-by: Will Eastcott <[email protected]>


          Update docs/tutorials/Using-forces-on-rigid-bodies.md

34bc4db

Co-authored-by: Will Eastcott <[email protected]>

Member Author

marklundin commented Sep 5, 2024

Yep, at least for consistency 'Classic' might be sufficient. My only concern is that we want to push a single route moving forward, and ESM/Classic doesn't necessarily communicate that. Maybe Next/Classic? @willeastcott any thoughts here?

Contributor

mvaligursky commented Sep 5, 2024

I would go for Classic and Modern perhaps.

Contributor

willeastcott commented Sep 5, 2024

I'm not a fan of 'Modern'. I like these two options close to equally:

ES5 scripts vs ESM scripts
Classic scripts vs ESM scripts

Collaborator

Maksims commented Sep 5, 2024

I'm not a fan of 'Modern'. I like these two options close to equally:

ES5 scripts vs ESM scripts

Classic scripts vs ESM scripts

Technically they are not ES5, as you can use classes without ESM.

Contributor

willeastcott commented Sep 5, 2024

Technically they are not ES5, as you can use classes without ESM.

True.


          Refactor watch function to use Object.defineProperty

9466eb2

marklundin changed the title ~~Add ESM Script Examples~~ Add ESM Script Documentation

marklundin and others added 8 commits

September 17, 2024 13:31


          reverting tutorials back to main

3c6530f


          revert animation docs

e32a1a7


          revert getting started + asset types

0606a53


          revert physics

a3d165b


          revert publishing

75cac59


          revert user interface

6087ea8


          revert package-lock.json to main

1e266db


          Merge branch 'main' into esm-script-examples

437712c

marklundin requested review from a team and removed request for willeastcott, kpal81xd and mvaligursky

September 17, 2024 13:00


          package-lock fix

574964c

slimbuck reviewed

View reviewed changes

docs/user-manual/scripting/anatomy.md Show resolved Hide resolved

docs/user-manual/scripting/index.md Outdated Show resolved Hide resolved

i18n/ja/docusaurus-plugin-content-docs/current/user-manual/scripting/esm-scripts.md Outdated Show resolved Hide resolved

docs/user-manual/scripting/script-attributes.md Show resolved Hide resolved

docs/user-manual/scripting/anatomy.md Outdated Show resolved Hide resolved

docs/user-manual/scripting/esm-scripts.md Outdated Show resolved Hide resolved

marklundin and others added 4 commits

September 17, 2024 16:23


          Update docs/user-manual/scripting/anatomy.md

587f807

Co-authored-by: Donovan Hutchence <[email protected]>


          legacy -> classic

e2dbbe4


          fix links

154785d


          Update ESM Scripts description

57fa097

marklundin requested review from slimbuck and willeastcott

September 26, 2024 07:51


          fix linting

00f67df

marklundin requested a review from a team

September 26, 2024 08:53


          fixed i18n link

4bbc962

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet