Skip to content

Commit c540c4b

Browse files
docs: Update README.md (#3)
1 parent 69341ce commit c540c4b

File tree

1 file changed

+15
-25
lines changed

1 file changed

+15
-25
lines changed

README.md

+15-25
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,49 @@
22
<a href="https://dscvit.com">
33
<img width="400" src="https://user-images.githubusercontent.com/56252312/159312411-58410727-3933-4224-b43e-4e9b627838a3.png#gh-light-mode-only" alt="GDSC VIT"/>
44
</a>
5-
<h2 align="center"> < Insert Project Title Here > </h2>
6-
<h4 align="center"> < Insert Project Description Here > <h4>
5+
<h2 align="center"> WASDE Interpretor for Unity</h2>
6+
<h4 align="center"> A sample implementation of the WASDE dialogue system. <h4>
77
</p>
88

99
---
1010
[![Join Us](https://img.shields.io/badge/Join%20Us-Developer%20Student%20Clubs-red)](https://dsc.community.dev/vellore-institute-of-technology/)
1111
[![Discord Chat](https://img.shields.io/discord/760928671698649098.svg)](https://discord.gg/498KVdSKWR)
1212

13-
[![DOCS](https://img.shields.io/badge/Documentation-see%20docs-green?style=flat-square&logo=appveyor)](INSERT_LINK_FOR_DOCS_HERE)
14-
[![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](INSERT_UI_LINK_HERE)
13+
14+
1515

1616

1717
## Features
18-
- [ ] < feature >
19-
- [ ] < feature >
20-
- [ ] < feature >
21-
- [ ] < feature >
18+
- [ ] Sample dialogue system for unity
19+
2220

2321
<br>
2422

2523
## Dependencies
26-
- < dependency >
27-
- < dependency >
28-
24+
- Newtonsoft Json
2925

3026
## Running
27+
import the unity package into unity 2023+
3128

29+
move the prefab into your scene and import the json files outputted by the editor to the project.
30+
Then call the DialogueTreeInterpreter.StartDialogue(TextAsset t) method to start the dialogue.
31+
make use of the dialogue callbacks to add events to the dialogue.
3232

33-
< directions to install >
34-
```bash
35-
< insert code >
36-
```
37-
38-
< directions to execute >
39-
40-
```bash
41-
< insert code >
42-
```
4333

4434
## Contributors
4535

4636
<table>
4737
<tr align="center">
4838
<td>
49-
John Doe
39+
graphicmismatch (Rayan Madan)
5040
<p align="center">
51-
<img src = "https://dscvit.com/images/dsc-logo-square.svg" width="150" height="150" alt="Your Name Here (Insert Your Image Link In Src">
41+
<img src = "https://avatars.githubusercontent.com/u/48159187" width="150" height="150" alt="graphicmismatch(Rayan Madan)">
5242
</p>
5343
<p align="center">
54-
<a href = "https://github.com/person1">
44+
<a href = "https://github.com/graphicmismatch">
5545
<img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/>
5646
</a>
57-
<a href = "https://www.linkedin.com/in/person1">
47+
<a href = "https://www.linkedin.com/in/rayan-madan/">
5848
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
5949
</a>
6050
</p>

0 commit comments

Comments
 (0)