diff --git a/astro.config.mjs b/astro.config.mjs index 3c1c6ff..fe2ddc8 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -23,6 +23,7 @@ export default defineConfig({ label: 'About', items: [ // Each item here is one entry in the navigation menu. + { label: 'Intro', link: '/about/intro/' }, { label: 'Changelog', link: '/about/changelog/' }, ], }, diff --git a/src/content/docs/about/intro.mdx b/src/content/docs/about/intro.mdx new file mode 100644 index 0000000..e44b15c --- /dev/null +++ b/src/content/docs/about/intro.mdx @@ -0,0 +1,45 @@ +--- +title: 'Intro' +description: 'Unreal Engine Code Plugin: Simple, modular and extensible gameplay system that allows fast data-driven gameplay flow creation.' +--- + +## Description + +FlowPilot is an Unreal Engine code plugin that allows simple, modular and extensible gameplay flow. Using a data driven approach and with a custom +editor, you can create fast gameplay flow, scripted sequences, interactive object. + +All without the clutter that can sometimes happen when dealing with Blueprints. +FlowPilot uses Tasks which are re-usable modules that run logic code. These can be created in Cpp and in Blueprint. + +## Features + +- Simple Modules `FlowPilotTask` can be created in Blueprint and C++ +- FlowPilotComponent controls FlowPilot Execution and is fully exposed to Blueprint. +- Re-usability at its core with modular data-driven approach +- Re-use identical flows by grouping them into another FlowPilot Asset +- Easily find actors in the level, or at runtime via GameplayTags +- Prefetch and caching handled by FlowPilotSystemComponent +- Debugging Tools: CPU Profiling in code, Visual Logs, and ScopedCycles to stay on top of Performance +- Easy editing with a custom FlowPilot editor +- Pre-built list of FlowPilotTasks include: Sequences, Selectors, Parallel, Loop, Delay, Spawn, FlowPilotExecution, and more. + +## External Links + +- FlowPilot on [Unreal Marketplace](https://www.unrealengine.com/marketplace/en-US/product/88621a7957c0435991e5d0ce327e9f68) +- [Free/Older] FlowPilot on [Itch.io](https://mikea15.itch.io/flowpilot-ue-plugin) +- Raise issues or features on [Github](https://github.com/Mikea15/UEFlowPilot/issues) +- Support on [Discord](https://discord.gg/sF9KjZ9qqj) + +## Documentation + +This website is the go to for the most up to date documentation and changes about FlowPilot. +However if you want more support, you should [Join our Discord](https://discord.gg/sF9KjZ9qqj) community! + +## Contact + +Need help? The best place to get some help is on Discord, where you can meet fellow devs who help each other out. +You can request features and raise issues there too. +- [Join Discord](https://discord.gg/sF9KjZ9qqj) + +Alternatively, you can drop me an email [michael.adaixo@gmail.com] or contact me on [Twitter/X](http://www.x.com/michaeladaixo) + diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index b2e9c3a..2ee8b41 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -18,19 +18,23 @@ hero: import { Card, CardGrid } from '@astrojs/starlight/components'; -## Next steps +## Introductory Guides - - Edit `src/content/docs/index.mdx` to see this page change. + + Learn to use FlowPilot by making a simple level intro. + [Read Now](/guides/usingflowpilot) - - Add Markdown or MDX files to `src/content/docs` to create new pages. + + Create re-usable FlowPilot assets. Now that you know how to make a simple level intro, lets use what we built to make a new sequence and spawn a few actors in the game. + [Read Now](/guides/usingflowpilot) - - Edit your `sidebar` and other config in `astro.config.mjs`. + + Want to stay on top of performance, and know what's going on? Learn about Visual Logger, Profiling, and reading FlowPilot logs. + [Read Now](/guides/usingflowpilot) - - Learn more in [the Starlight Docs](https://starlight.astro.build/). + + Check the rest of the guides! [Here](/guides/usingflowpilot/). + You can also create a pull request on Github if you want to add a new one!