Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
6e7778e
First iteration of the new ME/RS bridge documentation
SirEndii Mar 4, 2025
d080479
Adapt functions to the bridges branch and add documentation for filte…
SirEndii Mar 11, 2025
4c6cd36
fixed wrong branch and edit uri
SirEndii Mar 11, 2025
4a28e1d
amout -> amount
SirEndii Mar 11, 2025
d320d9e
correct name `getDimensionName` to `getDimension`
zyxkad Mar 16, 2025
d28beed
document deletePoint
SirEndii May 14, 2025
ec15291
cache updates
SirEndii May 14, 2025
dae9e38
Fixed build command to push any cache changes that came with the mkdo…
SirEndii May 14, 2025
e821d46
Set a default branch because apparently it does not checkout a branch…
SirEndii May 14, 2025
1414bc5
Apparently there are some changes in remote which I need to pull firs…
SirEndii May 14, 2025
531d671
remove wrong all argument for push
SirEndii May 14, 2025
0251112
Add redstone integrator warning
SirEndii May 14, 2025
868dbef
Make tables working again and centered
SirEndii May 14, 2025
bfc3fd7
Allow blank issues
SirEndii May 20, 2025
b460c0b
Fix page formatting with missing div
SirEndii May 24, 2025
97b53a0
authors cache
SirEndii Jun 7, 2025
eadbb58
Update dependencies
SirEndii Jun 7, 2025
04e8a06
Merge branch '0.7' into 0.7-bridges
SirEndii Jun 7, 2025
2966694
update the requirements.txt with the same packages used in the poetry…
SirEndii Jun 7, 2025
2bc882f
Update ME and RS Bridge documentation with new and updated functions,…
SirEndii Jun 7, 2025
3a1c4f8
Add command and RS/ME Bridge lua objects
SirEndii Jun 10, 2025
b49b795
Fixed duplicate text and hint message
SirEndii Jun 10, 2025
1a074b4
fix typo rsBridge -> meBridge
zyxkad Jun 14, 2025
653ec27
fix more RS -> ME
zyxkad Jun 14, 2025
03e7e15
Revert "fix more RS -> ME"
zyxkad Jun 14, 2025
b04a604
Revert "fix typo rsBridge -> meBridge"
zyxkad Jun 14, 2025
0cd5e4c
rename rs/me_bridge -> me/rs_bridge
zyxkad Jun 14, 2025
bdd1108
idk what am I doing
zyxkad Jun 14, 2025
738c379
update a few links
zyxkad Jun 14, 2025
920c8b9
document utf8 support
456dev Jul 1, 2025
e3a5dba
Merge pull request #108 from 456dev/feat/utf8-support
SirEndii Jul 6, 2025
11c2f82
fix typo in block_reader ipairs -> pairs
zyxkad Aug 2, 2025
94ee5e7
changed older to newer mistypo
notPlancha Aug 3, 2025
25d638e
Merge pull request #112 from notPlancha/patch-1
zyxkad Aug 3, 2025
ec8837b
Add disabled peripheral documentation
SirEndii Sep 8, 2025
daff51e
feat: Added docs for the pattern grid turtle
JCLemme Oct 3, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cache/plugin/git-committers/page-authors.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
blank_issues_enabled: true
contact_links:
- name: Mod issues
url: https://github.com/Seniorendi/AdvancedPeripherals/issues
url: https://github.com/IntelligenceModding/AdvancedPeripherals/issues
about: Please report bugs at the advanced peripherals repository. This repository is for documentation only.
10 changes: 10 additions & 0 deletions docs/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,14 @@ b.si {
font-size: 1.5rem;
padding-right: 0.3rem;
vertical-align: 1rem;
}

/* Center Markdown Tables (requires md_in_html extension) */
.center-table {
text-align: center;
}

.md-typeset .center-table :is(td,th):not([align]) {
/* Reset alignment for table cells */
text-align: initial;
}
27 changes: 27 additions & 0 deletions docs/guides/disabled_peripherals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
comments: true
---

# Disabled Peripherals

!!! failure
Only available for 1.19.2-0.7.39r, 1.20.1-0.7.45r, 1.21.1-0.7.57b or newer


Peripherals can be disabled in the configuration file of AP in `{minecraft_folder}/config/Advancedperipherals/peripherals.toml`.

When disabled, these peripherals can still be wrapped but all the functions throw a LuaException. Besides that, you can now find a new function called `peripheralDisabled`.
You can simply check in your script if a connected peripheral is disabled via the following example.

```lua
box = peripheral.find("chat_box") -- (1)
if box.peripheralDisabled then -- (2)
error("Peripheral is Disabled", 0)
end

print("Peripheral is not Disabled")

```

1. Can be any peripheral, as long as it is from AP.
2. We just check if the function exists, we don't run it since the function does not exist when the peripheral is not disabled.
31 changes: 29 additions & 2 deletions docs/guides/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ These can set the item, count, slots, tags, nbt or fingerprint values.

## Syntax

### Item/Fluid Name and Tag
### Item/Fluid/Chemical Name and Tag

