Legion: Final Tracker

[AlveLarsson]

Hello! I've been out of the loop for the past months due to some life issues, but now I'm back.

Progress on the Legion port has slowed to a standstill. I'm creating this issue to track what's been done, what still needs to be done, and what our roadblocks are. This issue will act as a new, clean slate to minimize confusion and get us back on track.

Edit this comment to change the lists below, or comment below and someone with write access will update the lists for you.

Current Progress with Names & Links

• Project Board
• Release Checklist
• amethyst parent crate Remove Callback Queue #2320
• examples fix examples for legion integration #2483
• book
• inline documentation (please do it with your subcrate ports!)
• all subcrates Update to latest legion and implement new dispatcher #2400 Merge master into legion #2417 Bring back the old transform system in place of legion_transform #2436
  • amethyst_animation amethyst_animation, complete port #2334 Legion animation #2351
  • amethyst_assets @jlowry remove errors from amethyst_assets examples #2329 Prefab system in legion #2404 Prefab system in Legion using Atelier assets #2520
  • amethyst_audio amethyst_audio port to legion #2315
  • amethyst_config
  • amethyst_controls Port amethyst_controls to legion. #2325 Legion controls #2378
  • amethyst_core @LechintanTudor Update legion dependency to crates.io published version 0.3.1 #2502 pausable systems #2560
  • amethyst_derive
  • amethyst_error
  • amethyst_gltf amethyst_gltf, complete port #2335 [LEGION]: Port GLTF Module #2631
  • amethyst_input amethyst_input, complete port #2332 Use Cow<'static, str> instead of BindingTypes for InputHandler #2481
  • amethyst_locale amethyst_locale, complete port #2331 amethyst_locale legion port #2336
  • amethyst_network Legion amethyst_network port #2319
  • amethyst_rendy Fix amethyst_rendy minor issue with legion #2318 Autoselect Graphics Backend for Rendy #2522
  • amethyst_test
  • amethyst_tiles @valkum Migrate amethyst_tiles + example to legion #2555
  • amethyst_ui @grzi amethyst_ui, complete port #2330 [LEGION] Migrate amethyst UI to LEGION #2556
  • amethyst_utils Port amethyst_utils to legion #2350
  • amethyst_window

Who is willing to help? What are you currently working on?

• @AlveLarsson - tracking, talking to folks to gather updates
• @CleanCut - help with tracking, try to make amethyst_rendy less of a pain, maybe examples
• @jlowry - amethyst_assets
• @valkum - amethyst_tiles
• @LechintanTudor - amethyst_core, amethyst_ui

Lastly, we need to communicate frequent updates about what's being done or rather the rate of progress that's happening on each crate as we start work.

Important! Please discuss the legion port on GitHub issues (like this one, or more specific ones), not on discord or the forum. We need to keep the discussion in one place to keep things sane.

(Special thanks to @CleanCut and @jlowry for catch-ups)

[jlowry]

I am currently working working on #2404 Prefab system in legion by integrating Atelier Assets and Legion Prefab.
On my fork's assets_wip branch, I have atelier integrated and legion prefab working for non nested prefabs (also the system that applys the prefabs automatcally is not done.). This is still needs tidying up but I'm making steady progress.

Currently, I am working on the format part of legion prefab based recommendations by @kabergstrom:

• to improve the serialisation format to make easier to use when writing prefabs by hand
• to allow atelier asset handles can be created automatically for nested prefabs and assets within them

[CleanCut]

Everyone: For work in progress, please branch off of legion_v2 (or something downstream from it) and make a Draft Pull Request for your branch/fork against legion_v2 while you do your work. That way we have a PR to link to, see progress as it occurs, and communicate with you on. Switch the PR out of draft mode when you're ready for a review.

Note: I'm going to attempt aggressively hiding comments that have been resolved. If that ends up being more of a hindrance than a help, please let me know and I can unhide stuff.

• @BlockCat I see you were working on amethyst_animation in Legion animation #2351 - would you be willing to pick that back up and merge legion_v2 into that branch? Should we add you to the active list?
• @chemicstry I don't see anything "in progress" from you, but you've been very involved in the past. Should we add you to the active list? Do you have something in progress I'm unaware of?
• @jlowry As per your comment above I've listed you as the person for amethyst_assets and linked to your PR.
• @Jojolepro In Discord you said you were not participating any further. If you change your mind, we'd love to have you back! If you are willing to give a summary of where you left off, that would be helpful.
• @LechintanTudor Do you have a PR out for amethyst_ui somewhere to supersede Port amethyst_ui to legion #2343? You mentioned you were working on amethyst_core in Discord as well - but I don't see a PR for that, either - are you working on both in master in your fork? Should we add you to the active list?
• @mockersf Would you like to finish up examples? At the point fix examples for legion integration #2483 was left off, it looks like there were CI failures to address. Should I add you to the active list?
• @thunderseethe I see you had been working on part of amethyst_core in Migrate SystemExt pauseable to Legion #2467 - shall we add you to the active list to finish that up?

I'm also going to shotgun a question to a bunch of notable folks I'm aware of who have been involved in some way in the past -> Would any of you folks like to directly contribute to this effort to finish up and ship Legion integration in Amethyst? Feel free to ignore this ping and unsubscribe from this issue if you're not interested.

