1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

Documentation Preview (Alpha)

Discussion in 'General Discussion' started by Krilion_GD, Sep 18, 2017.

  1. Krilion_GD

    Krilion_GD Community Manager
    Staff Member

    Joined:
    Aug 1, 2011
    Messages:
    1,530
    Likes Received:
    102
    upload_2017-9-18_19-6-19.png

    I have put up a Preview of the documentation. It will be updated and changed as work brings it closer to production level. Right now however, it is about 70% done. There are large sections, not complete or defined yet, this is due to wanting to cover those at the last possible minute; since work in those areas is changing on almost a daily basis. There are, I am sure, many things that will need clean up or expounding upon.

    In looking over what is currently there, please make suggestions, note errors or typo's so they can be corrected. Please make those comments here in this thread.

    The Preview Documentation is located http://www.guide.d20pro.com/

    if you would like to track work on the documentation, the trello board for the docs is at https://trello.com/b/JNfbTPJb/d20pro-documentation
     
    #1 Krilion_GD, Sep 18, 2017
    Last edited: Sep 22, 2017
    Irondeacon likes this.
  2. Krilion_GD

    Krilion_GD Community Manager
    Staff Member

    Joined:
    Aug 1, 2011
    Messages:
    1,530
    Likes Received:
    102
    So, what's the word gang? Like it, hate it? see any typos?, corrections needed?
     
  3. HippyCraig

    HippyCraig New Member

    Joined:
    Jul 15, 2017
    Messages:
    18
    Likes Received:
    0
    I just started to look at it, but its very well organized ! Much easier than before.
     
  4. mrwinfree

    mrwinfree New Member

    Joined:
    May 1, 2016
    Messages:
    22
    Likes Received:
    0
    Krillon
    it is much better organized.
    I have taken the liberty to edit some of the documentation. I have attached a copy of what I have done so far. This is focused primarily on cleaning up language and making it (hopefully) flow a little easier. I have tried not to change the content as, quite frankly, you are the expert there!

    If you find this helpful or appropriate in anyway, I will be happy to start a shared doc for you to access and review at your leisure. Please note in the word document I started in, I kept the links. I don't know if they translated to .pdf.

    Thanks,

    Mickey Winfree
     
  5. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
    http://www.kriliongd.d20pro.com/gs_download_installation/
    Go to the main website and follow the instructions for downloading the software. There are options for several operating systems (Win32, Win64, Linux, Mac). Select the download appropriete for your system. Dowloads are typically placed into a downloads directory.

    appropriate
    downloads

    If you are looking for a historical copy or a Beta copy of D20PRO, please go to the Archive Site. Here you will find older copies of D20PRO installation files as well as Public Beta files. If you are looking for early access Closed Beta files, they are here as well. The creditials needed to log into the Archive are sent to you via the Early Access mailing list. If you can not find that, contact support and request them.

    credentials

    http://www.kriliongd.d20pro.com/gs_hosting_a_game/

    The System Refernce Document you would like to use for your game session.

    Reference

    You can find this information from within D20PRO by going to Main Menu -> Options -> Judge -> Get IP Address.
    For people connecting localy (same Lan) give them your Lan IP (assigned to your local machines by your router) address. For people connecting remotely (Not Local) give them your Wan IP (assigned by your WSP to your router) address.

    ISP

    Direction Connections

    Several things have to happen in order for Direct Connections to work correctly. You have to provide accurate information to your players. You will also need to 'port forward' the port used via your router. You may also need to allow access via your PC firewall. Each router and/or firewall is difrent. If you Contact Support for help with Direct Connections, please make sure to include information on the Operating System used, the Make & Model of your router, any Firewall or Scurity Suite software you are using along with version numbers.

    Different
    Security

    Processes the launch perameters and tries to connect with the given information.

    Parameters

    http://www.kriliongd.d20pro.com/gs_manage_campaigns/
    SRD:
    The system Refrence Document site used for your campaign.

    Reference
     
  6. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
    http://www.kriliongd.d20pro.com/ct_shortcuts/

    Saves your current session (map, creatures in play, itit order, effects, etc).

    Initiative or Init

    http://www.kriliongd.d20pro.com/ct_menu_buttons/

    The help button launches this Documentaion site (this website) for finding help with D20PRO. If you cannot find the answer to your question here, we have lots of ways for you to contact us or ask the community for assistance. Please see the Welcome page for a full list of contact methods.

    Documentation

    Tokan Charge should be Token

    http://www.kriliongd.d20pro.com/ct_right_click_menu/

    There are numerous options here that are only availible to the Gm or Token Owner as well.

    Available
    GM

    http://www.kriliongd.d20pro.com/ct_templates/

    OK:
    Changes the curser into a template with the perameters selected for placement on the map. The escape kep will cancel placement.

    Cursor
    Parameters
    key

    http://www.kriliongd.d20pro.com/ct_token_movement/
    the 2X is really hard to see with yellow. I know this is the color assigned to it, but it blends into the white background
    It will show 3x for tripple and so on.

    Triple

    It does not however at this time take into account things such as verticle movement or difficult terrain

    Vertical

    http://www.kriliongd.d20pro.com/ct_token_facing/
    If your game system requires facing (or your GM requires facing), you can utilize the following Shortcut Keys [ & ] or the Rick-Click Menu->Rotate to accomplish this task. Make sure the Creature/Token is selected prior to using the keyboard command.

    Right-Click

    http://www.kriliongd.d20pro.com/ct_making_attacks/
    Here you will be presented with a list of you current Attack options. Simply click on each Oppropriate attack, clicking again on an attack line will deselect it. Also, if an attack option has multiple attacks itself, you'll see these listed as small green balls in the right upper side of the listed attack. These can be toggled off or on as needed. Green is active (default), Grey is inactive (deselected).

    Appropriate

    Hitting OK at the bottom will move you forward in the Attacl process to selecting your target.

    Attack

    Selecting your target is as simple as moving the mouse over your intended target and Left-Clicking the mouse. Hitting the Escape Key will cancel this process if you have erroniously clicked on the wrong target. If you are using something that has more than one Attack or is able to split your Attack, you will be propmpted to Select targets multiple times. Some basic information about the target will also show as a tool tip when you mouse over the target.

    erroneously
    prompted

    They can change the Di result by clicking on the Di and adjusting the number.

    Die

    Sneak Attack:
    Toggling this box allows you to apply addition die types and modifiers to that di type for situations such as Sneak Attacks, but can easily be used for other things as needed that would give additional damage.

    Die

    This screen propmts the GM to confirm any Damage done by the Attack. If for some reason there needs to be adjustment, the GM can click on the Damage amount and will be presented with an Override/Adjustment box for changing the amount of damage for the Attack.

    Whn the GM hits OK, the Attack will be fully resolved, damage if any will be applied to the token and the final results will be output to the Common Tasks/Game Log.

    prompts
    When

    Here you can see the results of the Attack. The victem shows damage by the red overlay that fills the token from the botton (least damage/full hp) to the top (max damage/hp). If the victim dies, the icon will change to a Skull or other appropriate icon for the game system. The details of the Attack, who attacked who and the dice as well as the damage results will also be output to the Common Tasks/Game Log.

    Victim
    Bottom
     
  7. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
    http://www.kriliongd.d20pro.com/ct_skills/

    upload_2017-9-21_21-19-27.png

    Skills are an important part of any RPG game.
    Double Click on the Blue Die next to the skill you wish to roll

    upload_2017-9-21_21-20-21.png

    Name and Delete button aren't showing up with your bold setup, it has a ** in the beginning

    upload_2017-9-21_21-20-42.png

    particular Stat or combination

    http://www.kriliongd.d20pro.com/ct_marketplace/

    upload_2017-9-21_21-18-59.png

    The sync word has one ' in it, so I think you were trying to single quote it (?) Not sure what you were going for here.

    http://www.kriliongd.d20pro.com/ct_app_options/

    upload_2017-9-21_21-18-29.png

    Wheel

    http://www.kriliongd.d20pro.com/pg_token_character_updating/

    upload_2017-9-21_21-17-31.png

    I would end the sentence on approval and start a new one on please

    upload_2017-9-21_21-23-16.png

    toggling
     

    Attached Files:

    #7 vanith, Sep 22, 2017
    Last edited: Sep 22, 2017
  8. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
    #8 vanith, Sep 22, 2017
    Last edited: Sep 22, 2017
  9. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
    http://www.kriliongd.d20pro.com/gg_management_creatures/

    upload_2017-9-21_21-29-55.png

    Careful (looks like the same object was used in this screenshot)

    Don't forget that http://www.kriliongd.d20pro.com/gg_management_items/ is completely empty with a screenshot

    http://www.kriliongd.d20pro.com/gg_rules_library/

    upload_2017-9-21_21-32-26.png

    holds templates that are used in conjunction

    http://www.kriliongd.d20pro.com/gg_game_time/

    You should add how to modify the game time with screenshots in this window. Oh, you already added the shortcuts, sweet. You should write a small quip that goes like "If you want to see some quick command shortcuts, go to <insert link>."

    http://www.kriliongd.d20pro.com/gg_combat_mode/
    upload_2017-9-21_21-35-43.png

    Re-adjust? That looks funky

    http://www.kriliongd.d20pro.com/gg_fow_simple/
    upload_2017-9-21_21-39-50.png
    lighting use an older form of lighting.. wait.. that looks weird.

    For a less complex form of lighting, use an older form of it (Visible/Not Visible).
    I dunno, my ADHD and OCD are going crazy, probably me.

    upload_2017-9-21_21-44-2.png

    to Invisible so they are not seen by the party



    Would this be easier to link as a video instead of explaining it as a static display? Hmm.. some features with invert aren't in the system anymore.

    http://www.kriliongd.d20pro.com/gg_fow_masks/

    I like how this is explained

    upload_2017-9-21_21-55-50.png
    It doesn't look blue directly above because it's currently active in the Edit mode.
     
  10. Krilion_GD

    Krilion_GD Community Manager
    Staff Member

    Joined:
    Aug 1, 2011
    Messages:
    1,530
    Likes Received:
    102
    Many thanks, Vanith. I've hammered these and will upload the fixes shortly.
     
  11. Krilion_GD

    Krilion_GD Community Manager
    Staff Member

    Joined:
    Aug 1, 2011
    Messages:
    1,530
    Likes Received:
    102
  12. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
    http://guide.d20pro.com/gg_fow_lights/

    upload_2017-9-22_19-26-13.png

    meaningful
    Radius

    upload_2017-9-22_19-26-59.png
    Don't forget to finish out this area

    http://guide.d20pro.com/gg_game_tools/

    upload_2017-9-22_19-28-33.png
    Don't forget to capitalize the name of the product :)

    http://guide.d20pro.com/gg_draw_tools/

    upload_2017-9-22_19-30-36.png

    inmporting => importing

    upload_2017-9-22_19-33-15.png
    You have Paint Images twice, unless that's something you intended to do *shrug*

    http://guide.d20pro.com/gg_advanced_custom_data/

    upload_2017-9-22_19-36-33.png

    The location of the files will be confusing for a first time GM, it would be better to explain it like this: (I knew what you were talking about)

    "\D20PRO\judge\campaigns\<name of campaign>\res\ManuallySpecified\" folder

    classess = classes

    upload_2017-9-22_19-40-49.png

    availible = available

    upload_2017-9-22_19-41-30.png

    Atribute = Attribute

    One thing to add in this section is that adding spells to the classes.txt automatically adds to the spells.txt (Owlbear told me this one)
     

    Attached Files:

  13. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
    http://guide.d20pro.com/oi_release_notes/

    upload_2017-9-22_19-47-6.png

    I don't know if you were trying to bold the title of this one, but it looks different from the rest of the separated titles.

    upload_2017-9-22_20-2-9.png

    This is one running sentence without any punctuation and weird formatting.
     

    Attached Files:

  14. Krilion_GD

    Krilion_GD Community Manager
    Staff Member

    Joined:
    Aug 1, 2011
    Messages:
    1,530
    Likes Received:
    102
    starting to line out the Rules Library

    upload_2017-9-24_2-9-2.png
     
    Zandu likes this.
  15. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
  16. Mickey

    Mickey Member

    Joined:
    Jun 19, 2015
    Messages:
    66
    Likes Received:
    4
    Can I suggest using 'Links' instead of 'Linkages'?

    'Link' and 'Links' are more commonly accepted than 'Linkage' and 'Linkages' on websites.
     
  17. Krilion_GD

    Krilion_GD Community Manager
    Staff Member

    Joined:
    Aug 1, 2011
    Messages:
    1,530
    Likes Received:
    102
    Link and Links is perhaps the more common term, due to over usage or just plain laziness, however, the proper terminology is linkage. Also more due to the fact that to what the term refers to is external to the source rather than an internal one.

    Also, I highly doubt there is any chance of misunderstanding as to what is being described in the section with the usage of the word.

    I appreciate the suggestion though, and it sparked an interesting conversation with my wife, who is an English teacher of 20 years.
     
  18. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
  19. vanith

    vanith Member

    Joined:
    Jan 22, 2011
    Messages:
    120
    Likes Received:
    7
    http://guide.d20pro.com/pg_items/

    upload_2017-11-28_23-11-29.png

    mony should be money

    upload_2017-11-28_23-12-6.png

    If an item isn't on the list, you can create a new item by hitting the 'Add New' button at the bottom. (seems disjointed when spoken aloud, I may be wrong)
     
  20. mrwinfree

    mrwinfree New Member

    Joined:
    May 1, 2016
    Messages:
    22
    Likes Received:
    0
    http://guide.d20pro.com/ct_shortcuts/
    This list is for Mac keyboard command shortcuts. I used a Macbook Air to test the keystrokes.

    Just looked at the command short cuts on D20PRO Guide and found the following:
    Grid, Toggle Option + G
    Mini, toggle (no keystroke make this happen) 3.7.1.15
    Ruler, toggle Option + R
    Initiative, Leave Option + I
    Maps, jump to Option + (1-9)
    Rolls, Toggle option + /
    GM Rolls toggle Change HAME to Game (this is a duplicate of Rolls, toggle. consider removing altogether)
    Turn, Charge, Delay & Ready Action I would remove these completely from the list as there does not appear to be a keyboard shortcut for these three commands.

    (Space Bar for Turn, End is still broken in 3.7.1.15)

    If there was no difference between the Windows and Mac keystroke commands, I did not include them in this list.
     

Share This Page