# Xyraith Programming Language
![h](https://img.shields.io/github/repo-size/akarahdev/xyraith)
Xyraith is a scripting language designed specifically for creating Minecraft servers. This README.md file provides an overview of Xyraith and explains how to install and use it. It also includes an example code snippet to help you get started.

## Example Code

Here's an example code snippet written in Xyraith:
```xyraith
fn main() when<startup> query<> {

}
```


This code defines a `main` function, which is executed when the Minecraft server starts up. Inside the `main` function, it uses the `std::console::print` function to print the string "Hello world!" to the console.

## Installation

To use Xyraith for Minecraft server scripting, you need to have the Cargo toolchain (Rust's package manager) installed. If you have Cargo installed, you can install Xyraith by running the following command:

```shell
cargo install xyraith`
```


Alternatively, you can download the Xyraith package from the GitHub releases page and install it manually.

## Usage

Once you have Xyraith installed, you can start writing scripts for your Minecraft server. Xyraith scripts have the `.xy` file extension.

To run a Xyraith script, navigate to the directory containing your script files, typically located in the `scripts/` directory of your Minecraft server installation, and use the following command:

```shell
xyraith run
```

This command will execute all the scripts present in the `scripts/` directory, allowing you to customize and extend your Minecraft server behavior using Xyraith.

## Documentation

For detailed information about the Xyraith programming language, including its syntax, features, and usage for Minecraft server scripting, refer to the official documentation. You can find the documentation at `todo!()`.

## Contributing

If you encounter any issues or have suggestions for improvements, feel free to open an issue on the GitHub repository. Contributions to the Xyraith programming language and its Minecraft server integration are also welcome. Please read the contribution guidelines before submitting a pull request.

## License

Xyraith is released under the MIT License. See the [LICENSE](LICENSE) file for more details.