Skip to content

Commit

Permalink
Make paths relative
Browse files Browse the repository at this point in the history
  • Loading branch information
@gabber235
gabber235 committed Mar 15, 2024
1 parent 644e02c commit 8fbc21f
Show file tree
Hide file tree
Showing 13 changed files with 191 additions and 176 deletions.
5 changes: 1 addition & 4 deletions code_generator/src/bin/entry_docs_generator/markdown_formatter.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,10 +290,7 @@ fn format_adapter_entry(
.class_name
.trim_end_matches("Entry")
.to_case(Case::Title);
let link = format!(
"{}/entries/{}/{}",
adapter.adapter, entry.category, entry.entry_data.name
);
let link = format!("./entries/{}/{}.mdx", entry.category, entry.entry_data.name);
let description = entry.entry_data.description.clone();
builder.append_line(format!(
"| [{}]({}) | {} |",
Expand Down
163 changes: 82 additions & 81 deletions documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx
View file

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions documentation/docs/adapters/BasicAdapter/entries/audience/criteria_audience.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Criteria Audience

The `Criteria Audience` entry filters an audience based on criteria.

## How could this be used?
This could be used to show a boss bar or npc when the player is in a certain quest stage.


## Fields

<fields.EntryField name='Children' required multiple>
</fields.EntryField>
<fields.CriteriaField />
8 changes: 4 additions & 4 deletions documentation/docs/adapters/CitizensAdapter/CitizensAdapter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ The Citizens adapter allows you to create custom interactions with NPCs.

| Name | Description |
| ---- | ----------- |
| [Reference Npc Cinematic](CitizensAdapter/entries/cinematic/reference_npc_cinematic) | A reference to an existing npc specifically for cinematic |
| [Self Npc Cinematic](CitizensAdapter/entries/cinematic/self_npc_cinematic) | The player itself as an cinematic npc |
| [Reference Npc Cinematic](./entries/cinematic/reference_npc_cinematic.mdx) | A reference to an existing npc specifically for cinematic |
| [Self Npc Cinematic](./entries/cinematic/self_npc_cinematic.mdx) | The player itself as an cinematic npc |

### Entitys

| Name | Description |
| ---- | ----------- |
| [Reference Npc](CitizensAdapter/entries/entity/reference_npc) | When the npc is not managed by TypeWriter |
| [Reference Npc](./entries/entity/reference_npc.mdx) | When the npc is not managed by TypeWriter |

### Events

| Name | Description |
| ---- | ----------- |
| [Npc Interact Event](CitizensAdapter/entries/event/on_npc_interact) | When a player clicks on an NPC |
| [Npc Interact Event](./entries/event/on_npc_interact.mdx) | When a player clicks on an NPC |

6 changes: 3 additions & 3 deletions documentation/docs/adapters/CombatLogXAdapter/CombatLogXAdapter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ This adapter is untested. It may not work as expected. Please report any issues

| Name | Description |
| ---- | ----------- |
| [Player Enter Combat Event](CombatLogXAdapter/entries/event/on_player_enter_combat) | When a player enters combat |
| [Player Exit Combat Event](CombatLogXAdapter/entries/event/on_player_exit_combat) | When a player is no longer in combat |
| [Player Enter Combat Event](./entries/event/on_player_enter_combat.mdx) | When a player enters combat |
| [Player Exit Combat Event](./entries/event/on_player_exit_combat.mdx) | When a player is no longer in combat |

### Facts

| Name | Description |
| ---- | ----------- |
| [Combat Fact](CombatLogXAdapter/entries/fact/combat_fact) | If the player is in combat |
| [Combat Fact](./entries/fact/combat_fact.mdx) | If the player is in combat |

76 changes: 38 additions & 38 deletions documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,72 +14,72 @@ first.

| Name | Description |
| ---- | ----------- |
| [Fixed Location Activity](EntityAdapter/entries/activity/fixed_location_activity) | A fixed location activity |
| [Look Close Activity](EntityAdapter/entries/activity/look_close_activity) | A look close activity |
| [Fixed Location Activity](./entries/activity/fixed_location_activity.mdx) | A fixed location activity |
| [Look Close Activity](./entries/activity/look_close_activity.mdx) | A look close activity |

### Cinematics

| Name | Description |
| ---- | ----------- |
| [Entity Cinematic](EntityAdapter/entries/cinematic/entity_cinematic) | Use an animated entity in a cinematic |
| [Entity Cinematic](./entries/cinematic/entity_cinematic.mdx) | Use an animated entity in a cinematic |

### Datas

| Name | Description |
| ---- | ----------- |
| [Ageable Data](EntityAdapter/entries/data/ageable_data) | An ageable data |
| [Arrow Count Data](EntityAdapter/entries/data/arrow_count_data) | The amount of arrows in the entity |
| [Base Horse Saddled Data](EntityAdapter/entries/data/horse_saddled_data) | If the horse has a saddle. |
| [Cat Variant Data](EntityAdapter/entries/data/cat_variant_data) | The variant of the cat |
| [Chested Horse Chest Data](EntityAdapter/entries/data/chested_horse_chest_meta) | If the horse has a chest. |
| [Collar Color Data](EntityAdapter/entries/data/cat_collar_color_data) | The color of the cat's collar |
| [Custom Name Data](EntityAdapter/entries/data/custom_name_data) | The custom name of the entity |
| [Glowing Effect Data](EntityAdapter/entries/data/glowing_effect_data) | If the entity is glowing |
| [Horse Eating Data](EntityAdapter/entries/data/horse_eating_data) | If the horse is eating. |
| [Horse Rearing Data](EntityAdapter/entries/data/horse_rearing_data) | If the horse is rearing. |
| [Horse Variant Data](EntityAdapter/entries/data/horse_variant_dat) | The variant of the horse. |
| [Llama Carpet Color Data](EntityAdapter/entries/data/llama_carpet_color_data) | The color of the llama's carpet. |
| [Llama Variant Data](EntityAdapter/entries/data/llama_variant_data) | The variant of the Llama. |
| [On Fire Data](EntityAdapter/entries/data/on_fire_data) | If the entity is on fire |
| [Parrot Color Data](EntityAdapter/entries/data/parrot_color_data) | The color of the parrot |
| [Pig Saddle Data](EntityAdapter/entries/data/pig_saddle_data) | If the pig has a saddle. |
| [Pose Data](EntityAdapter/entries/data/pose_data) | The pose of the entity |
| [Potion Effect Color Data](EntityAdapter/entries/data/potion_effect_color_data) | The color of the potion effect particles |
| [Rabbit Type Data](EntityAdapter/entries/data/rabbit_type_data) | The type of the rabbit |
| [Sheep Sheared Data](EntityAdapter/entries/data/sheep_sheared_data) | If the sheep is sheared. |
| [Skin Data](EntityAdapter/entries/data/skin_data) | Skin data for players |
| [Villager Data](EntityAdapter/entries/data/villager_data) | A villager data |
| [Wolf Begging Data](EntityAdapter/entries/data/Wolf_Begging_data) | The begging state of the wolf |
| [Wolf Collar Color Data](EntityAdapter/entries/data/wolf_collar_color_data) | The color of the wolf's collar |
| [Ageable Data](./entries/data/ageable_data.mdx) | An ageable data |
| [Arrow Count Data](./entries/data/arrow_count_data.mdx) | The amount of arrows in the entity |
| [Base Horse Saddled Data](./entries/data/horse_saddled_data.mdx) | If the horse has a saddle. |
| [Cat Variant Data](./entries/data/cat_variant_data.mdx) | The variant of the cat |
| [Chested Horse Chest Data](./entries/data/chested_horse_chest_meta.mdx) | If the horse has a chest. |
| [Collar Color Data](./entries/data/cat_collar_color_data.mdx) | The color of the cat's collar |
| [Custom Name Data](./entries/data/custom_name_data.mdx) | The custom name of the entity |
| [Glowing Effect Data](./entries/data/glowing_effect_data.mdx) | If the entity is glowing |
| [Horse Eating Data](./entries/data/horse_eating_data.mdx) | If the horse is eating. |
| [Horse Rearing Data](./entries/data/horse_rearing_data.mdx) | If the horse is rearing. |
| [Horse Variant Data](./entries/data/horse_variant_dat.mdx) | The variant of the horse. |
| [Llama Carpet Color Data](./entries/data/llama_carpet_color_data.mdx) | The color of the llama's carpet. |
| [Llama Variant Data](./entries/data/llama_variant_data.mdx) | The variant of the Llama. |
| [On Fire Data](./entries/data/on_fire_data.mdx) | If the entity is on fire |
| [Parrot Color Data](./entries/data/parrot_color_data.mdx) | The color of the parrot |
| [Pig Saddle Data](./entries/data/pig_saddle_data.mdx) | If the pig has a saddle. |
| [Pose Data](./entries/data/pose_data.mdx) | The pose of the entity |
| [Potion Effect Color Data](./entries/data/potion_effect_color_data.mdx) | The color of the potion effect particles |
| [Rabbit Type Data](./entries/data/rabbit_type_data.mdx) | The type of the rabbit |
| [Sheep Sheared Data](./entries/data/sheep_sheared_data.mdx) | If the sheep is sheared. |
| [Skin Data](./entries/data/skin_data.mdx) | Skin data for players |
| [Villager Data](./entries/data/villager_data.mdx) | A villager data |
| [Wolf Begging Data](./entries/data/Wolf_Begging_data.mdx) | The begging state of the wolf |
| [Wolf Collar Color Data](./entries/data/wolf_collar_color_data.mdx) | The color of the wolf's collar |

### Entitys

| Name | Description |
| ---- | ----------- |
| [Cow Instance](EntityAdapter/entries/entity/cow_instance) | An instance of a cow entity |
| [Interaction Indicator Definition](EntityAdapter/entries/entity/interaction_indicator_definition) | Interaction Indicator |
| [Npc Instance](EntityAdapter/entries/entity/npc_instance) | An instance of a simplified premade npc |
| [Player Instance](EntityAdapter/entries/entity/player_instance) | An instance of a player entity |
| [Self Npc Definition](EntityAdapter/entries/entity/self_npc_definition) | The definition of the self NPC |
| [Stacked Entity Definition](EntityAdapter/entries/entity/stacked_entity_definition) | A stacking of entities |
| [Text Display Instance](EntityAdapter/entries/entity/text_display_instance) | An instance of a text display entity |
| [Villager Instance](EntityAdapter/entries/entity/villager_instance) | An instance of a villager entity |
| [Cow Instance](./entries/entity/cow_instance.mdx) | An instance of a cow entity |
| [Interaction Indicator Definition](./entries/entity/interaction_indicator_definition.mdx) | Interaction Indicator |
| [Npc Instance](./entries/entity/npc_instance.mdx) | An instance of a simplified premade npc |
| [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 |
| [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 |

### Events

| Name | Description |
| ---- | ----------- |
| [Entity Interact Event](EntityAdapter/entries/event/entity_interact_event) | When the player clicks on an entity |
| [Entity Interact Event](./entries/event/entity_interact_event.mdx) | When the player clicks on an entity |

### Instances

| Name | Description |
| ---- | ----------- |
| [Advanced Entity Instance](EntityAdapter/entries/instance/advanced_entity_instance) | An advanced instance of an entity |
| [Advanced Entity Instance](./entries/instance/advanced_entity_instance.mdx) | An advanced instance of an entity |

### Quests

| Name | Description |
| ---- | ----------- |
| [Interact Entity Objective](EntityAdapter/entries/quest/interact_entity_objective) | Interact with an entity |
| [Interact Entity Objective](./entries/quest/interact_entity_objective.mdx) | Interact with an entity |

8 changes: 4 additions & 4 deletions documentation/docs/adapters/FancyNpcsAdapter/FancyNpcsAdapter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ This adapter is untested. It may not work as expected. Please report any issues

| Name | Description |
| ---- | ----------- |
| [Reference Npc Cinematic](FancyNpcsAdapter/entries/cinematic/fancy_reference_npc_cinematic) | A reference to an existing npc specifically for cinematic |
| [Self Npc Cinematic](FancyNpcsAdapter/entries/cinematic/fancy_self_npc_cinematic) | The player itself as an cinematic npc |
| [Reference Npc Cinematic](./entries/cinematic/fancy_reference_npc_cinematic.mdx) | A reference to an existing npc specifically for cinematic |
| [Self Npc Cinematic](./entries/cinematic/fancy_self_npc_cinematic.mdx) | The player itself as an cinematic npc |

### Entitys

| Name | Description |
| ---- | ----------- |
| [Reference Npc](FancyNpcsAdapter/entries/entity/fancy_reference_npc) | When the npc is not managed by TypeWriter |
| [Reference Npc](./entries/entity/fancy_reference_npc.mdx) | When the npc is not managed by TypeWriter |

### Events

| Name | Description |
| ---- | ----------- |
| [Npc Interact Event](FancyNpcsAdapter/entries/event/fancy_on_npc_interact) | When a player clicks on an NPC |
| [Npc Interact Event](./entries/event/fancy_on_npc_interact.mdx) | When a player clicks on an NPC |

16 changes: 8 additions & 8 deletions documentation/docs/adapters/MythicMobsAdapter/MythicMobsAdapter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,27 @@ This adapter is untested. It may not work as expected. Please report any issues

| Name | Description |
| ---- | ----------- |
| [Despawn Mob Action](MythicMobsAdapter/entries/action/despawn_mythicmobs_mob) | Despawn a mob from MythicMobs |
| [Execute Skill Action](MythicMobsAdapter/entries/action/execute_mythicmob_skill) | Executes a MythicMobs skill |
| [Spawn Mob Action](MythicMobsAdapter/entries/action/spawn_mythicmobs_mob) | Spawn a mob from MythicMobs |
| [Despawn Mob Action](./entries/action/despawn_mythicmobs_mob.mdx) | Despawn a mob from MythicMobs |
| [Execute Skill Action](./entries/action/execute_mythicmob_skill.mdx) | Executes a MythicMobs skill |
| [Spawn Mob Action](./entries/action/spawn_mythicmobs_mob.mdx) | Spawn a mob from MythicMobs |

### Cinematics

| Name | Description |
| ---- | ----------- |
| [Mythic Mob Cinematic](MythicMobsAdapter/entries/cinematic/mythicmob_cinematic) | Spawn a MythicMob during a cinematic |
| [Mythic Skill Cinematic](MythicMobsAdapter/entries/cinematic/mythicskill_cinematic) | Spawn a MythicMob during a cinematic |
| [Mythic Mob Cinematic](./entries/cinematic/mythicmob_cinematic.mdx) | Spawn a MythicMob during a cinematic |
| [Mythic Skill Cinematic](./entries/cinematic/mythicskill_cinematic.mdx) | Spawn a MythicMob during a cinematic |

### Events

| Name | Description |
| ---- | ----------- |
| [Mythic Mob Death Event](MythicMobsAdapter/entries/event/on_mythic_mob_die) | When a player kill a MythicMobs mob. |
| [Mythic Mob Interact Event](MythicMobsAdapter/entries/event/mythicmobs_interact_event) | MythicMob Interact Event |
| [Mythic Mob Death Event](./entries/event/on_mythic_mob_die.mdx) | When a player kill a MythicMobs mob. |
| [Mythic Mob Interact Event](./entries/event/mythicmobs_interact_event.mdx) | MythicMob Interact Event |

### Facts

| Name | Description |
| ---- | ----------- |
| [Mob Count Fact](MythicMobsAdapter/entries/fact/mythic_mob_count_fact) | Count the number of active Mythic Mobs of the specified type |
| [Mob Count Fact](./entries/fact/mythic_mob_count_fact.mdx) | Count the number of active Mythic Mobs of the specified type |

8 changes: 4 additions & 4 deletions documentation/docs/adapters/RPGRegionsAdapter/RPGRegionsAdapter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ This adapter is untested. It may not work as expected. Please report any issues

| Name | Description |
| ---- | ----------- |
| [Discover Region Action](RPGRegionsAdapter/entries/action/discover_rpg_region) | Create a discover for an RPGRegions region |
| [Discover Region Action](./entries/action/discover_rpg_region.mdx) | Create a discover for an RPGRegions region |

### Events

| Name | Description |
| ---- | ----------- |
| [Discover Region Event](RPGRegionsAdapter/entries/event/on_discover_rpg_region) | When a player discovers an RPGRegions region |
| [Enter Region Event](RPGRegionsAdapter/entries/event/on_enter_rpg_region) | When a player enters a RPGRegions region |
| [Discover Region Event](./entries/event/on_discover_rpg_region.mdx) | When a player discovers an RPGRegions region |
| [Enter Region Event](./entries/event/on_enter_rpg_region.mdx) | When a player enters a RPGRegions region |

### Facts

| Name | Description |
| ---- | ----------- |
| [In Region Fact](RPGRegionsAdapter/entries/fact/in_rpg_region_fact) | If the player is in a RPGRegions region |
| [In Region Fact](./entries/fact/in_rpg_region_fact.mdx) | If the player is in a RPGRegions region |

28 changes: 14 additions & 14 deletions documentation/docs/adapters/SuperiorSkyblockAdapter/SuperiorSkyblockAdapter.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,33 @@ This adapter is untested. It may not work as expected. Please report any issues

| Name | Description |
| ---- | ----------- |
| [Island Bank Deposit Action](SuperiorSkyblockAdapter/entries/action/island_bank_deposit) | Deposit into a player's Island bank |
| [Island Bank Withdraw Action](SuperiorSkyblockAdapter/entries/action/island_bank_withdraw) | Withdraw into a player's Island bank |
| [Island Disband Action](SuperiorSkyblockAdapter/entries/action/island_disband) | Disbands player's island |
| [Island Set Biome Action](SuperiorSkyblockAdapter/entries/action/island_set_biome) | Set a player's island's biome |
| [Island Set Border Size Action](SuperiorSkyblockAdapter/entries/action/island_set_border_size) | Set a player's island's border size |
| [Island Set Member Limit Action](SuperiorSkyblockAdapter/entries/action/island_set_member_limit) | Set a player's island's member limit |
| [Island Bank Deposit Action](./entries/action/island_bank_deposit.mdx) | Deposit into a player's Island bank |
| [Island Bank Withdraw Action](./entries/action/island_bank_withdraw.mdx) | Withdraw into a player's Island bank |
| [Island Disband Action](./entries/action/island_disband.mdx) | Disbands player's island |
| [Island Set Biome Action](./entries/action/island_set_biome.mdx) | Set a player's island's biome |
| [Island Set Border Size Action](./entries/action/island_set_border_size.mdx) | Set a player's island's border size |
| [Island Set Member Limit Action](./entries/action/island_set_member_limit.mdx) | Set a player's island's member limit |

### Events

| Name | Description |
| ---- | ----------- |
| [Island Create Event](SuperiorSkyblockAdapter/entries/event/on_island_create) | When a player creates an Island |
| [Island Disband Event](SuperiorSkyblockAdapter/entries/event/on_island_disband) | When a player disbands an Island |
| [Island Invite Event](SuperiorSkyblockAdapter/entries/event/on_island_invite) | When a player is invited to a Skyblock island |
| [Island Join Event](SuperiorSkyblockAdapter/entries/event/on_island_join) | When a player joins a Skyblock island |
| [Island Upgrade Event](SuperiorSkyblockAdapter/entries/event/on_island_upgrade) | When a player upgrades their Skyblock island |
| [Mission Complete Event](SuperiorSkyblockAdapter/entries/event/on_mission_complete) | When a player completes a mission |
| [Island Create Event](./entries/event/on_island_create.mdx) | When a player creates an Island |
| [Island Disband Event](./entries/event/on_island_disband.mdx) | When a player disbands an Island |
| [Island Invite Event](./entries/event/on_island_invite.mdx) | When a player is invited to a Skyblock island |
| [Island Join Event](./entries/event/on_island_join.mdx) | When a player joins a Skyblock island |
| [Island Upgrade Event](./entries/event/on_island_upgrade.mdx) | When a player upgrades their Skyblock island |
| [Mission Complete Event](./entries/event/on_mission_complete.mdx) | When a player completes a mission |

### Facts

| Name | Description |
| ---- | ----------- |
| [Island Fact](SuperiorSkyblockAdapter/entries/fact/island_fact) | Various facts about a player's island |
| [Island Fact](./entries/fact/island_fact.mdx) | Various facts about a player's island |

### Groups

| Name | Description |
| ---- | ----------- |
| [Island Group](SuperiorSkyblockAdapter/entries/group/island_group) | Group for the whole island |
| [Island Group](./entries/group/island_group.mdx) | Group for the whole island |

Loading

0 comments on commit 8fbc21f

Please sign in to comment.