Skip to content

Yet Another Minecraft API - an OpenSource API for accessing Minecraft block/item info

License

Notifications You must be signed in to change notification settings

Valink-Solutions/YamAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

YamAPI - Yet Another Minecraft API

Warning This tool is not production ready and should only be used as learning material. It is currently public for contributions only.

YamAPI is a simple, yet powerful, block and items API for Minecraft. It is designed to return the item image of Minecraft's items and blocks.

As of now, YamAPI is in its early stages and serves as a tool to be used by ChunkVault. We aim to expand its functionality and make it a comprehensive tool for all Minecraft related item and block image needs.

In the future, we are considering opening the API to mod developers. This would allow them to integrate their custom item data, which could be beneficial for projects like ChunkVault.

Stay tuned for more updates!

Development

Wrangler

Wrangler is used to develop, deploy, and configure your Worker via CLI.

Further documentation for Wrangler can be found here.

want to setup with a similar template to this one? Click here.

Usage

This template starts you off with a src/lib.rs file, acting as an entrypoint for requests hitting your Worker. Feel free to add more code in this file, or create Rust modules anywhere else for this project to use.

With wrangler, you can build, test, and deploy your Worker with the following commands:

# run your Worker in an ideal development workflow (with a local server, file watcher & more)
$ npm run dev

# deploy your Worker globally to the Cloudflare network (update your wrangler.toml file for configuration)
$ npm run deploy

Read the latest worker crate documentation here: https://docs.rs/worker

WebAssembly

workers-rs (the Rust SDK for Cloudflare Workers used in this template) is meant to be executed as compiled WebAssembly, and as such so must all the code you write and depend upon. All crates and modules used in Rust-based Workers projects have to compile to the wasm32-unknown-unknown triple.

Read more about this on the workers-rs project README.

About

Yet Another Minecraft API - an OpenSource API for accessing Minecraft block/item info

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages