Skip to content

Commit a8d2cc0

Browse files
committed
Update readme
1 parent bca0532 commit a8d2cc0

File tree

5 files changed

+31
-7
lines changed

5 files changed

+31
-7
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,6 @@ DerivedDataCache/*
7878

7979
Package/
8080

81-
Plugins/
81+
Plugins/**
82+
!.gitignore
83+
!Plugins/LogicDriver-Dialogue

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "Plugins/LogicDriver-Dialogue"]
2+
path = Plugins/LogicDriver-Dialogue
3+
url = [email protected]:Recursoft/LogicDriver-Dialogue.git

Content/Maps/ExampleMap.umap

178 Bytes
Binary file not shown.

Plugins/LogicDriver-Dialogue

Submodule LogicDriver-Dialogue added at bbd1ad7

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
11
# Logic Driver 2.0 Example Project
22

3-
WIP Example Project for 2.0 features.
4-
**Requires the Beta Version of Logic Driver 2.0.**
3+
**Requires Logic Driver 2.0.**
54

6-
2.0 Features Displayed:
7-
- Custom state class to print text and custom transition class with time delay
8-
- Exposing a text variable with a default value, editing the default value, and using a text variable
9-
- Dynamic instantiation of a state machine during run-time using custom classes and waiting for its completion.
5+
## Requirements
6+
- Download a zip from the [releases page](https://github.com/Recursoft/LogicDriver-Example/releases) or clone the repository using `git clone --recurse-submodules`
7+
- Open `LogicDriverExample.uproject`
8+
- Unreal should prompt to build the project
9+
- Visual Studio is required for the project to build. It can be downloaded from https://visualstudio.microsoft.com/downloads/
1010

11+
## Documentation
12+
- [Logic Driver User Guide and API Reference](https://logicdriver.recursoft.net/docs/)
13+
14+
## Example Map
15+
- Basic state machine usage, contexts, and ticking
16+
- Event based trigger with manual binding
17+
- Event based trigger with auto binding
18+
- Custom state class to print text and custom transition class with time delay
19+
- Exposing a text variable with a default value, editing the default value, and using a text variable
20+
- Dynamic instantiation of a state machine during run-time using custom classes and waiting for its completion
21+
22+
## AI Example Map
23+
- AI Patrol Behavior
24+
25+
## Dialogue Example Map
26+
- Sample Dialogue implementation using the [LogicDriver-Dialogue Plugin](https://github.com/Recursoft/LogicDriver-Dialogue)
27+
- This is a submodule of this project and is required for this example
28+
- The plugin can be used as an example on how to overload state and transition classes in C++

0 commit comments

Comments
 (0)