Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pshardy committed Apr 15, 2020
1 parent bca0532 commit a8d2cc0
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 7 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,6 @@ DerivedDataCache/*

Package/

Plugins/
Plugins/**
!.gitignore
!Plugins/LogicDriver-Dialogue
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "Plugins/LogicDriver-Dialogue"]
path = Plugins/LogicDriver-Dialogue
url = [email protected]:Recursoft/LogicDriver-Dialogue.git
Binary file modified Content/Maps/ExampleMap.umap
Binary file not shown.
1 change: 1 addition & 0 deletions Plugins/LogicDriver-Dialogue
Submodule LogicDriver-Dialogue added at bbd1ad
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,28 @@
# Logic Driver 2.0 Example Project

WIP Example Project for 2.0 features.
**Requires the Beta Version of Logic Driver 2.0.**
**Requires Logic Driver 2.0.**

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

## Documentation
- [Logic Driver User Guide and API Reference](https://logicdriver.recursoft.net/docs/)

## Example Map
- Basic state machine usage, contexts, and ticking
- Event based trigger with manual binding
- Event based trigger with auto binding
- Custom state class to print text and custom transition class with time delay
- Exposing a text variable with a default value, editing the default value, and using a text variable
- Dynamic instantiation of a state machine during run-time using custom classes and waiting for its completion

## AI Example Map
- AI Patrol Behavior

## Dialogue Example Map
- Sample Dialogue implementation using the [LogicDriver-Dialogue Plugin](https://github.com/Recursoft/LogicDriver-Dialogue)
- This is a submodule of this project and is required for this example
- The plugin can be used as an example on how to overload state and transition classes in C++

0 comments on commit a8d2cc0

Please sign in to comment.