Skip to content
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.

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

Add Babylon.js #2506

Closed
wants to merge 3 commits into from
Closed

Add Babylon.js #2506

wants to merge 3 commits into from

Conversation

Symbitic
Copy link

https://github.com/Symbitic/awesome-babylonjs

The list contains resources about the popular open-source game engine Babylon.js - a framework for web and native game development written in TypeScript.

PR's reviewed:

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
    Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List.
    • Add Swift
    • Add Software Architecture
    • Update readme.md
    • Add Awesome Swift
    • Add swift
    • add Swift
    • Adding Swift
    • Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • - [Framer](…) - Prototyping interactive UI designs.
    • - [iOS](…) - Resources and tools for iOS development.
    • - [Framer](…)
    • - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't use hard-wrapping.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

@Symbitic
Copy link
Author

@sindresorhus I have filed issues for the three failing items on awesome-lint:

Babylon.js playground URLs include hashtags (https://playground.babylonjs.com/#58I88I#186), so awesome-lint incorrectly flags them as duplicates.

The other two errors (remark-lint:awesome-heading and remark-lint:awesome-list-item) are caused by the fact that "Babylon.js" has a period in it. Being as this causes other lists like awesome-nodejs to fail, I believe there should be an exception added to when a sentence/title ends with ".js" (or any other extension).

Copy link

@StealAngleK21 StealAngleK21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm perfectly fine... I know now... And I'll be taking my Mt back

@zakarialaoui10
Copy link

The linter returns 108 errors

✖ 1:1 Main heading must be in title case remark-lint:awesome-heading
✖ 35:3 https://playground.babylonjs.com/ remark-lint:double-link
✖ 63:16 https://playground.babylonjs.com/#58I88I#186 remark-lint:double-link
✖ 64:11 https://playground.babylonjs.com/#947JF6#0 remark-lint:double-link
✖ 65:23 https://playground.babylonjs.com/#8T3YBR#2 remark-lint:double-link
✖ 66:34 https://playground.babylonjs.com/#WVPVWL remark-lint:double-link
✖ 67:28 https://playground.babylonjs.com/#VXA85M#5 remark-lint:double-link
✖ 68:25 https://playground.babylonjs.com/#9CMU0F remark-lint:double-link
✖ 69:16 https://playground.babylonjs.com/#AL6VAN#1 remark-lint:double-link
✖ 70:32 https://playground.babylonjs.com/#KBS9I5#925 remark-lint:double-link
✖ 71:13 https://playground.babylonjs.com/#6QYHV7#29 remark-lint:double-link
✖ 72:18 https://playground.babylonjs.com/#7S3ZHU#[15](https://github.com/zakarialaoui10/linters/actions/runs/4164027614/jobs/7205128789#step:4:16) remark-lint:double-link
✖ 73:30 https://playground.babylonjs.com/#CUH660#27 remark-lint:double-link
✖ 74:33 https://playground.babylonjs.com/#0PHDVB#0 remark-lint:double-link
✖ 75:26 https://playground.babylonjs.com/#1YD970#283 remark-lint:double-link
✖ 76:24 https://playground.babylonjs.com/#1YD970#14 remark-lint:double-link
✖ 77:29 https://playground.babylonjs.com/#502Z8L#0 remark-lint:double-link
✖ 78:21 https://playground.babylonjs.com/#AH85PF#53 remark-lint:double-link
✖ 79:17 https://playground.babylonjs.com/#092XX3#13 remark-lint:double-link
✖ 80:30 https://playground.babylonjs.com/#U8MEB0#114 remark-lint:double-link
✖ 81:35 https://playground.babylonjs.com/#RGNDK2#2 remark-lint:double-link
✖ 82:17 https://playground.babylonjs.com/#3FJZD5#4 remark-lint:double-link
✖ 83:24 https://playground.babylonjs.com/#D7LQDZ#1 remark-lint:double-link
✖ 84:34 https://playground.babylonjs.com/#355XBJ#[16](https://github.com/zakarialaoui10/linters/actions/runs/4164027614/jobs/7205128789#step:4:17) remark-lint:double-link
✖ 85:19 https://playground.babylonjs.com/#5MJ1X9#13 remark-lint:double-link
✖ 86:23 https://playground.babylonjs.com/#5ZCGRM#2860 remark-lint:double-link
✖ 87:24 https://playground.babylonjs.com/#9U086#4 remark-lint:double-link
✖ 88:27 https://playground.babylonjs.com/#HDHQN#55 remark-lint:double-link
✖ 89:26 https://playground.babylonjs.com/#HDHQN remark-lint:double-link
✖ 90:43 https://playground.babylonjs.com/#CWAQ1W#12 remark-lint:double-link
✖ 91:26 https://playground.babylonjs.com/#VS5XS7#0 remark-lint:double-link
✖ 92:31 https://playground.babylonjs.com/#4HUQQ#1479 remark-lint:double-link
✖ 93:33 https://playground.babylonjs.com/#RDJ26Q#1288 remark-lint:double-link
✖ 94:33 https://playground.babylonjs.com/#UL7W2M remark-lint:double-link
✖ 95:25 https://playground.babylonjs.com/#22KIIK#22 remark-lint:double-link
✖ 96:20 https://playground.babylonjs.com/#LVJG7H remark-lint:double-link
✖ 97:29 https://playground.babylonjs.com/#45FPFC#13 remark-lint:double-link
✖ 98:16 https://playground.babylonjs.com/#6MQB2X#158 remark-lint:double-link
✖ 99:35 https://playground.babylonjs.com/#HY823G#7 remark-lint:double-link
✖ 100:36 https://playground.babylonjs.com/#7XU4D8#1 remark-lint:double-link
✖ 101:23 https://playground.babylonjs.com/#ISZ7Y2 remark-lint:double-link
✖ 102:36 https://playground.babylonjs.com/#HJZBRG#100 remark-lint:double-link
✖ 103:16 https://playground.babylonjs.com/#E8C51D#35 remark-lint:double-link
✖ 104:28 https://playground.babylonjs.com/#0IRV8X#2 remark-lint:double-link
✖ 105:32 https://playground.babylonjs.com/#BP7QYG#13 remark-lint:double-link
✖ 106:12 https://playground.babylonjs.com/#A8X91Q#10 remark-lint:double-link
✖ 107:18 https://playground.babylonjs.com/#0JC454#16 remark-lint:double-link
✖ 108:26 https://playground.babylonjs.com/#LU3FLF#6 remark-lint:double-link
✖ 109:18 https://playground.babylonjs.com/#0IIB3N#44 remark-lint:double-link
✖ 110:27 https://playground.babylonjs.com/#UFVU18#18 remark-lint:double-link
✖ 111:17 https://playground.babylonjs.com/#ZS41RU#0 remark-lint:double-link
✖ 112:21 https://playground.babylonjs.com/#K7TJIG remark-lint:double-link
✖ 113:18 https://playground.babylonjs.com/#6C8005#1 remark-lint:double-link
✖ 114:24 https://playground.babylonjs.com/#IT1QZU#13 remark-lint:double-link
✖ 115:18 https://playground.babylonjs.com/#YRP925 remark-lint:double-link
✖ 116:18 https://playground.babylonjs.com/#3I55DK#0 remark-lint:double-link
✖ 117:31 https://playground.babylonjs.com/#NE96B8#10 remark-lint:double-link
✖ 118:22 https://playground.babylonjs.com/#MNC4HP remark-lint:double-link
✖ 119:19 https://playground.babylonjs.com/#8WC6ZN#112 remark-lint:double-link
✖ 120:33 https://playground.babylonjs.com/#11XV5X#13 remark-lint:double-link
✖ 121:37 https://playground.babylonjs.com/#4WPJCV#34 remark-lint:double-link
✖ 122:31 https://playground.babylonjs.com/#ZENDZ2#0 remark-lint:double-link
✖ 123:21 https://playground.babylonjs.com/#RYXIT#9 remark-lint:double-link
✖ 124:26 https://playground.babylonjs.com/#2S8L5U#1 remark-lint:double-link
✖ 125:32 https://playground.babylonjs.com/#ZU8CV4#12 remark-lint:double-link
✖ 126:12 https://playground.babylonjs.com/#ACPMQL#2 remark-lint:double-link
✖ 127:42 https://playground.babylonjs.com/#ARN6TJ#5 remark-lint:double-link
✖ 128:20 https://playground.babylonjs.com/#1ND6TH#265 remark-lint:double-link
✖ 129:19 https://playground.babylonjs.com/#1HH4OJ#29 remark-lint:double-link
✖ 130:36 https://playground.babylonjs.com/#RBX8Y4#22 remark-lint:double-link
✖ 131:44 https://playground.babylonjs.com/#1BGGDU remark-lint:double-link
✖ 132:26 https://playground.babylonjs.com/#S0IW99#23 remark-lint:double-link
✖ 133:16 https://playground.babylonjs.com/#B2DP5I#7 remark-lint:double-link
✖ 134:48 https://playground.babylonjs.com/#8WC6ZN#121 remark-lint:double-link
✖ 135:38 https://playground.babylonjs.com/#10RCC9 remark-lint:double-link
✖ 136:19 https://playground.babylonjs.com/#JXJBPS#5 remark-lint:double-link
✖ 137:23 https://playground.babylonjs.com/#G03CV5#0 remark-lint:double-link
✖ 138:46 https://playground.babylonjs.com/#0MGV2I#0 remark-lint:double-link
✖ 139:19 https://playground.babylonjs.com/#ND4U2L remark-lint:double-link
✖ 140:31 https://playground.babylonjs.com/#2FPT1A#351 remark-lint:double-link
✖ 141:18 https://playground.babylonjs.com/#Z88Q4W#19 remark-lint:double-link
✖ 142:15 https://playground.babylonjs.com/#165IV6#2526 remark-lint:double-link
✖ 143:20 https://playground.babylonjs.com/#1DDSV5 remark-lint:double-link
✖ 144:32 https://playground.babylonjs.com/#52M011#2 remark-lint:double-link
✖ 145:19 https://playground.babylonjs.com/#88MM6V#0 remark-lint:double-link
✖ 146:22 https://playground.babylonjs.com/#CMS27E#11 remark-lint:double-link
✖ 147:33 https://playground.babylonjs.com/#H19VH7#44 remark-lint:double-link
✖ 148:19 https://playground.babylonjs.com/#XP6NNP#42 remark-lint:double-link
✖ 149:21 https://playground.babylonjs.com/#C21DGD#3 remark-lint:double-link
✖ 150:17 https://playground.babylonjs.com/#2WR12Z#2 remark-lint:double-link
✖ 151:53 https://playground.babylonjs.com/#SQFG0Q#6 remark-lint:double-link
✖ 152:53 https://playground.babylonjs.com/#SQFG0Q#5 remark-lint:double-link
✖ 153:19 https://playground.babylonjs.com/#Z07JE1#2 remark-lint:double-link
✖ 154:22 https://playground.babylonjs.com/#LPTLZM remark-lint:double-link
✖ 155:35 https://playground.babylonjs.com/#5W4GH1#10 remark-lint:double-link
✖ 156:26 https://playground.babylonjs.com/#C6V6UY#49 remark-lint:double-link
✖ 157:24 https://playground.babylonjs.com/#1JDJ9F#9 remark-lint:double-link
✖ 158:20 https://playground.babylonjs.com/#9M1I08#7 remark-lint:double-link
✖ 159:26 https://playground.babylonjs.com/#ZD364L#17 remark-lint:double-link
✖ 160:31 https://playground.babylonjs.com/#7ILX7T remark-lint:double-link
✖ 161:16 https://playground.babylonjs.com/#WBEEFF#1 remark-lint:double-link
✖ 162:25 https://playground.babylonjs.com/#PKQ6JV#3 remark-lint:double-link
✖ 163:30 https://playground.babylonjs.com/#B922X8#19 remark-lint:double-link
✖ 164:23 https://playground.babylonjs.com/#CHF3KW#108 remark-lint:double-link
✖ 165:27 https://playground.babylonjs.com/#PPM311#99 remark-lint:double-link
✖ 166:18 https://playground.babylonjs.com/#K1WGX0#36 remark-lint:double-link
✖ 167:46 https://playground.babylonjs.com/#LYCSQ#256 remark-lint:double-link
✖ 168:25 https://playground.babylonjs.com/#[73](https://github.com/zakarialaoui10/linters/actions/runs/4164027614/jobs/7205128789#step:4:74)TUXW#0 remark-lint:double-link

108 errors

@zakarialaoui10 zakarialaoui10 mentioned this pull request Feb 13, 2023
@Symbitic
Copy link
Author

@zakarialaoui10 I already mentioned the errors above. Bug reports have been filed.

Repository owner deleted a comment from StealAngleK21 Apr 23, 2023
@sindresorhus
Copy link
Owner

Please follow the normal formatting of Awesome lists. Links should be linkified text, not plain URL links.

@sindresorhus
Copy link
Owner

Entries have a description, unless the title is descriptive enough by itself. It rarely is though.

@Symbitic
Copy link
Author

Please follow the normal formatting of Awesome lists. Links should be linkified text, not plain URL links.

@sindresorhus I tried that in the playground, but it doesn't fit with the (bullet) name (dash) optional description (url) format that the rest of the list uses. Is this really a requirement?

Repository owner deleted a comment from Superlegend717 Apr 25, 2023
@sindresorhus
Copy link
Owner

Is this really a requirement?

Yes

@Symbitic
Copy link
Author

Symbitic commented Apr 26, 2023

Very well. Changed the Playground format.

The only other part is the book links, and those are descriptive. "aka.ms" is necessary to show because it designates that this is a Microsoft project.

@Symbitic
Copy link
Author

@sindresorhus anything else needed? The latest version of remark-lint-double-link includes the fix for double hashtag links, and I'm trying to see about making a PR for awesome-lint to fix the heading issue. Can this be merged before awesome-lint is updated?

Repository owner deleted a comment from StealAngleK21 May 19, 2023
@sindresorhus
Copy link
Owner

There are still many entries that have plain URLs.

For example:

InstancedBones - A group of soldiers marching in sync. (https://github.com/BabylonJS/Website/tree/master/build/Demos/InstancedBones)

@sindresorhus
Copy link
Owner

Bump

@Symbitic
Copy link
Author

I would like to request you add recommendations for what to do in this situation (entries with both a deployed URL and a source folder) to the official rules so that awesome-lint can just object to plain URLs.

@Symbitic
Copy link
Author

@sindresorhus All plain URLs have been removed.

@sindresorhus
Copy link
Owner

src => source

(src) and [demo] are using inconsistent brackets

Babylon.js Changelog, Babylon.js is implied in this links and moot

@sindresorhus
Copy link
Owner

The description starts with an uppercase character and ends with a period.

@sindresorhus
Copy link
Owner

Some items are missing a description.

@Symbitic
Copy link
Author

Symbitic commented Aug 25, 2023

src => source

Changed all instances of src to source.

(src) and [demo] are using inconsistent brackets.

Switched to using square brackets for everything.

Babylon.js Changelog, Babylon.js is implied in this links and moot

I removed Babylon.js where appropriate, but for some links, it is necessary because the link is specific to Babylon.js web; not Babylon Native (not the difference in spelling).

Some items are missing a description.

I did my best to add a description to most links, but they are still missing in one area: the playgrounds.
It's hard to add descriptions to those because they are WYSIWYG. Most didn't have official titles so I had to come up with them myself, and none of them have official descriptions. Some are hard to describe in words, honestly.
What should I do here?


Thanks for bearing it out with me; I really appreciate it.

@Symbitic
Copy link
Author

@sindresorhus bump.

@sindresorhus
Copy link
Owner

sindresorhus commented Sep 1, 2023

Consistent and correct naming. For example, Node.js, not NodeJS or node.js.

BabylonJS and Babylon.js is used, and even babylonjs, and Babylon.

The description starts with an uppercase character and ends with a period.

Not all done.

@sindresorhus
Copy link
Owner

Babylon JS Day 10: Terrarium - Final in a series of lessons that explains how to use assetsManager.
Babylon JS Day 19: Golf Club - Shows how to leverage AssetsManager to load a custom model as a VR controller.

Capitalization of AssetManager.

@sindresorhus
Copy link
Owner

I would place the Playground section above Examples. It's very long and not as useful as many of the sections that come after it.

@sindresorhus
Copy link
Owner

BABYDOOM - Doom clone using the JavaScript Babylon.js engine. [demo]

Both "JavaScript" and "Babylon.js engine" are moot here as implied by the context. Same with many other entries.

@Symbitic
Copy link
Author

@sindresorhus The reason I used them is because those are from the official GitHub descriptions of the projects. Is it really okay to modify that?

@Symbitic Symbitic deleted the patch-1 branch January 29, 2024 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants