From 1c81fb4e41ad13ab5a746492ad30ce4803d00c1c Mon Sep 17 00:00:00 2001 From: Michael Adaixo Date: Mon, 23 Sep 2024 22:20:19 +0100 Subject: [PATCH] change index page --- astro.config.mjs | 3 +- src/content/docs/about/changelog.md | 6 +- src/content/docs/about/gettingstarted.mdx | 16 ++++ src/content/docs/about/intro.mdx | 57 -------------- src/content/docs/index.mdx | 90 +++++++++++++---------- 5 files changed, 69 insertions(+), 103 deletions(-) create mode 100644 src/content/docs/about/gettingstarted.mdx delete mode 100644 src/content/docs/about/intro.mdx diff --git a/astro.config.mjs b/astro.config.mjs index 6021c98..97f8599 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -33,8 +33,7 @@ export default defineConfig({ sidebar: [{ label: 'About', items: [ - // Each item here is one entry in the navigation menu. - { label: 'Intro', link: '/about/intro/' }, + // Each item here is one entry in the navigation menu. { label: 'Changelog', link: '/about/changelog/' }, { label: 'Roadmap', link: '/about/roadmap/' }, { label: 'Console Commands', link: '/about/consolecommands/' } diff --git a/src/content/docs/about/changelog.md b/src/content/docs/about/changelog.md index cd03bf9..5b8517a 100644 --- a/src/content/docs/about/changelog.md +++ b/src/content/docs/about/changelog.md @@ -1,6 +1,6 @@ --- title: Changelog -description: Record of all FLowPilot changes per version update. +description: Record of all FlowPilot changes per version update. --- ### v0.9.3 @@ -29,8 +29,6 @@ _21/09/2024_ - Update: Rename UFPTask_FlowActorAsset to UFPTask_SubFlow to make it more akin to a group of FlowTasks. (aka SubTree) - Update: Remove UFPTaskRunner. Simplified method calls so that most of it is handled via UFPTask_Sequencer. UFPTask_Selector now inherits from UFPTask_Sequencer and swaps Success/Fail behavior - - ### v0.9.2 _24/08/2024_ @@ -45,7 +43,6 @@ _24/08/2024_ - Update: Task Palette has Categories expanded by default now. - Update: Exposed method to grab Brushes directly from Tasks for customization - ### v0.9.1 _14/07/2024_ @@ -53,7 +50,6 @@ _14/07/2024_ - Fix: Task icons paths not showing up. - Del: Removes temporary icons for validation to prevent a crash - ### v0.9 _13/07/2024_ diff --git a/src/content/docs/about/gettingstarted.mdx b/src/content/docs/about/gettingstarted.mdx new file mode 100644 index 0000000..7062cc3 --- /dev/null +++ b/src/content/docs/about/gettingstarted.mdx @@ -0,0 +1,16 @@ +--- +title: Getting Started +description: Downloading and Installing FlowPilot +--- + +import { Steps, Aside } from '@astrojs/starlight/components'; + +## Installing FlowPilot Plugin + + + +### Downloading FlowPilot fom Unreal Engine Marketplace + +The easiest and best method to install FlowPilot is thought Unreal Engine Marketplace. \ No newline at end of file diff --git a/src/content/docs/about/intro.mdx b/src/content/docs/about/intro.mdx deleted file mode 100644 index 062ae2f..0000000 --- a/src/content/docs/about/intro.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: 'Intro' -description: 'A simple, modular and extensible gameplay system that allows fast data-driven gameplay flow creation for Unreal Engine 5' ---- - -import { Image } from 'astro:assets'; -import logo from '../../../assets/fp_icon.jpg'; - -# FlowPilot: Streamline Gameplay Design - -**Unreal Engine plugin that puts powerful gameplay creation tools in the hands of game developers** - -🏪 [Get FlowPilot Now!](https://spotlesslink.com/4lyb6) -| 🐛 [Issues/Feature Requests](https://github.com/Mikea15/UEFlowPilot/issues) -| 🗨️ [Discord](https://discord.gg/sF9KjZ9qqj) -| 📩 [Email](mailto:michael.adaixo@gmail.com) -| 🐦 [Twitter/X](http://www.x.com/michaeladaixo) - -
-
- -## About FlowPilot - -FlowPilot is a powerful Unreal Engine plugin that empowers game designers to streamline gameplay creation. -It provides an intuitive, visual task-based editor for crafting gameplay sequences and game logic. -By enabling rapid prototyping and efficient iteration without extensive coding, FlowPilot enhances team collaboration and accelerates the overall development process. - -## 🧩 Key Benefits - -- **Data Driven Development:** Allow your team to work on different assets to improve collaboration -- **Rapid Prototyping:** Create and iterate on gameplay sequences visually. -- **Intuitive Interface:** Design complex interactions using a user friendly custom task editor -- **Time Saving:** Reuse flow pilot tasks across your levels and interactive objects with a modular Architecture -- **Scalable for All Projects sizes**: Suitable for solo, indie or large teams. -- **Accessible Learning Curve**: Intuitive for beginners, powerful for experts. - -## 🛠️ Core Features - -- **Custom FlowPilot Editor** to quickly setup game logic -- **Extensible task system** with a pre-built library of ready to go Tasks -- **GameplayTags integration** for easy actor management -- **Blueprint and C++ support** to create new FlowPilot Tasks -- **Performance aware** with built-in profiler traces to monitor and keep your game running smoothly across different platforms -- **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 -3. Read the [friendly manual](http://www.flowpilot.dev) diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 23def59..5997a46 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -1,48 +1,60 @@ --- title: "FlowPilot: Streamline Your Unreal Engine Gameplay Creation" description: 'Powerful, efficient, and intuitive gameplay design for Unreal Engine developers.' -template: splash -hero: - tagline: 'Powerful, efficient, and intuitive gameplay design for Unreal Engine developers.' - image: - file: ../../assets/fp_icon.jpg - actions: - - text: 👉 Start Here - link: /about/intro/ - icon: open-book - variant: primary - - text: 📖 Open the Reference Doc - link: /reference/flowpilotcomponent/ - icon: external - variant: primary - + banner: content: | FlowPilot is available now! 🏪 Get FlowPilot Now 🎉 --- -import { LinkCard, Card, CardGrid } from '@astrojs/starlight/components'; - - - - - - -## Featured Pages - - - Learn more about FlowPilot in the - [Intro Page](about/intro/) - - - Follow the Introduction to FlowPilot guide to get a grasp on the basic concepts. - [Read Now](/guides/introductiontoflowpilot/) - - - Custom FlowPilot Editor, Visual Flow Creation, Blueprint & C++ Support - - - Reusablility, Data-Driven Approach, Seamless Integration - - +import { Image } from 'astro:assets'; +import logo from '../../assets/fp_icon.jpg'; + +**Unreal Engine plugin that puts powerful gameplay creation tools in the hands of game developers** + +🏪 [Get FlowPilot Now!](https://spotlesslink.com/4lyb6) +| 🐛 [Issues/Feature Requests](https://github.com/Mikea15/UEFlowPilot/issues) +| 🗨️ [Discord](https://discord.gg/sF9KjZ9qqj) +| 📩 [Email](mailto:michael.adaixo@gmail.com) +| 🐦 [Twitter/X](http://www.x.com/michaeladaixo) + +
+
+ +## About FlowPilot + +FlowPilot is a powerful Unreal Engine plugin that empowers game designers to streamline gameplay creation. +It provides an intuitive, visual task-based editor for crafting gameplay sequences and game logic. +By enabling rapid prototyping and efficient iteration without extensive coding, FlowPilot enhances team collaboration and accelerates the overall development process. + +## 🧩 Key Benefits + +- **Data Driven Development:** Allow your team to work on different assets to improve collaboration +- **Rapid Prototyping:** Create and iterate on gameplay sequences visually. +- **Intuitive Interface:** Design complex interactions using a user friendly custom task editor +- **Time Saving:** Reuse flow pilot tasks across your levels and interactive objects with a modular Architecture +- **Scalable for All Projects sizes**: Suitable for solo, indie or large teams. +- **Accessible Learning Curve**: Intuitive for beginners, powerful for experts. + +## 🛠️ Core Features + +- **Custom FlowPilot Editor** to quickly setup game logic +- **Extensible task system** with a pre-built library of ready to go Tasks +- **GameplayTags integration** for easy actor management +- **Blueprint and C++ support** to create new FlowPilot Tasks +- **Performance aware** with built-in profiler traces to monitor and keep your game running smoothly across different platforms +- **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 +3. Read the [friendly manual](http://www.flowpilot.dev) \ No newline at end of file