Updated file name of VTM_Dice_Mechanics. Updated docs

2018-09-05 23:08:44 +01:00
parent 921d2fcae0
commit bf8aba0fc2
3 changed files with 24 additions and 19 deletions
@@ -1,14 +1,15 @@
-# Character sheet for Vampire The Maquerade, 5th Edition (v1.1)
+# Character sheet for Vampire The Maquerade, 5th Edition (v1.2)

 ## User Guide (Please read)

 While this sheet is designed to be as intuitive as possible and to aid in stream lining your game there are several key features which are worth being aware of.

 1. Custom fonts. While the sheet as default fonts it is also programmed to use custom fonts. If you want access to them, when in your game click the shield icon in the right of your address bar and select to allow the script.
-2. Inline vs API rolling. If your ST is a Roll20 Pro-account holder they should have access to the API script, in this case we highly recommend you ensure the check box at the top of each character sheet (just below the tabs) is checked. This will unlock a number of different features including banners, re-rolls, custom dice displayed that will make you gaming experience a lot more streamlined. Unfortunately this functionality cannot be ported to Inline rolling due to programmatic restraints.
+2. Inline vs API rolling. If your ST is a Roll20 Pro-account holder they should have access to the "Vampire The Masquerade 5th Edition Dice Mechanics" API script, in this case we highly recommend you ensure the check box at the top of each character sheet (just below the tabs) is checked. This will unlock a number of different features including banners, re-rolls, custom dice displayed that will make you gaming experience a lot more streamlined. Unfortunately this functionality cannot be ported to Inline rolling due to programmatic restraints.
+3. (Pro-account holders) To install the API script: Go to Settings -> API Settings. If the "Vampire The Masquerade 5th Edition Dice Mechanics" API is available and uploaded to Roll20, select it in the dropdown menu and press save. You are now good to go. If it is not, please perform the following extra steps. Click New Script and call it hq.js (any name will do, but its a nice nod to Konrad's work). Copy the contents VTM Dice Mechanics.js (as found alongside this character sheet in the Roll20 Github repository) in the hq.js window and press save. That's it

 Notes on Inline rolls.
-1. Many of the buttons on the sheet will do much of the rolling for you, either calculating how many dice you need or aiding you with selection. In cases where Hunger dice are used (Attribute, Ability, Discipline rolls). If you dice pool is 3, but your hunger is 4, then 4 hunger dice will be rolled and the number of successes may be misleading. By hovering your mouse over the number of successes you can determine what dice rolls were made and you can take the first 3. This is not an issue for the API rolls.
+1. Many of the buttons on the sheet will do much of the rolling for you, either calculating how many dice you need or aiding you with selection.
 2. To find out exactly what dice have been rolled, hover the mouse over the number of successes. In rolls where the Hunger dice are used (Attribute, Ability, Discipline rolls) if you fail, check to see if you rolled a 1 on the Hunger dice. If this is the case then consult the rules to determine how to proceed (Page 207, 208). Further, in this case the number of vampire dice will be negative, please ignore this.
 3. If the number on number of successes is green, you may have rolled a critical success. Hover the mouse over and count how many 10's a rolled to determine if you rolled a critical (Page 120) or a messy critical success (Page 206, 207). Please note, the extra 2 successes for a Crit are not automatically added.

@@ -80,10 +81,12 @@ Please note this is version 1.0, a set of updates are in progress.

 If you think anything is missing or you see any bugs, please message me via my [Roll20 Account](https://app.roll20.net/users/117780/ Roll20 Account)

-The issue with Inline rolls is known about and will be fixed by 11/09/18
-
 ## Versions

+### Version 1.2
+Fixed inline rolls so they now display hunger and vampire dice correctly if hunger dice pool is greater than the initial dice pool.
+Fixed Predator Rolls
+
 ### Version 1.1
 Bug fixing to ensure the names are correctly displayed. 
 Added the capacity to roll humanity.
@@ -1,4 +1,4 @@
-// Vampire the Masquerade 5e Dice Mechanics by Momtahan K (Version 1.1).
+// Vampire the Masquerade 5e Dice Mechanics by Momtahan K (Version 1.2).
 //
 // The following code is an adaptation of that produced by Roll20 user Konrad J. for "Hero Quest Dice Mechanics". 
 // Many thanks for providing this code free to use.
@@ -7,7 +7,7 @@
 // Portions of the materials are the copyrights and trademarks of White Wolf Publishing AB, and are used with permission. All rights reserved. For more in formation please visit whitewolf.com
 //
 // With the exception of materials under the copyright of White Wolf all extra code should be considered under
-// GNU General Public License v3 or later (GPL-3.0-or-later) Copyright 2018
+// GNU General Public License v3 or later (GPL-3.0-or-later) Copyright 2018 held my Momtahan.K
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -26,6 +26,12 @@
 // Effectively feel free to use, edit and modify the code to your hearts content. As I understand it this will only cause an issue if you 
 // try to use it for commerical gain. This has been added to ensure the community benefits from it.

+// Versions
+// Version 1.2
+// Updated images to a different location
+// Version 1.1
+// Bug fixes and updated images to a different location
+

 // Guide to use the code
 // The first two lines I am no longer sure if they work and require testing.
@@ -1,5 +1,5 @@
 <!--
-    Vampire the Masquerade 5e Alpha Character Sheet (Version 1.1)
+    Vampire the Masquerade 5e Alpha Character Sheet (Version 1.2)

    Author: Momtahan K. | UserID: 117780
    Design: Martinez A. | UserID: 143652
@@ -24,7 +24,7 @@
    Legal
    Portions of the materials are the copyrights and trademarks of White Wolf Publishing AB, and are used with permission. All rights reserved. For more in formation please visit whitewolf.com

-    With the exception of materials under the copyright of White Wolf all extra code should be considered under GNU General Public License v3 or later (GPL-3.0-or-later) Copyright 2018
+    With the exception of materials under the copyright of White Wolf all extra code should be considered under GNU General Public License v3 or later (GPL-3.0-or-later) Copyright 2018 held my Momtahan.K

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -3103,8 +3103,9 @@
                            fonts. If you want access to them when in your game, click the shield icon in the right of your
                            address bar and select to allow the script (Firefox may behave has similar setting).
                        </li>
-                        <li>Inline vs API rolling. If your ST is a Roll20 Pro-account holder they should have access to the
-                            API script. In this case we highly recommend you pester them to ensure you can use them and check
+                        <li>Inline vs API rolling. If your ST is a Roll20 Pro-account holder they should have access to the "Vampire
+                            The Masquerade 5th Edition Dice Mechanics"
+                            API script. In this case we highly recommend you pester them to ensure you can use it and check
                            the check box at the top of each character sheet (just below the tabs). This will unlock a number
                            of different features including banners, re-rolls and custom dice displayed that will make you
                            gaming experience a lot more streamlined. It will also mean there are less manual steps for each
@@ -3129,18 +3130,13 @@
                <td>
                    <ol start="1">
                        <li>Many of the buttons on the sheet will do much of the rolling for you, either calculating how
-                            many dice you need or aiding you with selection. In cases where Hunger dice are used (Attribute,
-                            Ability, Discipline rolls), the Hunger dice are automatically subtracted from your Vampire dice
-                            and rolled as a separate pool. However, if you dice pool is 3 but your hunger is 4, then 4 hunger
-                            dice will be rolled and the number of successes may be misleading. By hovering your mouse over
-                            the number of successes you can determine what dice rolls were made and you can take the first
-                            3. This is not an issue for the API rolls.</li>
+                            many dice you need or aiding you with selection.</li>
                        <li>To find out exactly what dice have been rolled, hover the mouse over the number of successes.
                            In rolls where the Hunger dice are used (Attribute, Ability, Discipline rolls) if you fail, check
                            to see if you rolled a 1 on the Hunger dice. If this is the case then consult the rules to determine
                            how to proceed (Page 207, 208). Further, in this case the number of vampire dice will be negative,
                            please ignore this.</li>
-                        <li>On a roll if the number of successes is green, you may have rolled a critical success. Hover
+                        <li>On a roll, if the number of successes is green, you may have rolled a critical success. Hover
                            the mouse over and count how many 10's a rolled to determine if you rolled a critical (Page 120)
                            or a messy critical success (Page 206, 207). Please note, the extra 2 successes for a Crit are
                            not automatically added.
@@ -3227,7 +3223,7 @@
            <tr>
                <td>
                    There are two sections in the Custom Rolls section currently. The top section is for people with access to the API, the bottom
-                    is for those who are using the In-line rolling. This is a great section to store all your individual
+                    is for those who are using the Inline rolling. This is a great section to store all your individual
                    discipline rolls or any rolls you make often. There are however a couple points to note about this section.
                </td>
            </tr>