openra / orabot

A reincarnation of OpenRA's famous IRC bot, written in C# to service the OpenRA server on Discord.

OpenRA

A Libre/Free Real Time Strategy game engine supporting early Westwood classics.

• Website: https://www.openra.net
• Chat: #openra on Libera (web) or Discord
• Repository: https://github.com/OpenRA/OpenRA

Please read the FAQ in our Wiki and report problems at https://github.com/OpenRA/OpenRA/issues.

Join the Forum for discussion.

Play

Distributed mods include a reimagining of

• Command & Conquer: Red Alert
• Command & Conquer: Tiberian Dawn
• Dune 2000

EA has not endorsed and does not support this product.

Check our Playing the Game Guide to win multiplayer matches.

Contribute

• Please read INSTALL.md and Compiling on how to set up an OpenRA development environment.
• See Hacking for a (now very outdated) overview of the engine.
• Read and follow our Code of Conduct.
• To get your patches merged, please adhere to the Contributing guidelines.

Mapping

• We offer a Mapping Tutorial as you can change gameplay drastically with custom rules.
• For scripted mission have a look at the Lua API.
• If you want to share your maps with the community, upload them at the OpenRA Resource Center.

Modding

• Download a copy of the OpenRA Mod SDK to start your own mod.
• Check the Modding Guide to create your own classic RTS.
• There exists an auto-generated Trait documentation to get started with yaml files.
• Some hints on how to create new OpenRA compatible Pixelart.
• Upload total conversions at our Mod DB profile.

Support

• Sponsor a mirror server if you have some bandwidth to spare.
• You can immediately set up a Dedicated Game Server.

License

Copyright (c) OpenRA Developers and Contributors This file is part of OpenRA, which is free software. It is made available to you under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. For more information, see COPYING.

orabot's Issues

Add OpenRA/ra2 to the GitHub feed

Submissions to https://github.com/OpenRA/ra2 are often overlooked.

Add logging features for moderation

Log editing and deleting messages. (It looks like this is possible: https://top.gg/bot/logger .)

Report recent changes of the GitHub wiki

https://github.com/OpenRA/OpenRA/wiki/

Advertise new maps in #mapmaking

The IRC bot has it.

[21:19] | orabot | New map: Argal by Super Newbie - https://resource.openra.net/maps/34556/

As a link to the resource centre in the same veins as the github notifications.

Desync Diff

When the bot sees desync logs it should not regurgitate them like the exception.log but diff then and display the diff instead.

Add openra github wiki links

such as
�https://github.com/OpenRA/OpenRA/wiki/Mapping
https://github.com/OpenRA/OpenRA/wiki/Creating-a-new-unit

possibly everything git has to offer

maybe put everything under 1 command

[Reminder] Remove unnecessary additional slash in folder code

According to the webserver logs, the code directing to the location of the images sports an additional slash (see log below)
This is totally low priority, everything works as intended, but nevertheless, here is the reminder ;)

13:09:41 45.35.196.58:14140 Requested GET /Icons//github-issue-open.png
13:09:41 45.35.196.58:14140 Fully downloaded - 900 @ 5.1 KB/s - /Icons//github-issue-open.png
13:15:49 45.35.205.46:23712 Requested GET /Icons//github-issue-open.png
13:15:49 45.35.205.46:23712 Fully downloaded - 900 @ 3.0 KB/s - /Icons//github-issue-open.png
13:30:06 172.106.11.86:58280 Requested GET /Icons//github-pr-merged.png
13:30:06 172.106.11.86:58280 Fully downloaded - 730 @ 47.5 KB/s - /Icons//github-pr-merged.png
13:45:14 45.35.198.202:64700 Requested GET /Icons//github-issue-open.png
13:45:15 45.35.198.202:64700 Fully downloaded - 900 @ 1.2 KB/s - /Icons//github-issue-open.png
14:19:03 45.35.196.58:28030 Requested GET /Icons//github-issue-open.png
14:19:03 45.35.196.58:28030 Fully downloaded - 900 @ 54.9 KB/s - /Icons//github-issue-open.png
14:21:23 45.35.205.34:24700 Requested GET /Icons//github-issue-open.png
14:21:23 45.35.205.34:24700 Fully downloaded - 900 @ 2.7 KB/s - /Icons//github-issue-open.png

Player Count command

The IRC bot had it.

]players
[21:32] Waiting (playing) --> RA: 33 (189); TD: 3 (28); D2k: 0 (8); Other: 1 (1)

Although this can certainly be improved upon.

Don't include outcommented placeholder text in embeds

Ignore what's written in <!-- ... --> HTML-style comments that are used in issue and pr templates. It hides all the relevant content.

Add a set of commands to set a temporary channel topic

It was requested that a set of commands be added like ]startTopic <topic> and ]endTopic on which the bot prints out the relevant message, pin it and also updates the channel topic with <main_topic> | <temp_topic> |.

Ignore parsing github issues/PRs/links when wrapped with '<'/'>'

request: command to print location of orabot's source

