Skip to content
This repository was archived by the owner on Jul 21, 2024. It is now read-only.

Commit f6f9d0c

Browse files
committed
Updated Readme for 1.3.0 changes
1 parent 425647c commit f6f9d0c

File tree

3 files changed

+73
-17
lines changed

3 files changed

+73
-17
lines changed

README.md

+73-17
Original file line numberDiff line numberDiff line change
@@ -5,40 +5,96 @@
55

66
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Q5Q01YIEJ)
77

8-
Simple text-only rollable tables from CSV (or any-SV) data
8+
Easy RollTables from CSV (or any-SV) data!
99

10-
Useful for populating a table with character names, prefixes for TokenMold or any other textual data.
10+
Now includes Entity Collections! (Items, Actors, Scenes, Macros, Playlists, JournalEntrys, RollTables)
1111

12-
EasyTable will automatically set the roll formula to 1d{number of entries}, and enable Draw With Replacement and Display To Chat. These can still easily be changed by editing the table
12+
See 'Entity Collections' section below for details.
1313

1414
---
1515

16-
## Usage Instructions
16+
## Method 1 - CSV or *-sv Input
1717

18-
### Standard
18+
1. Go to the RollTables tab in FVTT
19+
2. Click on the CSV to Table button
20+
3. Fill in the table title, description(optional) and copy/paste your *-sv data
21+
4. Generate
1922

20-
1. Go to the Rollable Tables tab in FVTT, click the New EasyTable button.
21-
2. Fill in the table title, description(optional) and copy/paste your comma-separated values *
22-
3. Generate!
23+
### Weighting Entries
24+
25+
Entries can be weighted by adding integers inside curly braces after the entry name, and before the separator.
26+
27+
Higher weight entries will be randomly selected more often, by expanding the range and weight in the table.
28+
29+
Weighting example data:
30+
31+
`Entry 1, Entry 2{2}, Entry 3{4}, Entry 4`
32+
33+
In this example, the resulting table will be a `1d8` roll with the following ranges.
34+
35+
* Entry 1 - 1
36+
* Entry 2 - 2,3
37+
* Entry 3 - 4,5,6,7
38+
* Entry 4 - 8
39+
40+
### NEW in 1.3.0 - Entity Collections
41+
42+
You can now use EasyTable to create 'Entities' in your tables.
43+
44+
Entities can reference: 'Actor', 'Scene', 'Macro', 'Playlist', 'JournalEntry', 'RollTable', 'Item'
45+
46+
The Entity must exist in your world, and not inside a Compendium.
47+
48+
Non-existant entities will simply output as text.
49+
50+
#### Default Entity
51+
52+
There is a new `Default Entity` dropdown in the CSV importer. You can change this to any of the entity types. Any data inserted into the table without a specific entity tag will be checked to see if it exists as this entity type.
2353

24-
*You can now weight your table entries with curly braces
54+
For example:
2555

26-
eg. `val1,val2{2},val3,val4{4}` will generate a 1d8 table where val2 is selected on a roll of 2 or 3, and val4 is selected on a roll of 5-8
56+
I have a `Greatsword` item and a `Bow` item in my Items directory.
2757

28-
<img title="" src="./docs/easytabledemo.gif" alt="" data-align="inline">
58+
I set the `Default Entity` to `Item`, then import `Greatsword,Bow,Crossbow`
2959

30-
### Alternate
60+
The resulting table will contain a fully linked reference to the `Greatsword` item, and the `Bow` item.
3161

32-
Alternate input is designed to allow you to copy and paste data from tables in digital sourcebooks, or from the web.
62+
The `Crossbow` entry will revert to a simple text entry, as it does not exist in this instance.
63+
64+
#### Per Entry Entity
65+
66+
The Weighting brackets can also be used to specify a particular Entity type for an entry.
67+
68+
This can be combined with the `Default Entity` dropdown to make things easier.
69+
70+
The entity should be tagged with an `@` symbol followed by the entity type inside the weighting brackets.
71+
72+
If the entry also has a weight, the entity tag should come after the weight.
73+
74+
For example:
75+
76+
I have a `Greatsword` item and a `Bow` item in my Items directory.
77+
78+
I have a `Cool Scene` scene and a `Cooler Scene` scene in my Scenes directory
79+
80+
I set the `Default Entity` to `Item`, then import `Greatsword,Bow,Cool Scene{@Scene},Cooler Scene{4@Scene}`
81+
82+
The resulting table will contain fully linked references to the `Greatsword` and `Bow` items, and fully linked references to the `Cool Scene` and `Cooler Scene` scenes. The `Cooler Scene` entry will also have a weight of 4.
83+
84+
## Method 2 - TablePaste Input
85+
86+
TablePate input is designed to allow you to copy and paste data from tables in digital sourcebooks, or from the web.
3387

3488
As long as the table has the dice roll in column 1 and the value in column 2, you should be able to highlight and copy all of the values to use with EasyTable
3589

36-
1. Go to your Module Settings and enable the alternate input for EasyTable
37-
2. Go to the Rollable Tables tab in FVTT, click the New EasyTable button.
90+
1. Go to the Rollable Tables tab in FVTT, click the New EasyTable button.
91+
2. Click the TablePaste button
3892
3. Fill in the table title, description(optional) and copy/paste some data from a table (e.g The random misfortunes table on https://www.5esrd.com/spellcasting/alternate-magic-rules/ritual-magic/#Non-Ritual_Casters)
39-
3. Generate!
93+
4. Generate!
94+
95+
TablePaste does not support Entity Collections
4096

41-
<img title="" src="./docs/alternateinput.gif" alt="" data-align="inline">
97+
Weighting is handled automatically in TablePaste mode, using the dice roll column
4298

4399
## Manifest
44100

docs/alternateinput.gif

-2.53 MB
Binary file not shown.

docs/easytabledemo.gif

-12 MB
Binary file not shown.

0 commit comments

Comments
 (0)