Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 2.15 KB

README.md

File metadata and controls

32 lines (24 loc) · 2.15 KB
Raw

Trevor (n.) \tɹˈɛvə\

Build Status Java CI with Gradle Discord

Trevor is an open-source platform independent solution that unionizes Redis and Notchian-compliant proxies for cross-instance proxy communication.

Goals

As a community, to unionize our thinking (and as well as our proxies!) setting goals is an important part of working together as a group.

Main Goal

Trevor as an idea was created to build upon the ideas set forth by RedisBungee by creating a solution that has the ability to work with multiple proxy softwares in order to satisfy the need for cross-instance proxy communication. We developed Trevor because there are platforms where such cross-instance proxy communication simply does not exist.

Future goals

As the project progresses, it is our goal to provide high quality, featureful cross-instance proxy communication. We have future plans to expand in two main areas: storage and support.

  • Storage expansion means eventually, more ways to synchronize the servers will become avaliable as a replacement to just Redis at the moment.
  • Support expansion means that more platforms than just BungeeCord and Velocity will be supported. We also hope to perhaps also support Minecraft: Bedrock Edition as well in the future.

Building Trevor

git clone https://github.com/schematico/trevor.git
cd trevor/
./gradlew build

Project Layout

The project is laid out in multiple modules which interact with eachother in the ways described:

  • API An open, public API used by other plugins to rely, integrate, or interact with Trevor.
  • Common The code that is common between the independant platform modules is kept here.
  • Bungee, Velocity These modules utilize the common module to integrate with Trevor on their respective platforms.