Skip to content

Commit

Permalink
Update Adapter Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gabber235 committed Aug 9, 2024
1 parent c5e8389 commit 2600e5a
Show file tree
Hide file tree
Showing 12 changed files with 157 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,7 @@ fn find_adapters_names() -> Result<Vec<String>, OrchestrationError> {
.filter(|path| path.is_dir())
.map(|path| path.file_name().unwrap().to_str().unwrap().to_string())
.filter(|adapter| adapter.ends_with("Adapter"))
.filter(|adapter| !adapter.starts_with("_"))
.collect::<Vec<String>>();

return Ok(adapters);
Expand Down
2 changes: 1 addition & 1 deletion discord_bot/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::{cmp::min, sync::Arc};
use std::sync::Arc;

use actix_web::{middleware::Logger, App, HttpServer};
use once_cell::sync::Lazy;
Expand Down
1 change: 1 addition & 0 deletions documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ first.

| Name | Description |
| ---- | ----------- |
| [Completable Objective](./entries/quest/completable_objective.mdx) | An objective that can show a completed stage |
| [Location Objective](./entries/quest/location_objective.mdx) | A location objective definition |
| [Objective Lines](./entries/quest/objective_lines.mdx) | Display all the current objectives |
| [Quest Complete Event](./entries/quest/quest_complete_event.mdx) | Triggered when a quest is completed for a player |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Completable Objective

The `Completable Objective` entry is an objective that can show a completed stage.
It is shown to the player when the show criteria are met, regardless of if the completed criteria are met.

## How could this be used?
This is useful when the quest has multiple objectives that can be completed in different orders.
For example, the player needs to collect wheat, eggs, and milk to make a cake.
The order in which the player collects the items does not matter.
But you want to show the player which items they have collected.


## Fields

<fields.EntryField name='Quest' required>
</fields.EntryField>
<fields.EntryField name='Children' required multiple>
</fields.EntryField>
<fields.EntryField name='Show Criteria' required multiple>
The criteria need to be met for the objective to be able to be shown.
</fields.EntryField>
<fields.EntryField name='Completed Criteria' required multiple>
The criteria to display the objective as completed.
</fields.EntryField>
<fields.EntryField name='Display' required>
</fields.EntryField>
<fields.EntryField name='Priority Override' optional>
</fields.EntryField>
5 changes: 5 additions & 0 deletions documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,27 @@ first.

| Name | Description |
| ---- | ----------- |
| [Allay Instance](./entries/entity/allay_instance.mdx) | An instance of a allay entity |
| [Cat Instance](./entries/entity/cat_instance.mdx) | An instance of a cat entity |
| [Chicken Instance](./entries/entity/chicken_instance.mdx) | An instance of a chicken entity |
| [Cow Instance](./entries/entity/cow_instance.mdx) | An instance of a cow entity |
| [Enderman Instance](./entries/entity/enderman_instance.mdx) | An instance of a enderman entity |
| [Frog Instance](./entries/entity/frog_instance.mdx) | An instance of a frog entity |
| [Hit Box Definition](./entries/entity/hit_box_definition.mdx) | A hit box for an entity to allow interaction with a different entity |
| [Hoglin Instance](./entries/entity/hoglin_instance.mdx) | An instance of a hoglin entity |
| [Husk Instance](./entries/entity/husk_instance.mdx) | An instance of a husk entity |
| [Interaction Indicator Definition](./entries/entity/interaction_indicator_definition.mdx) | Interaction Indicator |
| [Iron Golem Instance](./entries/entity/iron_golem_instance.mdx) | An instance of an iron golem entity |
| [Item Display Instance](./entries/entity/item_display_instance.mdx) | An instance of an item display entity |
| [Magma Cube Instance](./entries/entity/magma_cube_instance.mdx) | An instance of a magma cube entity |
| [Named Entity Definition](./entries/entity/named_entity_definition.mdx) | An entity with a name above it's head and the indicator |
| [Npc Instance](./entries/entity/npc_instance.mdx) | An instance of a simplified premade npc |
| [Piglin Brute Instance](./entries/entity/piglin_brute_instance.mdx) | An instance of a piglin brute entity |
| [Piglin Instance](./entries/entity/piglin_instance.mdx) | An instance of a piglin entity |
| [Player Instance](./entries/entity/player_instance.mdx) | An instance of a player entity |
| [Self Npc Definition](./entries/entity/self_npc_definition.mdx) | The definition of the self NPC |
| [Skeleton Instance](./entries/entity/skeleton_instance.mdx) | An instance of a skeleton entity |
| [Slime Instance](./entries/entity/slime_instance.mdx) | An instance of a slime entity |
| [Stacked Entity Definition](./entries/entity/stacked_entity_definition.mdx) | A stacking of entities |
| [Text Display Instance](./entries/entity/text_display_instance.mdx) | An instance of a text display entity |
| [Villager Instance](./entries/entity/villager_instance.mdx) | An instance of a villager entity |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Allay Instance

The `Allay Instance` class is an entry that represents an instance of an allay entity.

## How could this be used?

This could be used to create an allay entity.


## Fields

<fields.EntryField name='Definition' required>
</fields.EntryField>
<fields.EntryField name='Spawn Location' required>
</fields.EntryField>
<fields.EntryField name='Data' required multiple>
</fields.EntryField>
<fields.EntryField name='Activity' required>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Chicken Instance

The `ChickenInstance` class is an entry that represents an instance of a chicken entity.

## How could this be used?

This could be used to create a chicken entity.


## Fields

<fields.EntryField name='Definition' required>
</fields.EntryField>
<fields.EntryField name='Spawn Location' required>
</fields.EntryField>
<fields.EntryField name='Data' required multiple>
</fields.EntryField>
<fields.EntryField name='Activity' required>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Frog Instance

The `FrogInstance` class is an entry that represents an instance of a frog entity.

## How could this be used?

This could be used to create a frog entity.


## Fields

<fields.EntryField name='Definition' required>
</fields.EntryField>
<fields.EntryField name='Spawn Location' required>
</fields.EntryField>
<fields.EntryField name='Data' required multiple>
</fields.EntryField>
<fields.EntryField name='Activity' required>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Magma Cube Instance

The `MagmaCubeInstance` class is an entry that represents an instance of a magma cube entity.

## How could this be used?

This could be used to create a magma cube entity.


## Fields

<fields.EntryField name='Definition' required>
</fields.EntryField>
<fields.EntryField name='Spawn Location' required>
</fields.EntryField>
<fields.EntryField name='Data' required multiple>
</fields.EntryField>
<fields.EntryField name='Activity' required>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Slime Instance

The `SlimeInstance` class is an entry that represents an instance of a slime entity.

## How could this be used?

This could be used to create a slime entity.


## Fields

<fields.EntryField name='Definition' required>
</fields.EntryField>
<fields.EntryField name='Spawn Location' required>
</fields.EntryField>
<fields.EntryField name='Data' required multiple>
</fields.EntryField>
<fields.EntryField name='Activity' required>
</fields.EntryField>
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ This action could be used in stories or quests in various ways. For instance, if
<fields.ModifiersField />
<fields.EntryField name='Triggers' required multiple>
</fields.EntryField>
<fields.EntryField name='Mob Name' required>
<fields.EntryField name='Mob Name' required placeholders>
The mob's name
</fields.EntryField>
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This action could be used in a plethora of scenarios. From simple quests requiri
<fields.ModifiersField />
<fields.EntryField name='Triggers' required multiple>
</fields.EntryField>
<fields.EntryField name='Mob Name' required>
<fields.EntryField name='Mob Name' required placeholders>
The mob's name
</fields.EntryField>
<fields.EntryField name='Level' required>
Expand Down

0 comments on commit 2600e5a

Please sign in to comment.