Skip to content

bro i just want to update readme.md but really have to manually "compile" to get it actually updated #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,53 @@
<div align="center">
<h1>Documentation for Latite Client Scripting</h1>
<p><a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/docs-markdown/exports.md">Documentation in Markdown</a></p>

<a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/LICENSE.md">License</a>
</div>

# Latite Plugin API

[GitHub page for official definitions and API code](https://github.com/latitescripting/latiteapi)

The Latite Scripting/Plugin API is an advanced client-side Minecraft Scripting API for Latite Client. The API allows you to interact with many aspects of the Minecraft Windows 10/11 Edition client (while not allowing cheats).

### What is Latite Client?
Latite Client is a non-cheat modification for Minecraft Windows 10/11 Edition which has features ranging from world utility to visual mods and PVP-related utilities.

### Restrictions
Some features in Latite Client Scripting are restricted. Features such as getting the entities, attacking entities, getting entity positions are limited to operators to prevent cheating.

Other things like world manipulation are only possible on local worlds.

### How to use this API

You need to have [Latite Client](https://latite.net) to use the latest iteration of the Latite Plugin API.

Join the [Latite Discord](https://discord.gg/latite) for more information.

Latite's scripting API uses JavaScript.

## How to make a Plugin

You can view a quick guide/quickstart [here](https://github.com/LatiteScripting/Scripts/tree/master/how-to-make-a-plugin.md)

For scripting documentation, go to https://latitescripting.github.io/

## Debugging

You can [debug your scripts](https://github.com/LatiteScripting/Scripts/tree/master/debugging.md) in Latite Client using Visual Studio.

## Using the .plugin command in game
To install those plugin, run `.plugin install <pluginname>` ingame. For example, do `.plugin install chatlogger` to install the ChatLogger plugin.

## Cloning the scripts repository
Cloning the scripts repository is a good way to get plugins.

Use this command to clone the scripts repository and all plugins inside it:
```console
git clone https://github.com/LatiteScripting/Scripts.git
```
You can also [download the plugins here](https://github.com/LatiteScripting/Scripts/archive/refs/heads/master.zip)




52 changes: 50 additions & 2 deletions docs-markdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,55 @@
<div align="center">
<h1>Documentation for Latite Client Scripting</h1>
<p><a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/docs-markdown/exports.md">Documentation in Markdown</a></p>
<a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/LICENSE.md">License</a>
</div>

<a href="https://github.com/LatiteScripting/latitescripting.github.io/blob/main/LICENSE.md">License</a>
# Latite Plugin API

</div>
[GitHub page for official definitions and API code](https://github.com/latitescripting/latiteapi)

The Latite Scripting/Plugin API is an advanced client-side Minecraft Scripting API for Latite Client. The API allows you to interact with many aspects of the Minecraft Windows 10/11 Edition client (while not allowing cheats).

### What is Latite Client?

Latite Client is a non-cheat modification for Minecraft Windows 10/11 Edition which has features ranging from world utility to visual mods and PVP-related utilities.

### Restrictions

Some features in Latite Client Scripting are restricted. Features such as getting the entities, attacking entities, getting entity positions are limited to operators to prevent cheating.

Other things like world manipulation are only possible on local worlds.

### How to use this API

You need to have [Latite Client](https://latite.net) to use the latest iteration of the Latite Plugin API.

Join the [Latite Discord](https://discord.gg/latite) for more information.

Latite's scripting API uses JavaScript.

## How to make a Plugin

You can view a quick guide/quickstart [here](https://github.com/LatiteScripting/Scripts/tree/master/how-to-make-a-plugin.md)

For scripting documentation, go to https://latitescripting.github.io/

## Debugging

You can [debug your scripts](https://github.com/LatiteScripting/Scripts/tree/master/debugging.md) in Latite Client using Visual Studio.

## Using the .plugin command in game

To install those plugin, run `.plugin install <pluginname>` ingame. For example, do `.plugin install chatlogger` to install the ChatLogger plugin.

## Cloning the scripts repository

Cloning the scripts repository is a good way to get plugins.

Use this command to clone the scripts repository and all plugins inside it:

```console
git clone https://github.com/LatiteScripting/Scripts.git
```

You can also [download the plugins here](https://github.com/LatiteScripting/Scripts/archive/refs/heads/master.zip)
Original file line number Diff line number Diff line change
Expand Up @@ -8,221 +8,221 @@

**`Interface`**

**Source:** [api/TextColor.d.ts:1](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L1)
**Source:** [api/TextColor.d.ts:1](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L1)

## Properties

### AQUA

> **AQUA**: `string`

**Source:** [api/TextColor.d.ts:24](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L24)
**Source:** [api/TextColor.d.ts:24](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L24)

### BLACK

> **BLACK**: `string`

**Source:** [api/TextColor.d.ts:13](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L13)
**Source:** [api/TextColor.d.ts:13](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L13)

### BLUE

> **BLUE**: `string`

**Source:** [api/TextColor.d.ts:22](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L22)
**Source:** [api/TextColor.d.ts:22](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L22)

### BOLD

> **BOLD**: `string`

**Source:** [api/TextColor.d.ts:7](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L7)
**Source:** [api/TextColor.d.ts:7](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L7)

### DARK_AQUA

> **DARK_AQUA**: `string`

**Source:** [api/TextColor.d.ts:16](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L16)
**Source:** [api/TextColor.d.ts:16](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L16)

### DARK_BLUE

> **DARK_BLUE**: `string`

**Source:** [api/TextColor.d.ts:14](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L14)
**Source:** [api/TextColor.d.ts:14](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L14)

### DARK_GRAY

> **DARK_GRAY**: `string`

**Source:** [api/TextColor.d.ts:21](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L21)
**Source:** [api/TextColor.d.ts:21](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L21)

### DARK_GREEN

> **DARK_GREEN**: `string`

**Source:** [api/TextColor.d.ts:15](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L15)
**Source:** [api/TextColor.d.ts:15](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L15)

### DARK_PURPLE

> **DARK_PURPLE**: `string`

**Source:** [api/TextColor.d.ts:18](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L18)
**Source:** [api/TextColor.d.ts:18](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L18)

### DARK_RED

> **DARK_RED**: `string`

**Source:** [api/TextColor.d.ts:17](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L17)
**Source:** [api/TextColor.d.ts:17](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L17)

### FORMAT_CHAR

> **FORMAT_CHAR**: `string`

**Source:** [api/TextColor.d.ts:2](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L2)
**Source:** [api/TextColor.d.ts:2](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L2)

### GOLD

> **GOLD**: `string`

**Source:** [api/TextColor.d.ts:19](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L19)
**Source:** [api/TextColor.d.ts:19](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L19)

### GRAY

> **GRAY**: `string`

**Source:** [api/TextColor.d.ts:20](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L20)
**Source:** [api/TextColor.d.ts:20](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L20)

### GREEN

> **GREEN**: `string`

**Source:** [api/TextColor.d.ts:23](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L23)
**Source:** [api/TextColor.d.ts:23](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L23)

### ITALIC

> **ITALIC**: `string`

**Source:** [api/TextColor.d.ts:8](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L8)
**Source:** [api/TextColor.d.ts:8](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L8)

### LIGHT_PURPLE

> **LIGHT_PURPLE**: `string`

**Source:** [api/TextColor.d.ts:26](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L26)
**Source:** [api/TextColor.d.ts:26](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L26)

### MATERIAL_AMETHYST

> **MATERIAL_AMETHYST**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:73](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L73)
**Source:** [api/TextColor.d.ts:73](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L73)

### MATERIAL_COPPER

> **MATERIAL_COPPER**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:53](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L53)
**Source:** [api/TextColor.d.ts:53](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L53)

### MATERIAL_DIAMOND

> **MATERIAL_DIAMOND**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:65](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L65)
**Source:** [api/TextColor.d.ts:65](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L65)

### MATERIAL_EMERALD

> **MATERIAL_EMERALD**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:61](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L61)
**Source:** [api/TextColor.d.ts:61](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L61)

### MATERIAL_GOLD

> **MATERIAL_GOLD**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:57](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L57)
**Source:** [api/TextColor.d.ts:57](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L57)

### MATERIAL_IRON

> **MATERIAL_IRON**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:41](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L41)
**Source:** [api/TextColor.d.ts:41](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L41)

### MATERIAL_LAPIS

> **MATERIAL_LAPIS**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:69](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L69)
**Source:** [api/TextColor.d.ts:69](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L69)

### MATERIAL_NETHERITE

> **MATERIAL_NETHERITE**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:45](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L45)
**Source:** [api/TextColor.d.ts:45](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L45)

### MATERIAL_QUARTZ

> **MATERIAL_QUARTZ**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:37](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L37)
**Source:** [api/TextColor.d.ts:37](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L37)

### MATERIAL_REDSTONE

> **MATERIAL_REDSTONE**: `string`

1.20 ONLY

**Source:** [api/TextColor.d.ts:49](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L49)
**Source:** [api/TextColor.d.ts:49](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L49)

### MINECOIN_GOLD

> **MINECOIN_GOLD**: `string`

**Source:** [api/TextColor.d.ts:32](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L32)
**Source:** [api/TextColor.d.ts:32](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L32)

### OBFUSCATE

> **OBFUSCATE**: `string`

**Source:** [api/TextColor.d.ts:6](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L6)
**Source:** [api/TextColor.d.ts:6](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L6)

### RED

> **RED**: `string`

**Source:** [api/TextColor.d.ts:25](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L25)
**Source:** [api/TextColor.d.ts:25](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L25)

### RESET

> **RESET**: `string`

**Source:** [api/TextColor.d.ts:9](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L9)
**Source:** [api/TextColor.d.ts:9](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L9)

### WHITE

> **WHITE**: `string`

**Source:** [api/TextColor.d.ts:28](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L28)
**Source:** [api/TextColor.d.ts:28](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L28)

### YELLOW

> **YELLOW**: `string`

**Source:** [api/TextColor.d.ts:27](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L27)
**Source:** [api/TextColor.d.ts:27](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L27)

## Methods

Expand All @@ -232,7 +232,7 @@

Formats '&' into colorcoded string.

**Source:** [api/TextColor.d.ts:79](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L79)
**Source:** [api/TextColor.d.ts:79](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L79)

#### Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@

> `const` **TextColor**: [`ITextColor`](../interfaces/interface.ITextColor.md)

**Source:** [api/TextColor.d.ts:82](https://github.com/LatiteScripting/latitescripting.github.io/blob/796c413/definitions/api/TextColor.d.ts#L82)
**Source:** [api/TextColor.d.ts:82](https://github.com/EpiclyRaspberry/latitescripting.github.io/blob/0717eac/definitions/api/TextColor.d.ts#L82)
Loading