arciera / server

A Minecraft server written in TypeScript. Modern, multi-threaded, modular and built for performance.

arciera/server

Download · Documentation

A Minecraft server written in TypeScript. Modern, multi-threaded, modular and built for performance.

Running

To run arciera/server you need Node.js 18 or higher.

Download server.mjs from the latest release. Alternatively, you can clone the repository and run npm run bundle to build the server yourself. You will find the bundled server in build/index.js.

To start the server:

node server.mjs

To stop the server, send SIGINT by pressing Ctrl+C (^C).

Issues

If you find any bugs or issues, or have any suggestions, please open an issue.

Fixing bugs is our utmost priority.

FAQ

I can't join the world!

Arciera server is a bare-bones server and does not have a world. If you want to connect to a world, you need to use a plugin that provides a world. Any additional features beyond simply establishing a connection require a plugin.

Contributing

All contributions are most welcome!

If you would like to contribute a new feature, make sure that it is within the scope of the project. Arciera server aims to be minimal and lightweight and sometimes creating a plugin might be more suitable.

To contribute, fork the repository, make your changes and open a pull request.

server's Issues

Wrong packet when refreshing the server list

When refreshing the server list, "LoginPacket" is executed, so the data is all messed up.

Steps to reproduce

• Start the server
• Add it to the server list
• Refresh the list with either F5 or the Refresh button.

Login success / encryption

Negotiate encryption and achieve login success

Graceful shutdown with connections disconnect

Add public method on server that disconnects all connections and stops server.

Trigger graceful stop on SIGINT (^C)

[Feature]: Protocol types

What feature would you like to see?

Create types for VarInt, String, Chat, Array, etc. that can be used like this:

ParsedPacket#get<Type>(type: Type)
ParsedPacket#write<Type>(type: Type)

This will also be useful in constructors of ServerPacket packets.

[Feature]: Server scheduler with clock at 20 Hz (TPS)

What feature would you like to see?

Create a precise 20 ticks per second clock on the Server instance.

Logger min level

A configuration option to filter logger levels. If you set it to WARN, you will only see warnings and higher.

default: info

Hierarchy:

• debug
• info
• success
• warn
• error

[Feature]: generate docs

What feature would you like to see?

We could generate docs from our TsDoc /** */.

Maybe look into Docusaurus, TypeDoc, etc. https://www.npmjs.com/package/docusaurus-plugin-typedoc

[Feature]: Kick players

What feature would you like to see?

Be able to kick players with a message

[Feature]: Make interface for config

What feature would you like to see?

sth like

interface Config {
    /**
     * The port the server will listen on for new connections
     */
    port: number;
}

and

ConfigLoader.fromFile(string): Config

More events

[Bug]: Logger#error sends stdout

What happened?

logger level ERROR should log in stderr

Version

None

What Minecraft version are you running?

No response

Relevant log output

No response

[Feature]: test feature

What feature would you like to see?

some feature probably

[Feature]: improved packet detection based on state

What feature would you like to see?

Use Connection#state to optimise packet type detection

Better connection management

[Feature]: Plugin loader

What feature would you like to see?

Create a class that plugins extend and gives them access to even low-level features.

Also needed plugin loader.

We could maybe somehow use NPM to inherit the benefits of package management.