equirs / fashionscape-plugin

Fashionscape plugin for RuneLite
BSD 2-Clause "Simplified" License
1 stars 0 forks source link

Fashionscape

RuneLite plugin that enables cosmetic changes to your character's equipped items, base models, colours, and more. Other players can't see the changes this plugin makes; the intention is to provide a tool for players to preview what different combinations of models look like on them.

disclaimer: this plugin isn't intended to be on all the time. It's recommended to turn it off during combat since the animations will be wrong, and the swapped items might distract. I'm not responsible for any stupid mistakes that result from leaving the plugin on when you should have turned it off. Soon, you'll be able to configure the plugin to turn off in combat / dangerous areas.

User guide

All the UI lives in a dedicated side panel. If the plugin is on, you'll find it near the bottom of the list (beneath notes). Look for the dress form:

Panel icon

The panel has a row of button controls, and below it, three tabs: outfit, base, and search.

Top buttons

Top controls

The buttons are, in order from left to right:

Items tab

Items tab

"Items" shows every item you're wearing via the plugin. Note that certain slots, like ammo, are not shown because no items equipped in those slots change your appearance. Each item shows an icon that can be clicked to bring up a search for new items in that slot. You can also "lock" and clear out each slot with the controls on the right (see "lock mechanics" for more on locks). If nothing is set in a slot, it will display "Not set", and you will see whatever your character is actually wearing in-game. If you'd like to override what you're wearing to display nothing, this is possible by selecting "Nothing" in the search results (note: this is only possible for certain item slots).

Base tab

Base tab

"Base" is similar to "items", only this tab allows changing your character's base models and colours, essentially combining every makeover NPC into one. There is a jaw (or beard) slot that is only available to male characters, while every other slot is available to either gender. The icons in this tab have a rounded border indicating the colour you've swapped to (if you haven't changed the colour, it will show up as light gray). Note that torso+arms and hair+jaw slot colours are connected, so changing one always changes the other. There is no search feature for these slots since there not as many options; instead, clicking the icon brings up a dropdown to browse the colour/model options available.

If both "exclude non-standard items" and "exclude members items" is de-selected in the plugin config, there is also an option to change your character's icon (the ones used in Barbarian Assault and Soul Wars). While these are technically items, their mechanics function more like base models, and the UI for this slot works like all the others in "base".

Search tab

Search tab

Here you can search for equipment to try on. Leaving the search bar empty will show all the results for a selected slot (except the "all" tab, where too many results would be displayed). The results will update as you type. Hovering over an item will show a preview of what it looks like on your character. When clicked, the item will update and will display as part of your outfit. If the item is already worn, clicking it again removes it.

There are three sorting options:

Lock mechanics

You can "lock" individual slots with the lock icon next to the x button for each slot in the "items" and "base" panels (some base slots have two locks: model and colour, in that order, with the colour lock matching the current slot colour). This prevents that slot from being cleared by the randomizer and the undo/redo function. Clicking the lock again will unlock it. The locking feature is designed to work with the randomizer: as you find pieces that work together, you can lock them and randomize the remaining slots. Note that locking a base model will always lock the corresponding item slot, and unlocking an item slot will always unlock the base model. However, you can be in a state where the item slot is locked while the base slot is unlocked.

Neat things you can do with locks: * Lock the shield slot and randomize with weapons unlocked. All weapon results will be one-handed. * Lock your player's hair/beard with the head item unlocked and randomize. All the head slot results will not obscure your hair and/or beard. A similar approach can be used on the player's arms model and the torso item slot. * Lock the torso, legs, and/or boots item slots while leaving the base models unlocked. The randomizer will now scramble your base models for those slots.

Configuration

There are a bunch of items in the game which are either restricted to certain activities/events or are unobtainable without hacking the game. These can be hidden from the plugin's search results and the randomizer by checking "exclude non-standard items".

To view and randomize only free-to-play items, try "exclude members items".

The randomizer has a few "intelligence" settings. Higher intelligence means the randomizer results will yield items that are similar in colour. Lower intelligence settings are computationally faster.

There is a right-click option to "copy-outfit" on other players, which imports their entire look on your character, including items, colours, and (if your genders match) base models. Since many other plugins provide player menu entries, this feature can be toggled off.

FAQ

Q: Isn't this hacking? Am I gonna get banned?

A: Again, other players can not see your outfits, and nothing is being sent to the server via this plugin. Using it is not functionally affecting the game, so it's no different from other purely aesthetic plugins like resource packs.

Q: Why is it changing my character's arms / (facial) hair?

A: The client has no way of telling what your character's base models look like unless you reveal them, so it's using some default models. The easiest fix is to un-equip your head- and torso-slot items once. You can re-equip your items after doing this, and after you've done it once on your account, it shouldn't happen again.

Q: My animations mess up when I equip (...). Why?

Idle animations are currently the only scenario supported for now (after all, real fashionscapers are usually idle). There's not an automated way to tell which animation to use for which weapon, so unless your idle animation is wrong, it's probably not going to be fixed anytime soon.

Q: Such-and-such item isn't showing up or looks janky, why?

If you notice some items look buggy or don't have the correct idle animation, please let me know by saving the outfit and uploading / pasting the text so that I can mark that item ID appropriately. I try to keep up with newly-released items, but this also depends on other factors (for example, an item's slot is determined by the RuneLite wiki scraper).

Feature suggestions, bug reports, and pull requests are all welcome. Please keep in mind that this plugin is intended to be a tool for discovery and planning, and features that extend beyond that will probably not be implemented.