Github EQ

Uses a lua mod to redirect /bug reports to github issues.

What does it look like?

When someone does a /bug in game, it sends the issue to github. No database interactions.

How the issues look:

Expanded sections:

How does it work?

• On /bug, a lua mod is fired and overrides the default behavior of in game #bugs.
• The lua mod creates a .txt file in the issues folder on your eqemu dir.
• Githubeq is a program that every minute by default, iteartes txt files in issues, and sends it to github as an issue. It then deletes the .txt file.
• You can then use projects in github to organize the issues and triage things, with less noise like you get on discord forum bug reports.

Installation

1. NOTE eqemu has not yet added a PR that adds support for this. Once it is added, you'll need to wait for a release from eqemu and update your binaries to obtain it.
2. Go to the releases page or click links in instructions below.
3. Download githubeq-linux or githubeq-windows.exe based on your OS, place it in the root of your eqemu folder. (Ideally below quests)
4. Run githubeq. It will exit and generate a githubeq.conf file.
5. Create a personal access token:
   1. Go to Settings in Github
   2. On the bottom, click Developer Settings
   3. Go to Fine-grained tokens
   4. Click Generate new Token
   5. For token name, put githubeq-<servername> or whatever you like.
   6. Expiration, I set mine for a year. This means in a year you'll need to refresh this token. (Not sure the maximum duration it can go)
   7. Repository Access, only select repositories, and find your repository you want issues to go to.
   8. Permissions, expand and scroll down to Issues, set access to Read and Write
   9. Click generate token. You'll get a token with prefix like github_pat_ and a long string of characters. Copy this token.
6. Edit your githubeq.conf file and put in your token.
7. Add repository and user based on what the token was used, e.g. user: xackery, repository: githubeq would be for this repository.
8. Run githubeq again. It should now work and go idle.
9. Check if githubeq made an issues folder. This is where the issues in lua should generate at.
10. Download register_bug.lua and place it in your mods folder, which should be in your eqemu root.
11. Create a file called mods/load_order.txt if it doesn't already exist.
12. Edit mods/load_order.txt and add register_bug.lua to the bottom of the file.
13. Go in game and type #rq to reload quests.
14. Type /bug in game and create an issue.
15. Peek at githubeq's output after ~60s and you should see if it picked up the file.
16. Check if issues in your repository is populated with your new issue.

Label Configuration

You'll find in the githubeq.conf entries for labels.

While a description is provided, let me break it down even more here:

• bug_label will be applied to all /bug reports, if not empty
• fallback_label will be used if no label is set for a provided label
• the remaining labels are from the dropdown category in game. In my case, which is totally optional, I group them into this subset:

Other - bug Video - bug Audio - bug Pathing - npc Quest - quest Tradeskills - tradeskills Spell stacking - spell Doors/Portals - zone Items - items NPC - npc Dialogs - npc LoN - TCG - bug Mercenaries - bug

To use the above, I create each label in the labels section in github issues. Then I add the label name to the githubeq.conf file 1 to 1 with how it's worded.