Skip to content

Commit

Permalink
Final commit for v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Moerill committed Aug 10, 2020
1 parent 49a5303 commit e99bc65
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Find the culprit

<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/moerill/fvtt-find-the-culprit?style=for-the-badge"> <img alt="GitHub" src="https://img.shields.io/github/license/moerill/fvtt-find-the-culprit?style=for-the-badge"> <img alt="GitHub Releases" src="https://img.shields.io/github/downloads/moerill/fvtt-find-the-culprit/latest/total?style=for-the-badge"> [![PayPal](https://img.shields.io/badge/Donate-PayPal-blue?style=for-the-badge)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FYZ294SP2JBGS&source=url)
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/moerill/fvtt-find-the-culprit?style=for-the-badge"> <img alt="GitHub Releases" src="https://img.shields.io/github/downloads/moerill/fvtt-find-the-culprit/latest/total?style=for-the-badge"> [![PayPal](https://img.shields.io/badge/Donate-PayPal-blue?style=for-the-badge)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FYZ294SP2JBGS&source=url)

This module helps you debug compatibility issues of modules, by finding the module that is responsible for the issue, without having to manually activate and deactivate all your modules yourself. Just click the **Find the culprit** button in **Module Management** to start the process.
* You will be asked to select a module to keep active at all times. Choose the module that you want to debug.
* Your page will refresh, deactivating all modules, except the chosen one and this.
* Check whether your issue still persists.
* If the issue persists, the module will start a binary search by only reactivating half of your previous modules, refreshing the page, going on like this until the culprit is found.
* Just follow the prompts appearing after each refresh.
* Depending on the amount of modules you have installed this process could take a while, but at most ``log(n) + 2`` iterations, where *n* is the amount of modules you had activated.
* Depending on the amount of modules you have installed this process could take a while, but at most ``log(n) + 2`` iterations, where *n* is the amount of modules you have activated.
* If you accidently close one of the prompts, just refresh the page manually and it will reappear.

## Licensing
This module currently is not licensed itself.
<img alt="GitHub" src="https://img.shields.io/github/license/moerill/fvtt-find-the-culprit?style=for-the-badge">

This work is licensed under Foundry Virtual Tabletop [EULA - Limited License Agreement for module development](https://foundryvtt.com/article/license/).

Expand Down
4 changes: 2 additions & 2 deletions js/find-the-culprit.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ function startDebugging(ev) {
<option value="">None</option>
${settings.current.map(e => `<option value="${e}">${game.modules.get(e)?.data.title}</option>`).join('')}
</select>
<p>After clicking start the page will refresh and you will be prompted to check whether your issue still exists. This will possibly repeat multiple times until the culprit was found.</p>
<p>After clicking start the page will refresh and you will be prompted to check whether your issue still exists. This will repeat multiple times until the culprit was found.</p>
<p>After the culprit was found you will be able to choose whether you want to reactivate all currently activated modules or not.</p>
<p>Don't worry if you accidently closed the window, just refresh the page manually and it will reappear.</p>`,
<p>Don't worry if you accidently close one of the popups, just refresh the page manually and it will reappear.</p>`,
buttons: {
yes: {
icon: '<i class="fas fa-check"></i>',
Expand Down
6 changes: 3 additions & 3 deletions module.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "find-the-culprit",
"title": "Find the culprit",
"description": "This module helps you to find a module causing issues (for another module).",
"description": "This module helps you to find a module causing issues, by automating the process of deactivating and reactivating modules.<br>Just click the 'Find the culprit' button inside Module Management.",
"version": "1.0.0",
"minimumCoreVersion": "0.6.0",
"compatibleCoreVersion": "1.0.0",
"author": "Moerill",
"esmodules": ["js/find-the-culprit.js"],
"manifest": "https://raw.githubusercontent.com/Moerill/fvtt-find-the-culprit/master/src/module.json",
"manifest": "https://raw.githubusercontent.com/Moerill/fvtt-find-the-culprit/master/module.json",
"url": "https://github.com/Moerill/fvtt-find-the-culprit",
"download": "https://github.com/Moerill/fvtt-find-the-culprit/releases/download/v0.3.2/markdown-editor.zip"
"download": "https://github.com/Moerill/fvtt-find-the-culprit/releases/download/v1.0.0/v1.0.0.zip"
}

0 comments on commit e99bc65

Please sign in to comment.