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

TweakXL YAML Editing and Export From TweakBrowserViewModel #1006

Merged
merged 21 commits into from
Nov 21, 2022

Conversation

dragonzkiller
Copy link
Member

Initial implementation of #922. This is a very rough implementation for initial support to generate TweakXL YAML files. This draft is to open discussion on implementation of features and usability of the current method.

Implemented:

  • Text editor with highlighting (WIP) for YAML files
  • Export entire record from TweakBrowserViewModel Records View
  • Export single record/flat from TweakBrowserViewModel Records View

Not Yet Implemented:

  • Exporting Flats from the Flats list (can be exported from Records view)
  • ChunkViewModel for ITweakXLItem
  • !append and related tags
  • Aliases (how would we conceivably do this?)
  • Appending to single YAML file vs creating new one on export

How To Use:

  1. Create a new project (optional)
  2. Open the TweakBrowser
  3. Select a Record in the List
    a. Right-click and export from left-hand list (or)
    b. Right-click an item in the right-hand TreeView and select "TweakXL -> Override Value"
  4. Save YAML file (default location is "Resources" directory)
  5. Open YAML and edit values
  6. Save Edits
  7. Pack, Install, Run

Topics of Discussion:

  • How a user selects records and flats in TweakBrowserViewModel (e.g. Step 3 above)
  • How an ITweakXLItem is structured
    • Properties (current implementation)
    • Only ID, Base, Type, Value fields
  • When to read values from TweakDB
    • In the ViewModels (current implementation)
    • In the YAML Parser

@dragonzkiller dragonzkiller added this to the Version-8.7.1 milestone Nov 11, 2022
@dragonzkiller dragonzkiller self-assigned this Nov 11, 2022
This was linked to issues Nov 11, 2022
Copy link
Member

@rfuzzo rfuzzo left a comment

Choose a reason for hiding this comment

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

Thanks! Could you run a code format over it? Are you using VS22 ?

WolvenKit.App/Models/TweakXL.cs Show resolved Hide resolved
WolvenKit.App/Models/TweakXL.cs Show resolved Hide resolved
WolvenKit.App/Models/TweakXL.cs Show resolved Hide resolved
@dragonzkiller
Copy link
Member Author

Thanks! Could you run a code format over it? Are you using VS22 ?

Yes, I'm on VS22. I ran a cleanup across my files that cleaned up a few things

@rfuzzo rfuzzo removed this from the Version-8.8.0 milestone Nov 17, 2022
@rfuzzo rfuzzo modified the milestones: Version-8.8.1, Version-8.9 Nov 17, 2022
@dragonzkiller dragonzkiller marked this pull request as ready for review November 19, 2022 18:05
@rfuzzo rfuzzo merged commit f34d4e8 into main Nov 21, 2022
@rfuzzo rfuzzo deleted the feature/tweakXL-ui branch November 21, 2022 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: can't edit/save yaml files TweakXL support
2 participants