Giter Club home page Giter Club logo

feather's Introduction

Feather

build Discord

A Minecraft server implementation written in Rust.

Features

Note that Feather is still early in development. Don't expect anything not listed here to work.

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

On the current develop branch, some more features are pending release:

  • Commands (/tell, /tp, /gamemode)
  • Survival mode
  • Survival mode block breaking and drops
  • Health + fall damage
  • (soon) block entities, including chests

Running

We offer precompiled binaries for Windows, Linux, and macOS 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/feather-rs/feather
cd feather
cargo build --release

Compiling from source requires Java JDK 8 and rustfmt.

The server executable will be located in target/release.

FAQ

  • Is Feather production ready?

Not yet. There are numerous bugs and missing features which have yet to be resolved, and the codebase has not been tested enough to consider the server production ready.

  • How can I contribute?

Check out our issue tracker to find an issue which appeals to you. Feel free to join our Discord and ask questions whenever you need. Thanks for your interest in contributing!

  • Are there other ways I can help?

Yes! We're always looking for people to test out the server and find bugs. If you find anything that doesn't seem right to you, please submit an issue on the issue tracker.

feather's People

Contributors

1011x avatar ambeeeeee avatar aramperes avatar caelunshun avatar cheako avatar defman avatar deliquescence avatar dependabot-preview[bot] avatar flohag avatar nikhiljha avatar nilsirl avatar nyxcode avatar onbjerg avatar redrield avatar schuwi avatar ssttevee avatar thijsray avatar wazner avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.