Skip to content

Latest commit

 

History

History
171 lines (148 loc) · 11.5 KB

CHANGELOG.md

File metadata and controls

171 lines (148 loc) · 11.5 KB
Raw

2.0.0

The largest Enigma update ever brings you dozens of changes across the user interface, the API, the command line!

  • changed package name to org.quiltmc.enigma instead of cuchaz.enigma

    • you'd be amazed at how much of a struggle this was. I love gradle

  • set up a separation between API and implementation classes, by moving them to the org.quiltmc.enigma.api and org.quiltmc.enigma.impl packages respectively

    • you can now trust that no breaking changes will be made to API until update 3.0!

  • added indexing for mappings

    • this goes in tandem with indexing for jars. index everything!
    • currently only has one indexer: an index of package names, that's used to warn the user that they're creating a new package in the UI

  • more class references are now indexed in EntryIndex (pulled from Fabric upstream with permission!)

  • we now allow using JSON lists for arguments to enigma services in your profile

    • to pull from iota's example when she implemented this, it means we don't have to do a "custom_codecs": "nonsense, nonsense, nonsense, nonsense, you get the point" disaster in our quilt profile

  • redid name proposal API entirely!

    • the API is now neatly event-based, with a method that runs on jar load and a method that runs on mapping changes for you to hook into
    • established a clean separation between mappings proposed based on the bytecode (JAR_PROPOSED) and mappings proposed based on other mappings (DYNAMIC_PROPOSED)
    • we now track the source plugin ID of each proposed name, for debug reasons
    • added explicit priority for name proposal services: in the case of two services proposing for the same entry on the same event, the one higher up in your profile will take priority

  • added a getId() method to EnigmaService

    • plugin IDs must now be explicitly defined in code, which cleans up name proposal quite a bit

  • added lots more unit tests

  • wrote up piles of documentation

  • removed support for the old Recaf and Tiny V1 mapping formats

  • removed old internal config API

  • implemented automatic format detection in all commands

  • greatly improved command help

    • include descriptions of what each argument does in errors
    • add a dedicated help command
      • lists all possible commands
      • includes detailed descriptions of each command's function

  • normalised all command names to kebab-case

  • statistics got a huge rework

    • stat icons in the class tree dockers have been expanded to now show on packages as well as classes
    • optimise stat regeneration for single classes
    • stats are now stored persistently across the user interfaces
      • the stats dialog and stats tree now open instantly instead of making you wait for generation
      • stats are now generated for the full project at startup, meaning it'll be longer until the icons populate
      • navigating the class tree will be much snappier now that you're not starting generation tasks on every opened package

  • added a "move package" option to the right-click context menu on packages, allowing you to move a package without refactoring surrounding packages

  • added the new entry navigator, which allows you to quickly slide between different types of entry

    • this allows you to quickly navigate through long classes to find obfuscated entries
    • it can also be used to navigate between deobfuscated entries, entries with dynamically proposed names, and entries with jar-based proposed names
    • the entry navigator is pinned to the top-right corner of the code view window

  • moved away from the syntaxpane library in favour of syntaxpain, a custom rai-engineered fork that is smaller, more maintainable, and hopefully faster

    • this fixes a couple long-standing UI bugs and should allow us to fix bugs faster as they crop up
    • it also enables more customisability and simplifies setup

  • made some improvements to search dialog (pulled from Fabric upstream, thanks YanisBft for permission!)

    • pin exact matches to the top of the results
    • add a checkbox to only show exact matches
    • they changed the keystroke because ctrl + space doesn't work in all swing contexts. I already did that. thank you yanis for fuelling my ego

  • the stats dialog now shows an overall percentage as well as parameters, fields, classes and methods individually

  • moved over to quilt config for configuration reasons

    • cleaned up and organised config files
    • config is now in five files: net, decompiler, keybind, main, and docker
    • added a bunch of comments in the config to allow more editing directly in the file
    • your config will not be migrated! it won't be deleted or overridden, but if you've got some neat keybinds or something else you want to keep, make sure to reconfigure from the UI or copy things around the files

  • added some neat debug utils if you run with the --development flag

    • currently, this includes a view of the internal mapping tree

  • removed access modifier editing

  • fix yet more bugs with statistic accuracy

  • fix the cancel button in the "rename package" window causing a crash

  • fix documenting constructors (from Fabric upstream, with permission!)

  • fix an untranslated string that could appear in logs (tiny_v2.loading for the curious)

  • fix a rare NPE on startup (that weird one with the icons. I saw it like 1/20 times. if you're like me you're very happy about this. if you're not that's ok I love everyone)

  • fix some issues with incorrect server docs

2.1.0

