Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CakeLancelot authored Aug 18, 2022
1 parent d210bfa commit c4289f6
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# HeroesExtension
[![releases badge](https://img.shields.io/github/v/release/CakeLancelot/HeroesExtension)](https://www.github.com/CakeLancelot/HeroesExtension/releases)
[![discord badge](https://img.shields.io/discord/847806741295136789?color=687DC5&logo=discord)](https://discord.gg/PFVFQH9hrD)
[![Releases Badge](https://img.shields.io/github/v/release/CakeLancelot/HeroesExtension)](https://www.github.com/CakeLancelot/HeroesExtension/releases)
[![Build Status Badge](https://github.com/CakeLancelot/HeroesExtension/actions/workflows/gradle.yml/badge.svg)](https://github.com/CakeLancelot/HeroesExtension/actions/workflows/gradle.yml)
[![Discord Badge](https://img.shields.io/discord/847806741295136789?color=687DC5&logo=discord)](https://discord.gg/PFVFQH9hrD)


An open-source SFS2X extension for FusionFall: Heroes.
Expand All @@ -15,8 +16,8 @@ Currently, it is in the proof-of-concept/"landwalker" stage, **don't expect a fu
# Setup
> This guide assumes you already have a working SmartFoxServer2X installation.
> If you don't, there's a decent guide available [here](http://docs2x.smartfoxserver.com/GettingStarted/installation).
1. Either build the project yourself, or head to the releases page and grab HeroesExtension.jar.
2. In your SFS2X directory, drop HeroesExtension.jar into `extensions/Heroes`. Create the folder if it doesn't exist yet.
1. Either build the project yourself, or head to the releases page and grab HeroesZoneExtension.jar.
2. In your SFS2X directory, drop HeroesZoneExtension.jar into `extensions/Heroes`. Create the folder if it doesn't exist yet.
3. Download the game's definition files (see [here](deploy/definitions/README.md) for instructions), then copy the `definitions` directory to `extensions/Heroes`.
4. Head to the SFS2X admin tool, and create a new zone: name it `Heroes`. Inside the zone, make sure you have a default "lobby" room.
5. For the zone's extension, select `Heroes` for the name, `JAVA` as the type, and `net.cakelancelot.heroes.extension.HeroesZoneExtension` as the main class. **Do not configure extensions on a per-room basis!**
Expand All @@ -31,4 +32,4 @@ Pull requests for adding features are also welcome!
* Danny O for the HD Dexlabs logo and info gathering.
* The rest of the crew in the Discord server for the support!

![SFS2X Logo](res/sfs2xlogo.png)
![SFS2X Logo](res/sfs2xlogo.png)

0 comments on commit c4289f6

Please sign in to comment.