Documentation
Readme
View as plain text
=============================================
= MiSide MiSize – the Player & Mita scaler ==
=============================================
Installation
- Make sure MiSide is set up for modding. You need to install BepInEx to do this. At the time of writing you can download it at https://github.com/BepInEx/BepInEx/releases/download/v6.0.0-pre.2/BepInEx-Unity.IL2CPP-win-x64-6.0.0-pre.2.zip (or if this link is down visit: https://github.com/BepInEx/BepInEx/releases and choose the 6.0.0 (pre) version which is described as il2cpp-win-x64 )
- Unpack the BepInEx ZIP file into your MiSide install folder (usually [steam]\steamapps\common\MiSide). It should then somehow look like this: - BepInEx - Data - dotnet - MiSideFull_Data - Voice Editor - .doorstep_version - [...]
- Launch MiSide like usual – it should open another window with a text console. If it doesn – please open doorstop_config.ini in the MiSide folder and search for the line ignore_disable_switch – and set it to true. Yes, they warn you about this. But yes, on some setups this might be required (on mine for example).
- Unpack the folder PlayerScaler from the ZIP file you have this PDF from into BePinEx\plugins .
- When you open MiSide now – the console should confirm the player scaler is active as it outputs line such as Default keybind set: MitaShrink --> Keypad2 Default keybind set: MitaNormal --> Keypad5
- Congratulations – the scaler is ready to be used.
Now let’s get to configuration and using.
=============================================
==== Simple Configuration and How To Use ====
=============================================
The scaler has two modes. Basic mode (also called dynamic height mode) or fixed height mode. For now we only handle Basic Mode:
- To scale yourself in the default configuration you can use the buttons 3, 6 and 9 on the NumPad – 3 will shrink you, 6 will restore your normal size, 9 will increase your height (cannot go above normal size) – you can also press the period button under neath the 3 to restore the last used shrunken size should you have used 6 to restore your size. This allows you to keep yourself small – but if you can’t reach an item: press 6, get normal sized, grab it, press period and back down you go.
- The closest Mita to you will be scaled using 2, 5 and 8 – also on the NumPad. If there are multiple Mitas around you. Just make sure you’re as close as possible to the one you target.
- If you press / on your keypad (the key above 8) the collider for the closest Mita will be toggled - you can walk through her. This is for screenshots and closeups.
And before people scream “I don’t have a NumPad”. Don’t worry – I hear you.
- In the plugin folder ( BePinEx\plugins\PlayerScaler ) you will find a file called settings.json. You can edit it with any text editor such as Notepad. You will see a section called Keybinds. In this one you can change all button assignments to buttons which exist on your keyboard. You can use any Unity Key Code as they are listed here: https://docs.unity3d.com/6000.0/Documentation/ScriptReference/KeyCode.html .
=============================================
========== Advanced Configuration ===========
=============================================
In case you needed to change the Key assignment – you will have probably also seen a section called Configuration (and another one called Scales but that one is written automatically. Feel free to edit it but it will be rewritten often).
- FixedHeightMode (true / false, default: false): When enabled, the fixed height mode, see below gets enabled. In this mode the scaler will behave a bit differently.
- IncludeChibiMita (true / false, default: false): When enabled, chibi Mita will be treated like Mitas. In Fixed Height mode all of them will be scaled, in Basic mode the closest to the player.
- IncludeCoreMita (true / false, default: false): When enabled, Core Mita will be treated like Mitas
- ScaleFactor (1.001 to 2.0, default: 1.2): When you grow or shrink yourself or Mita your height will be multiplied or divided by this factor.
- AfterScaleSaveTimeout (2 to 60,default: 10): Only relevant when Fixed mode is enabled. It describes when to save your stored height.
- AllowColliderToggle (true / false, default: false): Allows you to enable/disable collision with Mita.
in Basic Mode the only relevant option here is ScaleFactor. In Fixed Height Mode the scaler behaves a bit differently:
=============================================
============ Fixed Height Mode ==============
=============================================
- Key binds stay identical – 2, 5 and 8 (or however you changed them) scales Mita, Period, 3, 6 and 9 scale you.
- It will not just scale the closest Mita. It will scale ALL Mitas it can detect. Hence: if you wish to have different Mitas at different scales – it won’t work in this mode.
- Colliders will be toggled for all active Mitas if enabled.
- However: this mode permanently fixes the scale – this means: even if you close and reopen the game whenever a Mita loads in – or whenever you load in, the scales will immediately apply. Thus in this mode scales are fixed for you and Mita at all times. Hence the name.
- Saving will occur a few seconds after you started adjusting the scale (set in AfterScaleSaveTimeout) . It essentially allows you to get the size correctly set, by hammering the respective buttons – and once no inputs occur it waits a few seconds – and saves.
Fixed Height Mode is disabled by default as it might have side effects: Should the game use a custom scale at other places which I’m not sure if it it does (haven’t fully played the game with the mod enabled) it might incorrectly overwrite the default game behaviour. Fixed Height Mode has been developed as an experiment and in hopes for the upcoming Peaceful Mode.
=============================================
================= Credits ===================
=============================================
Plugin developed by: haolink
My socials are:
- BlueSky: https://bsky.app/profile/hao.naturally.moe
- DeviantArt: https://www.deviantart.com/haolink
- Discord: haolink
- Twitter: @haolink (no clue what this X is)
Kudos go out to:
- Rist8: https://github.com/Rist8/MiSide-Console-Unlocker
- The console unlocker helped me understand how MiSide works and ultimately
this BepInEx plugin is based on their code. Both plugins work side by side.
- The BepInEx team https://github.com/bepinex
- AIHASTU: For MiSide