As with any big release, Enigma 2.0 broke tons of things. We've cleaned up all the bugs and crashes as well as added a few features for the bytecode nerds with this release!

  • added new development options!
    • added an option to enable debug token highlighting
    • added an option to show the source plugin of proposed mappings in the identifier panel
    • remember to have these options available you need to run enigma with the --development flag!
  • added tokenization to the bytecode view
    • this allows you to rename entries and more clearly see what is obfuscated and deobfuscated when viewing the bytecode!
  • added syncing of names between method declarations in interfaces
    • sometimes, a class will implement methods with the same names and signatures from two different interfaces. previously, this would break the mappings if you renamed one of those as enigma wasn't aware that they needed to match. now it's smarter!
  • fixed the server asking all users to verify warnings instead of just the mapper who caused the warning
  • fixed mappings sync on the server sending proposed mappings
  • fixed some issues with drop-invalid-mappings
  • fixed an inverted condition when parsing arguments in the CLI
  • fixed toggling between obfuscated and deobfuscated on parameters of bridge methods
  • fixed vineflower settings not being properly applied and saved
  • fixed the merged mapping tree occasionally prioritising empty mappings over real ones
  • fixed incorrect bytecode tokens on arrays
  • fixed recent projects adding duplicate entries when the same project is opened twice
  • fixed old recent projects beyond the limit not being removed
  • fixed a startup crash when no recent projects are present
  • fixed a startup crash likely caused by a bug in FlatLAF
  • fixed the package index being quite broken and not properly tracking all packages

2.2.0

2.2.0 brings tons of updates to the Enigma server, making it actually usable, improves the identifier panel, and adds a new print-stats command!

  • added more info to the identifier panel:
    • for inner classes, the name of their parent class is now displayed
    • for parameters, their type is now shown. this is super helpful for mapping lambdas where you can't see their type!
  • made some big changes and cleanups to the enigma server!
    • the protocol version is now 2!
    • made lots of architectural changes to streamline the code
    • greatly improved the way client approval is handled
    • added a development option to log packets
    • added a username field to the server creation dialog
    • added validation for the client's username
    • fixed lots of possible crashes (if you wanted to, it would be trivially easy to crash an enigma <2.2.0 server with a custom client)
    • added lots of new tests to make sure everything is working!
  • added a new command: print-stats
    • this command generates and prints mapping stats for on-the-go mappers who can't be bothered to crack open the swing GUI
  • added dynamic resizing for the calls tree docker's list of tokens
  • added a new shortcut constructor for LocalVariableEntry
  • added tokenization of invokedynamic arguments (this means something if you're a nerd. we promise)
  • fixed some users not seeing indentation when using the vineflower decompiler
  • updated syntaxpain to 1.1.2
    • fixes the line ruler in the code view not automatically resizing
  • updated quilt config to 1.2
  • updated vineflower to the latest 1.10.0 snapshot

2.2.1

The last release had a few bugs. They're gone now!

  • make sure MappingValidator eliminates equivalent entries from consideration -- solves some false positives
  • remove an unnecessary null check for inner classes' outer classes (the java standard allows inner classes to have no outer class)
  • fixed crashes that could be caused by deselecting "decompile inner classes" in vineflower
  • fixed incorrect synchronisation of javadoc on servers
  • fixed a possible crash when writing mappings that include a packageless class

2.3.0

As always, we've hard at work improving the beautiful software that helps mappers map. Today, we get to release all the fixes we've been working on for the last couple months!

  • added inactive states for inheritance tree dockers
    • this includes the implementations docker and inheritance docker. when they have no inheritance to display, they will show messages informing the user of their state
  • added a progress bar in the bottom right corner to indicate stat generation progress
    • this progress bar is usable for other work as well, and will be used to display other things in the future!
  • added prettier printing for field types in the identifier panel
    • matches the printing used by lambda types
  • whitespace is now automatically stripped when creating EntryMapping objects
  • development options menu is now always shown if any development options are enabled
  • added a config option for disabling stat icons
  • fixed stat icons not matching the currently editable types
  • fixed stat generation having the wrong amount of total work
  • fixed entry navigator not updating after name proposal
  • fixed checkboxes not displaying properly in the search panel
  • added a processor to display all possible language choices in the config file
  • updated dependencies
    • ASM: 9.6 -> 9.8-20240409.145119-3
      • this version is a snapshot. if you want to use enigma 2.3, you'll need to include the ow2 snapshot repository in your buildscript via adding maven { url = "https://repository.ow2.org/nexus/content/repositories/snapshots/" } to your repositories block
    • vineflower: 1.10.0-20240126.053810-85 -> 1.10.0
      • you can now remove the vineflower snapshot repository from your buildscripts!
    • quilt config: 1.2.0 -> 1.3.0
    • syntaxpain: 0.1.2 -> 0.1.5
    • cfr: 0.2.1 -> 0.2.2
    • guava: 32.0.1 -> 33.0.0
    • flatlaf: 3.2.5 -> 3.4

2.3.1

2.3.1 is your quickest bugfix release yet.

  • fixed fractional scaling not applying to docker buttons
  • fixed ASM artifact expiring