Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 2.23 KB

README.md

File metadata and controls

54 lines (43 loc) · 2.23 KB

Feather

build coverage Discord

An experimental Minecraft server implementation written in Rust.

Features

Many basic features are already implemented:

  • Highly scalable architecture
  • Anvil world loading and saving
  • Physics
  • Basic world generation
  • Chunk streaming
  • Day/night cycle
  • Arrow shooting
  • Falling blocks
  • Block placement and breaking
  • Item dropping and collection
  • Chat
  • Inventory handling
  • Movement broadcasting

Be aware that a major refactor is currently undergoing here which is hindering development of new features. Once this refactor is complete, a rapid pace of feature development will begin.

Running

We offer precompiled binaries for Windows and Linux at GitHub Releases.

To run Feather:

  • Extract the downloaded archive.
  • Run the binary.
    • On Linux and macOS: ./feather-server in the server directory
    • On Windows: double-click feather-server.exe

The server will create a configuration file (feather.toml) which you can modify.

Feather will generate a world by default. If you want to load a vanilla world, copy the world save to the server directory under the name "world" (by default).

Warning: Feather world persistence is fairly new and will likely cause problems when attempting to open Feather worlds in vanilla. Do not let Feather touch worlds you care about unless they have been backed up.

Feather currently only supports 1.13.2 clients and world saves. In the future, additional versions will be supported.

Compiling

If you are on another platform, compile the server yourself to try it out:

git clone https://github.com/caelunshun/feather
cd feather
cargo build --release

The server executable will be located in target/release.