ernest314 / secret-hitler

A WoW addon allowing anyone on the same server to play Secret Hitler together.

There is no structure to this addon directory, because frankly, I'm terrible at organizing things. So instead take a look at SecretHitler.toc and go from there.

TODO: update this shitty thing

secret-hitler's Issues

Obfuscate all comm messages

If everything gets obfuscated, there will be a lot of decoding overhead (if the channel is busy), since all messages will need to be decoded before filtering by room ID. Alternatively, only part of the message could be obfuscated.

Add key for lineup colors

The current lineup has the following color assignments:

• liberal = normal
• facist = red
• hitler = blue

This either needs a key, or roles need to be further clarified in some way.

Prevent malicious messages from crashing addon

Currently there are many ways a malicious actor could crash the addon. This is often due to malformed messages resulting in some substrings resolving to nil, and then attempting to use them.

An additional point of security consists of checking message authors (currently this is done very rarely), although this could add substantial overhead as well.

Reorganize license/readme files

These two files are currently duplicated across two directories. The correct location needs to be determined, and the duplicate files deleted.

Add error handling for crowded channel

Currently there is no error handling if the channel is too crowded, resulting in dropped messages. This can be fixed by checking for "chat busy" events (or something like that), and re-sending messages until they get through.

Add honor system disclaimer

Since communication is (currently) in cleartext, there should probably be some sort of disclaimer clarifying the honor system. The addon currently makes the assumption that anybody in the same lobby is non-malicious.

Implement "Instructions" button

Currently this button does nothing. At the very least, it should provide a link to the official ruleset.

Allow tabbing through input fields

Currently, the two editboxes on the Join Lobby screen do not allow for tabbing. It would greatly increase usability if those could be tabbed through.

Convert project to OOP

This would indirectly allow multiple games to exist at once. Will probably require looking into Lua metatables.

Add private mode to lobbies

The UI would be a simple checkbox on the Host Lobby screen, stopping ADVR##### broadcasts to the comms channel.

Clarify that lying is always allowed

Nowhere in the current addon is it made clear that lying is explicitly allowed (and probably necessary for facists).

Improve default positions of all Frames

Currently most Frames are set to open at y=30 relative to the CENTER of the screen. Although most are draggable, the default positions should be improved (and overlapping minimized where possible).

Setup automatic packaging on CurseForge

Currently it seems like automatic packaging requires the release name to contain "beta" (instead of just "b"). It doesn't seem like the .yaml file allows this to be customized.

Implement "Tips" button

The current "Tips" button on the splash screen does not do anything. At a minimum, it should display the "Strategy Notes" found at the end of the official ruleset.

Improve security of hash function

I'm not sure if the current hash function (for room keys) is actually secure. This should be double-checked and fixed if needed.

Add keybindings/options to addon

From a quick search, it appears keybindings are defined in a Bindings.xml file. I think official options have their own .xml file which is loaded into the options menu, although I am very unsure about that.

Add a list of public lobbies on Join window

Currently all ADVR##### are just being ignored. I'm not sure if this is best implemented as a separate window, or combined into the current Frame.

Theme addon for WoW

The current addon is very explicitly a direct port of the original Secret Hitler game. Should a more WoW-centric theme be added? This would allow the addon to be used in RP events.

Update Readme

The current Readme is a placeholder, and it should be updated before official release.

Add artwork for track arrows

Currently the arrows indicating the directions of the liberal/facist tracks are < and > characters, which is extremely ugly and possibly confusing.