• @ab0v3g4me @aclysma @azriel91 @Blisto91 @erlend-sh @fhaynes @kabergstrom @jaynus @Moxinilian @Rhuagh @kabergstrom @termhn @TomGillen @Xaeroxe

I've surely missed some people from these lists. (Sorry--unintentional!) Please pass this along to them! Please speak up if you're willing to contribute.

[LechintanTudor]

Here's my draft for amethyst_core #2521

[CleanCut]

For building the amethyst root crate I run:
cargo build --features "metal"

To test things are working, I've been running an example, e.g.:

cargo run --features "metal" --example "asset_custom"

It doesn't solve your problem of crates not compiling with unrelated features. But I find it useful to see what is compiling from the dependency graph (cargo tree | grep amethyst) :

@jlowry Awesome, thank you. That unblocks for reviewing and helping out with other stuff at least.

I still find it maddening not to be able to compile individual crates, so I'm going to continue on my quest to eliminate mandatory features altogether in #2522

[ezpuzz]

I've updated the pong examples to get through example 4 working and 5 ready for amethyst_ui new version at #2531

[valkum]

Got tiles nearly ready but got stuck with the camera_switch in the tiles example: https://github.com/valkum/amethyst/blob/legion_v2_tiles/examples/tiles/main.rs#L141
I am in a state where the example runs but without the functionality implemented in the camera_switch system.

@CleanCut I would appreciate your input if you got time, hit me up on discord too explain further.

[ezpuzz]

@valkum thanks for this! I'm really glad to see an example of using the legion system macros inside an amethyst project.

[CleanCut]

As per this Discord comment It would be super useful if serde-diffsupported:

#[serde(from = "TransformValues", into = "TransformValues")]
and
#[serde_diff(opaque)]

@jlowry PR is ready for review in amethyst/serde-diff#22

[CleanCut]

Here's a quick status roundup of what I see with a quick look around (I'm sure I've missed some things):

• [Deferred] @CleanCut Shelved efforts to eliminate the --features metal|vulkan requirement until an upstream feature is stabilized. Autoselect Graphics Backend (no more --feature vulkan/metal/empty) #2525
• [Needs Review] @CleanCut Wrote up feature for serde_diff to support target structs to unblock 👇🏼 - Support Target Structs serde-diff#22
• [In Progress] @jlowry working on the prefab system Prefab system in Legion using Atelier assets #2520
• [Merged] @ezpuzz Fixed the sprites_ordered example and some docs examples in amethyst_core [LEGION] Port sprites ordered example, Named and FrameLimiter docs #2535 Small followup to #2535 #2542
• [In Progress] @mockersf @ezpuzz Working on various examples. fix examples for legion integration #2483 Fix offset in TileMap positionning #2540
• [Merged] @grzi Reimplement the hide hierarchy system amethyst_core: Reimplement the hide hierarchy system in legion and add unit tests to it #2538
• [Needs review / justification] @ezpuzz is working on a change to use system structs instead of build_xyz_system functions [LEGION] system structs instead of build_xyz_system functions #2541

[ezpuzz]

Remaining Tasks for Release:

• amethyst_animation Port amethyst_animation to Legion #2549
• amethyst_gltf @grzi
• amethyst_derive
• amethyst_test
• Examples
  • animation Fix mouse_raycast and animation examples #2584
  • auto_fov
  • custom_game_data
  • custom_ui
  • debug_lines fix debug_lines, debug_lines_ortho, sprite_animation examples #2582
  • debug_lines_ortho fix debug_lines, debug_lines_ortho, sprite_animation examples #2582
  • gltf @grzi
  • mouse_raycast Fix mouse_raycast and animation examples #2584
  • pong_tutorial_06 @grzi feat: Implement Pong 06 example #2598
  • prefab_basic
  • prefab_custom
  • prefab_multi
  • renderable
  • renderable_custom
  • rendy
  • spotlights @grzi feat: port spotlights example to legion #2651
  • sprite_animation fix debug_lines, debug_lines_ortho, sprite_animation examples #2582
  • state_dispatcher
  • states_ui
  • ui
• Prefabs
  • SpriteSheets
  • BasicScenePrefab (3d stuff)
  • Animation
  • Tiles
• docs and books Book and Doc checks in CI #2557
• website update @AlveLarsson
• update amethyst-starter-2d repo

[grzi]

The GLTF port is ready at : #2631

[grzi]

Spotlights example port to legion : #2651

[B-Reif]

Hey, I'm just exploring amethyst for the first time, I'd be happy to take a stab at working on updating the book. Might need a little guidance.

[aakashhemadri]

Hey not sure if I should start using 0.15.3 with 0.16 around the corner, Do I wait for the 0.16 release?

[neogeek23]

In the same boat as @aakashhemadri but a few months later (not wanting to get started with 15.3 if 16.0 is close). The checklist is looking nearly complete atm the only sub crate missing is amethyst_test. Is it reasonable to expect this to release this year?

[CaesarXInsanium]

oh my goodness,its getting done yass

[stale]

This issue has been automatically marked as stale because it has not had recent activity. Maybe it's time to revisit this?