diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..72131c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,164 @@ +src/resources/config.json +src/json_movelist/ +!src/json_movelist/empty.json + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/README.md b/README.md index 5d86a01..aaf7358 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,55 @@ # Heihachi -A discord bot to receive Tekken 8 frame data primary from [wavu.wiki](https://wavu.wiki/t/Wavu:Tekken_8) -## Instruction +A Discord bot to receive Tekken 8 frame data primarily from [Wavu Wiki](https://wavu.wiki/t/Main_Page) -Clone this to a linux server that has Python 3.10.0+ and install the dependencies with: +## Instructions + +Clone this repository to a Linux server that has Python 3.10.0+ and install the dependencies with: + +```bash +git clone git@github.com:TLNBS2405/heihachi.git +cd heihachi +python3 -m pip install -r requirements.txt ``` -pip install -r requirements.txt +### Config + +The Heihachi bot is configured using the `src/resources/config.json` file. A sample file is provided in `src/resources/config.sample.json`. You should copy this file to `src/resources/config.json` and fill in the required fields. + +```json +{ + "DISCORD_TOKEN": "YOUR_DISCORD_TOKEN", + "FEEDBACK_CHANNEL_ID": [feedback_channel_id], + "ACTION_CHANNEL_ID": [action_channel_id] +} ``` +You can obtain your own Discord token by creating a Discord bot ([instructions](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)). -You need your own discord bot ([instructions](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)) and have the tokens in the `src/resources/config.json`. You can add a feedback channel there also. +The `FEEDBACK_CHANNEL_ID` is the channel where the bot will send feedback messages. The bot supports the slash command `/fd feedback ` to allow users to provide feedback on the bot's operation or frame data, and have the bot repost it in a dedicated channel for easier tracking. +![Feedback](/assets/feedback_example.png) -The executable is `src/main.py`. Don't forget to put this project into your PYTHONPATH +The `ACTION_CHANNEL_ID` is the channel where the bot will send "actioned" messages, to indicate whether a particular piece of feedback was actioned by the server owner or not. -## Commands +![Actioned](/assets/actioned_example.png) + +Channel IDs can be obtained by right-clicking on a channel and selecting "Copy Channel ID" at the very bottom. + +### Running the bot + +The executable is `src/main.py`. Don't forget to put this project into your `PYTHONPATH`! + +Execute the below command from the project's root directory - + +```bash +PYTHONPATH=. python3 src/main.py ``` -Slash Command -/fd - get frame data of a move from a character -/ - same as above -``` \ No newline at end of file + +## Commands + +The bot supports the following slash commands - + +| Command | Description | +| --- | --- | +| `/fd ` | Get frame data of a move from a character | +| `/ ` | Same as above | +| `/feedback ` | Send feedback to the bot owner | diff --git a/assets/actioned_example.png b/assets/actioned_example.png new file mode 100644 index 0000000..1c377c5 Binary files /dev/null and b/assets/actioned_example.png differ diff --git a/assets/feedback_example.png b/assets/feedback_example.png new file mode 100644 index 0000000..a1410b1 Binary files /dev/null and b/assets/feedback_example.png differ diff --git a/src/module/embed.py b/src/module/embed.py index 9ba6dbf..b859cdb 100644 --- a/src/module/embed.py +++ b/src/module/embed.py @@ -76,4 +76,4 @@ def move_embed(character: character, move: dict): if move['notes']: embed.add_field(name="Notes", value=move['notes']) - return embed + return embed \ No newline at end of file diff --git a/src/resources/config.json b/src/resources/config.json deleted file mode 100644 index 5fda1a0..0000000 --- a/src/resources/config.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "DISCORD_TOKEN": "", - "FEEDBACK_CHANNEL_ID" : 1 -} diff --git a/src/resources/config.sample.json b/src/resources/config.sample.json new file mode 100644 index 0000000..37b75f0 --- /dev/null +++ b/src/resources/config.sample.json @@ -0,0 +1,5 @@ +{ + "DISCORD_TOKEN": "Your Discord token here (see https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)", + "FEEDBACK_CHANNEL_ID": 0, + "ACTION_CHANNEL_ID": 0 +} diff --git a/src/wavu/test/test_wavu_reader.py b/src/wavu/test/test_wavu_reader.py index 2871d80..7f7044b 100644 --- a/src/wavu/test/test_wavu_reader.py +++ b/src/wavu/test/test_wavu_reader.py @@ -42,12 +42,12 @@ def test_complete_parent_input(self): self.assertEqual(move3.damage,"14,20") self.assertEqual(move4.damage,"10,10,16,23") self.assertEqual(move5.input,"df+1,4,1~2") - self.assertEqual(move6.on_ch,"+27a") + self.assertEqual(move6.on_ch,"[+27a](https://wavu.wiki/t/Azucena_combos#Mini-combos 'Mini-combo')") self.assertEqual(move7.on_hit,"+4~+5") character_movelist = wavu_reader.get_wavu_character_movelist("Bryan") move7 = wavu_reader.get_move("Bryan-4,3,f+4",character_movelist) - self.assertEqual(move7.on_ch,"+31a (+21)") + self.assertEqual(move7.on_ch,"[+31a (+21)](https://wavu.wiki/t/Bryan_combos#Staples 'Combo')") def test_first_parent_input(self): character_movelist = wavu_reader.get_wavu_character_movelist("Azucena") diff --git a/src/wavu/wavu_reader.py b/src/wavu/wavu_reader.py index 0f6472c..7c7dcad 100644 --- a/src/wavu/wavu_reader.py +++ b/src/wavu/wavu_reader.py @@ -136,14 +136,14 @@ def _convert_json_movelist(move_list_json: list) -> List[Move]: move_list_json) + _normalize_data(move["title"]["damage"])) on_block = _remove_html_tags(_normalize_data(move["title"]["block"])) - on_hit = _remove_html_tags(_normalize_data(_normalize_hit_ch_input(move["title"]["hit"]))) - on_ch = _remove_html_tags(_normalize_data(_normalize_hit_ch_input(move["title"]["ch"]))) + on_hit = _remove_html_tags(_normalize_data(_process_links(move["title"]["hit"]))) + on_ch = _remove_html_tags(_normalize_data(_process_links(move["title"]["ch"]))) if not on_ch or on_ch == "": on_ch = on_hit startup = _normalize_data(_get_first_parent_value_of("startup", _normalize_data(move["title"]["id"]) , move_list_json)) recovery = _normalize_data(move["title"]["recv"]) - notes = _remove_html_tags(move["title"]["notes"]) + notes = _remove_html_tags(_process_links(move["title"]["notes"])) move = Move(id, name, input, target, damage, on_block, on_hit, on_ch, startup, recovery, notes, "", alias) move_list.append(move) @@ -154,16 +154,14 @@ def _remove_html_tags(data): result = html.unescape(_normalize_data(data)) result = BeautifulSoup(result, features="lxml").get_text() result = result.replace("* \n", "* ") + result = re.sub(r"(\n)+", "\n", result) + result = result.replace("'''", "") return result - -def _normalize_hit_ch_input(entry: str) -> str: - entry = _empty_value_if_none(entry) - if "|" in entry: - pattern = r'\|([^|]+)\]\]' - match = re.search(pattern, entry) - if match: - return match.group(1) - return entry - else: - return entry +link_replace_pattern = re.compile(r'\[\[(?P[^#]+)#(?P
[^|]+)\|(?P[^|]+)\]\]') +def _process_links(data: str | None) -> str: + def _replace_link(match): + page, section, data = match.group('page'), match.group('section'), match.group('data') + hover_text = 'Combo' if section == 'Staples' else 'Mini-combo' + return f"[{data}](https://wavu.wiki/t/{page.replace(' ', '_')}#{section} \'{hover_text}\')" + return link_replace_pattern.sub(_replace_link, _empty_value_if_none(data))