The item's/fluid's filter name or tag can be specified with the `name` field.
If this field is not set, the filter will try to search for items with the right nbt values specified in the `nbt` field
Expand All @@ -32,9 +32,36 @@ This can be a tag or a name. To filter for tags, place a `#` in front of the nam
}
```

### Types

!!! success "Added in version 0.8 and 1.21.1-0.7"

Some functions can be used with any type of filter to prevent the same functions with just a different name. These filters are called generic filters.
They automatically search if the `name` provided is an item, a fluid or a mekanism chemical - in this order.
If none could be found, it will return an empty filter with the message `NO_VALID_FILTER_TYPE`.

A type can also be forced using the `type` key.
Depending on the AP version and the function, the following types can be used: `item`, `fluid` and `chemical`.

```lua
{
name = "minecraft:water"
type = "fluid"
}
```

The following example would return nil with the message `FLUID_NOT_FOUND` when used in a function.
```lua
{
name = "minecraft:dirt"
type = "fluid"
}
```


### Count

The item's/fluid's filter amout can be specified with the `count` field.
The item's/fluid's filter amount can be specified with the `count` field.
Standard values are 64 or 1000 for fluids.

```lua
Expand Down
118 changes: 118 additions & 0 deletions docs/guides/objects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Common Lua Objects

AP contains a lot of different objects based on in-game content, including Items, Item Stacks, Fluids, Entities and more.
This guide contains the most objects we have, including a description and every property with its type it can contain.

## Item
Base ítem properties:

| Property | Type | Description |
|----------|------|-------------|
| tags | table | List of item tags |
| name | string | Registry key of the item |

## Item Stack
Represents a specific amount of an item with additional properties. Includes all Item properties plus:

| Property | Type | Description |
|----------|------|-------------|
| count | number | Amount of items in the stack |
| displayName | string | Display name of the item |
| maxStackSize | number | Maximum stack size |
| components | table | NBT component data |
| fingerprint | string | Unique identifier for the stack |
| tags | table | List of item tags |
| name | string | Registry key of the item |
| slot | number | (Optional) Slot number when in inventory |

## Fluid
Base fluid properties:

| Property | Type | Description |
|----------|------|-------------|
| tags | table | List of fluid tags |
| name | string | Registry key of the fluid |

## Fluid Stack
Represents a specific amount of fluid with additional properties. Includes all Fluid properties plus:

| Property | Type | Description |
|----------|------|-------------|
| count | number | Amount of fluid |
| displayName | string | Display name of the fluid |
| fluidType | table | FluidType properties |
| components | table | NBT component data |
| fingerprint | string | Unique identifier for the stack |

## Mekanism Chemical
Base chemical properties:

| Property | Type | Description |
|----------|------|-------------|
| tags | table | List of chemical tags |
| name | string | Registry key of the chemical |
| isGaseous | boolean | Whether the chemical is gaseous |
| radioactivity | number | Radioactivity level of the chemical |

## Mekanism Chemical Stack
Represents a specific amount of chemical with additional properties. Includes all Chemical properties plus:

| Property | Type | Description |
|----------|------|-------------|
| count | number | Amount of chemical |
| displayName | string | Display name of the chemical |
| fingerprint | string | Unique identifier for the stack |


## Entity
| Property | Type | Description |
|----------|------|-------------|
| id | number | Entity ID |
| uuid | string | Entity UUID |
| name | string | Entity name |
| tags | table | Entity tags |
| canFreeze | boolean | Whether entity can freeze |
| isGlowing | boolean | Whether entity is glowing |
| isInWall | boolean | Whether entity is in a wall |

## Living Entity
Inherits all properties from Entity, plus:

| Property | Type | Description |
|----------|------|-------------|
| health | number | Current health |
| maxHealth | number | Maximum health |
| lastDamageSource | string | Last damage source (or nil) |

## Animal
Inherits all properties from LivingEntity, plus:

| Property | Type | Description |
|----------|------|-------------|
| baby | boolean | Whether the animal is a baby |
| inLove | boolean | Whether the animal is in love state |
| aggressive | boolean | Whether the animal is aggressive |
| shareable | boolean | Whether the animal can be sheared (if applicable) |

## Position
Common block position object used for some filters and return values.

| Property | Type | Description |
|----------|------|-------------|
| x | number | X coordinate |
| y | number | Y coordinate |
| z | number | Z coordinate |

## Fluid Type
| Property | Type | Description |
|----------|------|-------------|
| viscosity | number | Fluid viscosity |
| density | number | Fluid density |
| canHydrate | boolean | Whether fluid can hydrate |
| canExtinguish | boolean | Whether fluid can extinguish |
| canDrownIn | boolean | Whether entities can drown in it |
| canSwim | boolean | Whether entities can swim in it |
| canPushEntity | boolean | Whether fluid can push entities |
| supportsBoating | boolean | Whether boats can float on it |
| canConvertToSource | boolean | Whether fluid can convert to source blocks |
| temperature | number | Fluid temperature |
Loading