Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikea15 committed Sep 15, 2024
1 parent 7eb3ea3 commit d186208
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 10 deletions.
21 changes: 21 additions & 0 deletions src/content/docs/about/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,27 @@ title: Changelog
description: Record of all FLowPilot changes per version update.
---

### v0.9.3

**Upcomming**

_xx/09/2024_

- Fix: Crash on Demo Map when you don't have a class to spawn, but still play the game. Gracefully Log and Exit instead of crash.
- Update: Set default spawn lifetime to persistent
- Update: Move Defines to FlowPilotGlobals.h
- Add: Automatic Documentation export to FlowPilot.dev
- Fix: Rare crash when Task was selected without Outer Class.
- Update: Remove Root Task and Children from details view. No longer needed as the Tree view works correctly.
- Add: New Option to spawn Class at a specific world location/rotation
- Feature: Allows changing ticking group in Project Settings.
- Fix: Parallel Task was not respecting disabled nodes.
- Updates: Demo Maps and basic TP Character to remove Dependencies.
- Add: Modal to confirm task deletion
- Update: Default Root node is named after data asset now upon creation
- Add: Flow Pilot asset can be created from the Content Browser via the Gameplay Menu


### v0.9.2

_24/08/2024_
Expand Down
7 changes: 7 additions & 0 deletions src/content/docs/about/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ By enabling rapid prototyping and efficient iteration without extensive coding,
- **Efficient Prefetching System** for optimized actor access
- **Automatic Lifetime Control** to automatically despawn actors (or not) when FlowPilot execution ends

## 📦 What's Included

- **Content Map:** Check each individual FlowPilotTasks to know how they work
- **Game Map Template:** Check how you can integrate in a full level, with streaming levels, spawn, despawn, logic gating, simple character setup, progression, ui notifications, etc.
- **TagActorComponent:** Simple Component to Tag actors, so that they are easy to reference in your FlowPilot assets
- **Example Component:** Component with barebones Health and Inventory Logic to support Game Map Template

## 🏁 Getting Started
1. Download and install [FlowPilot from the Unreal Engine Marketplace](https://spotlesslink.com/4lyb6)
2. Open the Content Example Map and play around with FlowPilot Data assets
Expand Down
20 changes: 10 additions & 10 deletions src/content/docs/about/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Some are from personal needs and others from dev requests. Feel free to drop a l

## Possible Future Features

- UFPTask_Transition: Allow choosing any task in the Sequence and Jump to it.
- UFPTask_Checkpoint: Allow saving a set of user define data.
- UFPTask_ReloadFromLastCheckpoint: Allow restarting FlowPilot and run up to last Hit Checkpoint
- UFPTask_BackgroundWork: Allow Pushing/Popping a Background work job. Something that is spawned for work and un-managed by FlowPilot
- Editor: Copy/Paste from FlowPilot TreeView in Editor
- Editor: Allow swapping Class Type in TreeView versus DetailView only.
- Perf: Move all Tick methods to FlowPilotSystemComponent
- Perf: Multithreading/Jobification of Ticking Tasks / Background Jobs
- Core: Diffing FlowAsset Versions
- Core: Export to Text File
- [ ] UFPTask_Transition: Allow choosing any task in the Sequence and Jump to it.
- [ ] UFPTask_Checkpoint: Allow saving a set of user define data.
- [ ] UFPTask_ReloadFromLastCheckpoint: Allow restarting FlowPilot and run up to last Hit Checkpoint
- [ ] UFPTask_BackgroundWork: Allow Pushing/Popping a Background work job. Something that is spawned for work and un-managed by FlowPilot
- [x] Editor: Copy/Paste from FlowPilot TreeView in Editor
- [x] Editor: Allow swapping Class Type in TreeView versus DetailView only.
- [ ] Perf: Move all Tick methods to FlowPilotSystemComponent
- [ ] Perf: Multithreading/Jobification of Ticking Tasks / Background Jobs
- [ ] Core: Diffing FlowAsset Versions
- [ ] Core: Export to Text File

0 comments on commit d186208

Please sign in to comment.