Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 2.13 KB

README.md

File metadata and controls

52 lines (37 loc) · 2.13 KB

FalconMC

Join on discord!

Description

FalconMC is an afk Minecraft server written in Rust that aims to support all client versions ranging from 1.13 till 1.17.1 (1.8-12.2 coming eventually). Its main priority is performance and the ability to effortlessly hold many players at once. Support for writing custom plugins is planned.

Make sure to join us on Discord!

Upcoming features

  • Bungeecord and velocity support
  • Plugins
  • As much version overlap as possible

Non-goals

  • 100% complete recreation of every version

Getting started

First, clone the repository:

git clone https://github.com/FalconMC-Dev/FalconMC.git

To then checkout the stable branch main, do:

git checkout main

Or for users who want the bleeding edge, do:

git checkout develop

Then build the project like any other Rust project, make sure you pass --bin falcon-mc to cargo.

Documentation

We aim to provide documentation as up-to-date as possible. Currently, this is still a work in progress. As of right now it's better to just contact me directly, ideally through discord.

See our wiki for more information about user setup, plugin development, code architecture, ...

Contributing

Please feel free to help out in any way possible, the wiki includes information on the codebase's layout and architecture. Discord is the ideal place to ask questions.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the GNU AGPL v3.0 license, shall be licensed as below, without any additional terms or conditions.

License

Licensed under the GNU Affero General Public License v3.0 - (LICENSE or https://choosealicense.com/licenses/agpl-3.0/)