Skip to content

Commit 5c20ead

Browse files
committed
demo readme
1 parent ed5f8af commit 5c20ead

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

Assets/TableForge/Demo/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# TableForge Demo Data
2+
3+
This folder contains example ScriptableObject assets and data types for use with the TableForge tool. You can use these demo assets to quickly create tables, experiment with TableForge's features, and export data for testing or learning purposes.
4+
5+
---
6+
7+
## How to Create Tables Using Demo Data
8+
9+
1. **Open TableForge TableVisualizer**
10+
- In Unity, go to `Window > TableForge > TableVisualizer`.
11+
12+
2. **Add a New Table**
13+
- Click the `+` button in the TableVisualizer toolbar.
14+
- In the dialog, select the data type you want to visualize (e.g., `CharacterStats`, `EnemyStats`, or `WeaponStats`).
15+
- Choose to bind the table to all assets of that type, or select specific assets from the Demo/Data folders.
16+
17+
3. **View and Edit Data**
18+
- The table will display the selected ScriptableObject assets as rows, with their fields as columns.
19+
- You can edit values directly in the table, use formulas, and explore sub-tables for nested data.
20+
21+
---
22+
23+
## How to Export Demo Data
24+
25+
1. **Open the Export Window**
26+
- Go to `Window > TableForge > Export Table`.
27+
28+
2. **Select the Table to Export**
29+
- Choose the table you created from the dropdown list.
30+
31+
3. **Configure Export Options**
32+
- Select the desired export format (CSV or JSON).
33+
- Choose whether to include GUIDs, asset paths, or flatten sub-tables (see TableForge documentation for details).
34+
35+
4. **Export the Data**
36+
- Preview the export if desired.
37+
- Click the `Export Table` button to save the data to a file.
38+
39+
---
40+
41+
## Tips
42+
- You can import the exported data back into TableForge using the Import Table window.
43+
- Use the Demo/Data/Characters, Demo/Data/Enemies, and Demo/Data/Weapons folders for ready-to-use assets.
44+
- Try editing values and formulas in the table to see real-time updates.
45+
46+
For more details, see the main TableForge [README](../../../../README.md).

Assets/TableForge/Demo/README.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)