Spile

Spile is a Minecraft Java edition game server and library written in Typescript and (soon) Rust using Deno.

About

Spile is a Minecraft Java Edition server that will in future sport all the features of other Minecraft servers such as Spigot. To make this possible in Deno, Rust plugins and Workers will be used for resource heavy operations and TypeScript will be used for game logic.

Spile will also be able to be used as a library to make minecraft bots in Deno. The server component is a long term project, and the Spile as library features will be developed in a "second-class" manner until the server is finished.

Check out issue #1 for a checklist of ideas planned for Spile.

Running Spile

There are two ways of running Spile, the first is by installing the Velociraptor CLI and then running vr start.

The other is to use the following command through the Deno CLI:

deno run --allow-net --allow-read --allow-write allow-env --config ./etc/tsconfig.json --importmap ./etc/import_map.json --lock ./etc/lock.json --unstable ./src/main.ts

It is recommended to use the VelociraptorCLI to avoid typing this long command or creating your own shell script. If you are contributing to Spile, do not commit any files for starting the server, you should instead be using the Velociraptor CLI. Please see the Contributing section below in the latter case.

Contributing

Follow the Deno Style Guide where appropriate. It can be inferred which rules do not apply from a cursory glance at the Spile code.

To use the scripts, install the Velociraptor CLI.

To configure the development environment, run vr setup_dev (this requires the aforementioned CLI).

To run Spile (in development mode), run vr dev.

Ensure that you lint everything with prettier (using an editor plugin is the easiest way to achieve this) and then vr lint prior to committing.

Do not use a deps.ts file. Instead use the import map, take a look at how previous imports are done and replicate the format.

If you use the Code Spell Checker VSCode plugin, you can create a custom_dictionary.json file in the root directory to use custom words. To update it, make your changes to the custom_dictionary.json file and run vr setup_dev again.

A note about the current state of the packet parser: The parser is currently written in TypeScript, this will change. The parser will be written in rust to take advantage of features such as macros and Rust's performance

Credits

This project would be impossible without these amazing people, resources, communities and projects:

Deno Standard Library - Useful guide on how I should go about writing stuff in Deno, especially the packet parser.
wiki.vg - Documentation on the Minecraft protocol.
Mojang - Mojang for such a cool game.
GlowstoneMC - For countless inspirations on how I should go about creating certain aspects on this project.
Feather - For ideas for the rust side of Spile.
PrismarineJS - Existing JS code to help me gain insight on how things are done through JS in the MC protocol.

License