yulun-bili / mod-menu-revamped

A revamped mod menu for game Teardown

Mod Menu Revamped

This is a revamped version of vanilla mod menu.

New Features

• Redesigned UI layout
• Display mod preview
• Search mod
• More mods filtering & sorting options
• Mod collections
• Manually Refresh mods
• Click & View published local mod's workshop page
• Tooltips
• Preview publish mod name & description in other languages

Download & Installation

Issues & Pulls

Open to everyone, but would only accept good ones.

Other

• Due to game restrictions, some game files cannot be overwritten by mods (unlike tool models or asset scripts). Therefore this mod cannot be published as a workshop mod
• This mod is a User Created Content and Intellectual Property for game Teardown

mod-menu-revamped's Issues

Workshop mods with tag "map" doesn't show "Details..." button

Mod category button Improvement

Current category changing button is not visually standing out therefore users may not realize it's clickable.

• Discussion on Discord

Cannot quit mod menu

After opening mod menu and clicking [new collection] text input box, mod menu cannot be quitted

Manage savegame.xml

• Show space occupied by mods (by bytes)
• Ability to clear a mod's savegame data
• Ability to clear leftovers from unknown/deleted/unsubscribed mods

(Λutumn#6684)

Improve search function

Search filters (e.g.: mod type, author)

Automatic Collection

Automatically collect mods matching certain rules

Add filter "New" for workshop mods

Add an option to show recently subscribed or updated mods in a dedicated category

Add Category"Enabled"

Needs further investigation before implementing

View local mods in workshop when possible

If a local mod have id.txt, menu would show "Details..." button and open link to workshop in web browser (not in steam overlay)

Crash when creating new collection

Random map picker

pick one or give a list of random maps (@doomdrvk on discord)

Search Mods: Mod type filter indication not matching filtering result

Crash when toggling mods in collections

Update to latest version

As of the creative update, the mod no longer functions

Menu preferences

• Change initial category to "Subscribed" or "Local"
• Change initial filter
• Open with last selected

Formatted mod description (phase 1)

• line break %br
• misc formatting %*{text}
  • bold b
  • italic i
  • underline u
  • header h1 h2 h3

Mod info not updated when change language

Search list related issue

Bugs & Potential Improvements

• Search list would only update upon changes towards search texts
• Mods cannot be enabled from search list

Potential Features

• Click on Search button to quit search mode
• Quit to selected mod's category

Path for workshop mods

Show path for workshop mods (1ssnl#2130)

Doesn't work for 1.5.2

I installed it correctly, but the menu doesn't work, only the original one shows up. Is that a problem only for me or is it global?

Formatted mod description (phase 2)

• list %l*{1st line in list}%l*{2nd line in list}%l*{%l*{1st line in 1st nested list}}
  • %ll doted list
  • %ln numerical list
  • %la alphabetical list (%lA for upper case)
• colour %39C5BB{text here}(hex)/%4CB{text here}(short hex)

Turning on mod with little dot - crash

Search list not updating upon operations

e.g.: unsubscribing mod in search list does not remove the mod from list

custom method handling wrapping

• handle \n
• handle special case characters
  • %pc as % to avoid formatting confusion when necessary
  • %lf as \n to avoid cases when \n is impossible to exist in source string
  • %lb & %rb as { & } to avoid formatting confusion when necessary
• handle wrapping

Change collection save location from savegame to options

Prevent resetting game progress clearing collections

Cannot quit menu in game version 1.5.2

Cannot create new collections

Due to issue #528

Manual refresh mods

add manually refresh function

Language preview for mod name & description

Add language selection to publish window. Users can preview mod name & description in another language

Rich text support

Implement rich text support

• #42
• #35
• #36

Rich text would chose a file format similar to MS's RTF, using brackets and keywords representing text formatting.

Improved control towards mod list

• Ctrl or Shift for faster scrolls
• PgUp PgDown Home & End

Click to collect all enabled mods

Right click on an empty collection shows drop down menu with this option, or right click in collection listing shows drop down menu with this option.

*Thanks @lelanceflamer (discord) for reminding me this

Improve collection operation

• #43 (helpful for mod issue investigation)
• collect from mod list directly
• #12

[Need further investigation]

Improvement towards search list right-click operation

If I search for a mod and right-click it, the unsubscribe button doesn't pop up, but if you try to unsubscribe from the same mod without searching, you can unsubscribe just fine. This is a video showcasing the issue:

2023-12-22.14-57-46.mp4

[Bug] {1.5.0 Experimental} Cannot create mods

When you right-click on the local mods it spams the console with errors and the mod creation options do nothing.

Removal of built-in mod paths

due to #529

Localization

Project on Crowdin
progress for UI compatibility

• English
• French
• Spanish
• Italian
• Germany
• Chinese (simplified)
• Japanese
• Russian
• Polish