Making it easier to find the source of this bot via the bot.

When parsing replays, link player names to their forum accounts if applicable

Will use the ORA auth system. Connecting players to their auth identity will make bot-handling of some basic statistics (games, wins) possible, with the potential to implement rankings as well.

Lua stack traces don't trigger

Fatal Lua Error: [string "-- Make copies of global functions to preve..."]:30: Uncaught CLR exception at Lua->CLR boundary: System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation.
 ---> System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation.
 ---> System.NullReferenceException: Object reference not set to an instance of an object.
   at OpenRA.Mods.Common.Scripting.TriggerGlobal.OnObjectiveCompleted(Player player, LuaFunction func) in OpenRA/OpenRA.Mods.Common/Scripting/Global/TriggerGlobal.cs:line 183
   --- End of inner exception stack trace ---
   at System.RuntimeMethodHandle.InvokeMethod(Object target, Span`1& arguments, Signature sig, Boolean constructor, Boolean wrapExceptions)
   at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)
   at OpenRA.Scripting.ScriptMemberWrapper.Invoke(LuaVararg args) in OpenRA/OpenRA.Game/Scripting/ScriptMemberWrapper.cs:line 76
   --- End of inner exception stack trace ---
   at System.RuntimeMethodHandle.InvokeMethod(Object target, Span`1& arguments, Signature sig, Boolean constructor, Boolean wrapExceptions)
   at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)
   at Eluant.LuaRuntime.MethodWrapper.Invoke(Object[] parms)
   at Eluant.LuaRuntime.MakeManagedCall(IntPtr state, MethodWrapper wrapper)
   at Eluant.LuaRuntime.Call(IList`1 args)
   at Eluant.LuaRuntime.Call(LuaFunction fn, IList`1 args)
   at Eluant.LuaFunction.Call(IList`1 args)
   at Eluant.LuaFunction.Call(LuaValue[] args)
   at OpenRA.Scripting.ScriptContext.WorldLoaded() in OpenRA/OpenRA.Game/Scripting/ScriptContext.cs:line 297

It would be great if the bot would detect the inner exception:

---> System.NullReferenceException: Object reference not set to an instance of an object.
at OpenRA.Mods.Common.Scripting.TriggerGlobal.OnObjectiveCompleted(Player player, LuaFunction func) in OpenRA/OpenRA.Mods.Common/Scripting/Global/TriggerGlobal.cs:line 183

and highlight it.

Please use copy pasteable placeholders for the ]supportdir command

https://www.pcgamingwiki.com/wiki/OpenRA#Game_data
https://github.com/OpenRA/OpenRA/wiki/Settings

Documentation Summary

Orabot/Orabot.Core/Modules/OpenRaTraitsModule.cs

Line 69 in 7ab2fa0

Description = "This documentation is aimed at modders. It displays all traits with default values and developer commentary."

is not really helpful. Parse https://docs.openra.net/en/bleed/search/search_index.json instead.

Active games command

The IRC bot had it.

]games
OpenRA Game - 6 - RA @release-0202
EU Official 1 - 3 - TD @release-0202
cyberia layer 02 - 3 - RA @release-0202
|AK47|DEDI|SSD|20Gbps|5| - 3 - RA @release-0202
WorkumGames - 2 - RA @release-0202
NOT a noob server - 2 - RA @release-0202
halgame - 2 - SP @release-0210
EU Official 6 - 2 - RA @release-0202
_MrMadDoc's_Game - 1 - RA @playtest-0303
TSW - 1 - RA @release-0202
Peacemaker - 1 - RA @release-0202
pallimallinen - 1 - RA @release-0202
EU Official 8 - 1 - RA @release-0202
EU Official 4 - 1 - RA @release-0202
EU Official 2 - 1 - RA @release-0202
DOCKER SERVER - 1 - RA @release-0202
|AK47|DEDI|SSD|20Gbps|11 - 1 - RA @release-0202

Although this can probably be improved upon.

Hide OP name and delete OP post when replay is posted

Orb
You know what would be really nice is if there was a way to then access these replays without knowing who uploaded them

jaZz_KCS
Orabot DLs the replay, parses it without mentioning who uploaded it and deletes the original post?

jaZz_KCS
Instead it could say smth like "A new replay has been posted" or whatnot

Add a Youtube/Twitch feed

Apparently Youtube exposes an atom feed for upload notifications: https://developers.google.com/youtube/v3/guides/push_notifications

C# supports reading such feeds. (Random StackOverflow link: https://stackoverflow.com/questions/10399400/best-way-to-read-rss-feed-in-net-using-c-sharp)

Twitch setup seems to be a bit more convoluted at first glance:

• https://dev.twitch.tv/docs/api/webhooks-guide how to get a webhook
• https://dev.twitch.tv/docs/api/webhooks-reference#topic-stream-changed the webhook we need

Use proper /slash commands

https://discordnet.dev/guides/int_basics/application-commands/slash-commands/creating-slash-commands.html

Aggregate new forum posts from RSS

https://forum.openra.net/feed/topics