Skip to content

Commit

Permalink
Updated documentation. (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrogaski committed Mar 22, 2014
1 parent f9155fc commit c99af0b
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 18 deletions.
58 changes: 51 additions & 7 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,57 @@ <h2>Prerequisites</h2>
</li>
</ul>
</li>
</ol><h2>Usage</h2>
</ol><h2>Configuration</h2>

<p>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 particiapte in the conversation between co-guilds.</p>

<p>However, there are a few options you may want to consider. </p>

<p>To access the user configuration screen:</p>

<ol>
<li>Open the <strong>Game Menu</strong> by hitting the <code>Esc</code> key.</li>
<li>Click on the <strong>Interface</strong> button.</li>
<li>Select the <strong>AddOns</strong> tab.</li>
<li>Click on <strong>GreenWall</strong> in the sidebar.</li>
</ol><p>You will be able to enable or disable the following options.</p>

<p><strong>Show Co-Guild Tags</strong></p>

<blockquote>
<p>Show co-guild identifier in messages. <br>
Default: on</p>
</blockquote>

<p><strong>Show Co-Guild Achievement Announcements</strong></p>

<blockquote>
<p>Show achievements from other co-guilds. <br>
Default: off</p>
</blockquote>

<p><strong>Show Co-Guild Roster Announcements</strong></p>

<blockquote>
<p>Show guild join and leave messages from other co-guilds. <br>
Default: on </p>
</blockquote>

<p><strong>Show Co-Guild Rank Announcements</strong></p>

<blockquote>
<p>Show promotion and demotion messages from other co-guilds. <br>
Default: off </p>
</blockquote>

<p><strong>Bridge Officer Chat</strong></p>

<blockquote>
<p>Show bridge officer chat between the co-guilds. This only works for members who have privileges to view officer notes.<br>
Default: off </p>
</blockquote>

<h2>Command Line Interface</h2>

<p>All commands must be prefixed with <code>/greenwall</code> or <code>/gw</code>.</p>

Expand All @@ -452,12 +502,6 @@ <h2>Prerequisites</h2>
/gw tag
</code></pre>

<h2>Configuration</h2>

<p>You don't need to configure GreenWall at all to use it. </p>

<p>Most of the configuration is done by the guild officers, it's a big mess of gibberish in the guild information tab in game. But you can change certain aspects of its behavior to suit your tastes.</p>

<h3>Output Options</h3>

<p>tag [ on | off ]</p>
Expand Down
49 changes: 38 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,42 @@ You can also check out the latest version from the GitHub repository, if you are
- If the button is NOT there: means you did not install the addons properly.


## Usage ##
## Configuration ##

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 particiapte 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.

You will be able to enable or disable the following options.

**Show Co-Guild Tags**
> Show co-guild identifier in messages.
> Default: on
**Show Co-Guild Achievement Announcements**
> Show achievements from other co-guilds.
> Default: off
**Show Co-Guild Roster Announcements**
> Show guild join and leave messages from other co-guilds.
> Default: on
**Show Co-Guild Rank Announcements**
> Show promotion and demotion messages from other co-guilds.
> Default: off
**Bridge Officer Chat**
> Show bridge officer chat between the co-guilds. This only works for members who have privileges to view officer notes.
> Default: off
## Command Line Interface ##

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

Expand All @@ -96,23 +131,15 @@ To view the current configuration, you would enter one of the following.
/greenwall tag
/gw tag


## Configuration ##

You don't need to configure GreenWall at all to use it.

Most of the configuration is done by the guild officers, it's a big mess of gibberish in the guild information tab in game. But you can change certain aspects of its behavior to suit your tastes.


### Output Options ###

tag [ on | off ]
> Show co-guild identifier in messages.
> Default: on</dd>
> Default: on
achievements [ on | off ]
> Show achievements from other co-guilds.
> Default: off</dd>
> Default: off
roster [ on | off ]
> Show guild join and leave messages from other co-guilds.
Expand Down

0 comments on commit c99af0b

Please sign in to comment.