SliceCraft / SliceCraft/MiSideSpeedrunMod

Add a config option to the BepInEx Plugin so in development features can be disabled

Open
#13 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
C#
Stars
4
Forks
2
Avg merge
12m
Merged PRs (30d)
1

Description

Features that are in development shouldn't appear unintentionally but should still be accessible to developers.
To achieve this an option should be added to the plugin, something like a devmode.
When this option is enabled and the game is restarted the mod should now show options that would otherwise be hidden.

Currently the only place where this should be used is the MAKE MANNEQUIN menu option in Menus/Practice/PractiveMenu.


Important note for people passing by this issue

It's important that enabling devmode should never give the player running the mod an unfair advantage.
If a feature is implemented that would give the player an unfair advantage (like enabling running) this should always be shown on the screen in some way (like with the EventDisplay system) so that speedrun verifiers can see that unfair features are being used.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the BepInEx plugin configuration and reading Menus/Practice/PractiveMenu, especially the MAKE MANNEQUIN option. Add a development-mode setting that takes effect after a game restart and controls visibility of that option. Done means the option stays hidden by default, appears when devmode is enabled, and any unfair future features remain visibly identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
game-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.