AIE-Guild / GreenWall

Common communication channel as a replacement for guild chat in guild confederations.
MIT License
22 stars 15 forks source link
guild-chat world-of-warcraft

GreenWall

A World of Warcraft add-on to bridge guild chat between multiple guilds within a single realm or connected realms.

OverviewInstallationUser ConfigurationGuild ConfigurationSupportLicenseDedication

Overview

Build Status Coverage Status PRs Welcome

GreenWall is a World of Warcraft add-on that allows multiple guilds within a single realm, or connected realms to share guild chat as if they were one guild. When a member in one guild types something in guild chat, members of the other connected guilds (co-guilds) will see what was said and can respond.

GreenWall is similar to other addons like Guild2Guild or Cross Guild Chat, but it meets different design goals.

Meeting these design goals does have a few requirements.

Installation

Requirements

Twitch (Curse) App

Twitch

GreenWall is officially distributed on CurseForge and can be installed and updated with the Twitch Desktop App. This is the easiest installation method and is recommended for most users.

Manual Installation

GreenWall can also be downloaded from Github and installed manually.

  1. Download the compressed distribution file.
  2. Close World of Warcaft.
  3. Extract the contents of the file and place them in the World of Warcraft AddOns directory.
    • On Windows, C:\Program Files (x86)\World of Warcraft\Interface\AddOns or C:\Program Files\World of Warcraft\Interface\AddOns.
    • On OSX, ~/Applications/World of Warcraft/Interface/Addons.
  4. Launch World of Warcraft.
  5. Click the AddOns button on the character selection screen.
  6. Enable the add-on for your character.

User Configuration

Graphical Interface

GreenWall was designed to minimize the amount of configuration necessary by most members. If your officers have set up the guild configuration correctly, you don't need to do anything to participate in the conversation between co-guilds. However, there are a few options you may want to consider.

To access the user configuration screen:

  1. Open the Game Menu by hitting the Esc key.

  2. Click on the Interface button.

  3. Select the AddOns tab.

  4. Click on GreenWall in the sidebar.

Interface

You will be able to set the following options.

Command Line Interface

In addition to the graphical user interface, you can also modify the add-on settings from the prompt in the chat window.

All commands must be prefixed with /greenwall or /gw.

As an example, the configuration option for co-guild tagging is tag. To turn it on, you would enter one of the following commands. In the command descriptions, optional arguments are in square brackets and alternatives are separated by the pipe character.

/greenwall tag on
/gw tag on

To view the current configuration, you would enter one of the following.

/greenwall tag
/gw tag

Guild Configuration

This section covers the somewhat more difficult part, setting up the co-guild configuration that GreenWall uses to establish communication with other co-guilds in a confederation.

Definitions

Bridging Guild Chat

All configuration for general guild chat is stored in the "Guild Information" field in the "Guild" window (J). The block of configuration text will be read by GreenWall on the member machines. The benefit of this approach is that a member can join and use GreenWall without having to perform any special configuration.

All configuration directives use the following format.

GWx:arglist

The x is substituted with a specific opcode and the arglist portion is a colon separated list of arguments.

Required Configuration

Optional Configuration

Example

GWc:topSekritChan:pencil
GWv:1.1.00
GWp:Darkmoon Clan:DMC
GWp:Baseball Dandies:BBD
GWp:Nightlife:NL

Bridging Officer Chat

Configuration

There is only a single configuration directive for officer chat. It is stored in the officer note of the guild leader.

GWa:channel_name:password

This specifies the custom chat channel to use for bridging of the officer chat among co-guilds.

By default, officer chat bridging is disabled in the client. To participate across co-guilds, an officer will need to issue the following command and make sure that officer chat is enabled in one of the chat windows.

/greenwall ochat on

Example

GWa:secretSquirrels:rosebud

Support

Support for the GreenWall add-on is voluntary and considered "best effort". I make a reasonable attempt to respond to e-mail, comments and questions on the CurseForge page, and issues raised in Github.

The best way to provide information about significant problems you encounter or bugs you find is to follow the guide, Collecting Debugging Information.

All bug reports and feature requests should be submitted on Github. If you aren't comfortable with the Github issue tracker, please e-mail the details and I will add an issue record.

License


The MIT License (MIT)

Copyright (c) 2010-2020 Mark Rogaski

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Dedication

Ralff

GreenWall is dedicated in memoriam to the memory of Roger Keith White (1962-2017), known to the members of Alea Iacta Est as Ralff. Not only was he instrumental in the creation and refinement of GreenWall, he was the soul of our community writ in flesh and blood.

Never again shall we meet such a formidable mountain of intelligence, curiosity, hospitality, and non-stop innuendo.