From e059429760df523da5b2f6361abef17b5fa6a41b Mon Sep 17 00:00:00 2001 From: Serhii Snitsaruk Date: Sun, 26 May 2024 11:22:03 +0200 Subject: [PATCH] Doc: Add first steps --- README.md | 5 +++++ doc/source/index.rst | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/README.md b/README.md index 914f463..315b59d 100644 --- a/README.md +++ b/README.md @@ -90,9 +90,14 @@ LimboAI can be used as either a C++ module or as a GDExtension shared library. G - If you plan to export a game utilizing the LimboAI module, you'll also need to build export templates. - To execute unit tests, compile the engine with `tests=yes` and run it with `--test --tc="*[LimboAI]*"`. +## First steps + +Follow the [First steps](https://limboai.readthedocs.io/en/latest/index.html#first-steps) guide to learn how to get started with LimboAI and the demo project. + ## Using the plugin - [Online Documentation](https://limboai.readthedocs.io/en/latest/index.html) +- [First steps](https://limboai.readthedocs.io/en/latest/index.html#first-steps) - [Introduction to Behavior Trees](https://limboai.readthedocs.io/en/latest/getting-started/introduction.html) - [Creating custom tasks in GDScript](https://limboai.readthedocs.io/en/latest/getting-started/custom-tasks.html) - [Sharing data using Blackboard](https://limboai.readthedocs.io/en/latest/getting-started/using-blackboard.html) diff --git a/doc/source/index.rst b/doc/source/index.rst index dbe8749..ab8d1ec 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -34,6 +34,44 @@ the other any time. For more information on this topic, see :ref:`gdextension`. **🛈 Note:** Class reference is available in the side bar. + +First steps +----------- + +Choose the version you'd like to use. The module version provides better editor +experience and performance, while the GDExtension version is more convenient to use. +If you're unsure, start with the GDExtension version. +You can change your decision at any time - both versions are fully compatible. +For more information, see :ref:`gdextension`. + +With GDExtension version +~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Make sure you're using the latest stable version of the Godot editor. +2. Create a new project for your experiments with LimboAI. +3. In Godot, click AssetLib tab at the top of the screen and search for LimboAI. Download it. LimboAI plugin will be downloaded with the demo project files. Don't mind the errors printed at this point, this is due to the extension library not being loaded just yet. +4. Reload your project with `Project -> Reload project`. There shouldn't be any errors printed now. +5. In the project files, locate a scene file called `showcase.tscn` and run it. It's the demo's entry point. + +With module version +~~~~~~~~~~~~~~~~~~~ + +1. In `GitHub releases `_, download the latest pre-compiled release build for your platform. +2. Download the demo project archive from the same release. +3. Extract the pre-compiled editor and the demo project files. +4. Launch the pre-compiled editor binary, import and open the demo project. +5. Run the project. + +Creating your own behavior trees +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Make a scene file for your agent, or open an existing scene. +2. Add a :ref:`BTPlayer` node to your scene. +3. Select :ref:`BTPlayer`, and create a new behavior tree in the inspector. +4. Optionally, you can save the behavior tree to a file using the property's context menu. +5. Click the behavior tree property to open it in the LimboAI editor. + + .. toctree:: :hidden: :maxdepth: 1