Skip to content

Setup

Jump to bottom Edit New page
PheonixVX edited this page Aug 5, 2020 · 8 revisions

Beacon Setup

Beacon is a server-side plugin api/plugin development helper for fabric. Beacon combines the power of plugins and server-side mods to achieve a broader spectrum than normal plugins and greatly eases the burden of writing server-side code.

Type or copy the following into the terminal:
$ git clone https://github.com/The-HyperZone/Beacon.git

This will download and create the necessary source files for Beacon to be built as a dependency. If you're new to fabric, or just generally need to update your sources and caches, run these commands:

$ gradlew genSources
$ gradlew build

This will generate the latest sources provided by Beacon and will build the project. If you are wanting to particularly edit Beacon's source code, make run configurations for your IDE available at Fabric's website

After you've built the mod, you can now download the example plugin from Beacon Example Plugin and continue these tutorials.

This work is licensed under the GNU Affero General Public License. The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.

Add a custom sidebar
Clone this wiki locally