endstone-chat-triggers 1.0.1__tar.gz

endstone_chat_triggers-1.0.1/.github/workflows/main.yml

@@ -0,0 +1,29 @@
+name: Auto Release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - run: python3 -m pip install --user pipx
+
+      - name: Build wheel
+        run: pipx run build --wheel
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
+          files: dist/*.whl

endstone_chat_triggers-1.0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

endstone_chat_triggers-1.0.1/.gitignore

@@ -0,0 +1,7 @@
+.venv
+.idea
+**__pycache__/
+bedrock_server
+.devcontainer
+dist/
+.cache

endstone_chat_triggers-1.0.1/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>

endstone_chat_triggers-1.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: endstone-chat-triggers
+Version: 1.0.1
+Summary: A plugin for streamers!! Handles live events and such
+Author: MakiTazo
+Author-email: niko-at-chalupa <nikolekrescendo@protonmail.com>
+License-File: LICENSE
+Requires-Dist: endstone
+Requires-Dist: pydantic
+Requires-Dist: python-socketio
+Requires-Dist: rich
+Requires-Dist: ruamel-yaml
+Requires-Dist: twitchapi
+Requires-Dist: websocket-client
+Description-Content-Type: text/markdown
+
+<div align="center">
+<img src="images/chattriggers.png" alt="chat triggers" />
+</div>
+
+---
+
+> "A mod for twitch streamers. Handles live events with the rules handcrafted by the streamer!"
+
+The full documentation can be found Documentation [here](https://niko-at-chalupa.github.io/endstone-chat-triggers/)
+
+# Features
+
+> <h3> 
+> - A lot of events!!
+> </h3>
+>
+> The plugin's able to respond to a wide variety of events! Donations, follows, subscriptions, resubs, bits...
+
+> <h3> 
+> - An easy way to bind to events
+> </h3>
+>
+> Implements _workflows_, which are an easy way to have commands be ran upon an event.
+> ```yaml
+># The name of the workflow. It can be anything.
+>name: Give Chalupa7235 Diamonds on Follow
+>
+># Events that trigger this workflow
+>event: 
+>  # You can have more workflows if you'd like, and 
+>  # they'd all trigger this workflow.
+>  - TwitchFollowEvent
+>
+># Commands that run before the workflow. If one of
+># these commands succeed or fail unexpectedly,
+># then it skips over the main steps. Optional.
+>conditions:
+>  # You can add more, if you'd like. The format
+>  # is <command>: <succcess/fail>, wherein `false`
+>  # means you're expecting it to fail and `true`
+>  # means you're expecting it to succeed.
+>  - testfor Chalupa7235: true
+>
+># If conditions succeed (or you don't have any),
+># then these commands here run.
+>steps:
+>  - "give Chalupa7235 diamond 64"
+>  # ...you can add more if you'd like
+>
+># If conditions fail, then the commands here run.
+>fail_steps:
+>  - "say Chalupa7235 isn't in the server!"
+>  # ...you can add more if you'd like
+> ```
+
+> <h3> 
+> - A plugin API so external plugins can interact.
+> </h3>
+>
+> Other plugins can interact with ChatTriggers, which means you're not limited to workflows.
+> ```py
+>from endstone_twitch_spawn import (
+>    get_chat_triggers_api, 
+>    TwitchFollowEvent, 
+>    streamlabs_event_handler, 
+>    ChatTriggersApi
+>)
+>from endstone.plugin import Plugin
+>
+>class ExamplePlugin(Plugin):
+>    def on_enable(self):
+>        # This will get the plugin, and then the 
+>        # plugin's API.
+>        api: ChatTriggersApi | None = get_chat_triggers_api(self.server.plugin_manager)
+>
+>        # Since we're doing everything right, there
+>        # is little-to-no reason that this should 
+>        # return None.
+>        assert api, "`get_chat_triggers_api` returned `None`"
+>        self.api: TwitchSpawnApi = api
+>        
+>        # Just like Endstone's register_events, you
+>        # can make a sperate listener class in a
+>        # different module to make >everything cleaner.
+>        self.api.register_events(self)
+>
+>    @streamlabs_event_handler
+>    def on_twitch_follow(self, event: TwitchFollowEvent):
+>        # Simple test log so you can see that the 
+>        # plugin's API is funcitonal.
+>        self.logger.info("Somebody followed!!")
+> ```

endstone_chat_triggers-1.0.1/README.md

@@ -0,0 +1,92 @@
+<div align="center">
+<img src="images/chattriggers.png" alt="chat triggers" />
+</div>
+
+---
+
+> "A mod for twitch streamers. Handles live events with the rules handcrafted by the streamer!"
+
+The full documentation can be found Documentation [here](https://niko-at-chalupa.github.io/endstone-chat-triggers/)
+
+# Features
+
+> <h3> 
+> - A lot of events!!
+> </h3>
+>
+> The plugin's able to respond to a wide variety of events! Donations, follows, subscriptions, resubs, bits...
+
+> <h3> 
+> - An easy way to bind to events
+> </h3>
+>
+> Implements _workflows_, which are an easy way to have commands be ran upon an event.
+> ```yaml
+># The name of the workflow. It can be anything.
+>name: Give Chalupa7235 Diamonds on Follow
+>
+># Events that trigger this workflow
+>event: 
+>  # You can have more workflows if you'd like, and 
+>  # they'd all trigger this workflow.
+>  - TwitchFollowEvent
+>
+># Commands that run before the workflow. If one of
+># these commands succeed or fail unexpectedly,
+># then it skips over the main steps. Optional.
+>conditions:
+>  # You can add more, if you'd like. The format
+>  # is <command>: <succcess/fail>, wherein `false`
+>  # means you're expecting it to fail and `true`
+>  # means you're expecting it to succeed.
+>  - testfor Chalupa7235: true
+>
+># If conditions succeed (or you don't have any),
+># then these commands here run.
+>steps:
+>  - "give Chalupa7235 diamond 64"
+>  # ...you can add more if you'd like
+>
+># If conditions fail, then the commands here run.
+>fail_steps:
+>  - "say Chalupa7235 isn't in the server!"
+>  # ...you can add more if you'd like
+> ```
+
+> <h3> 
+> - A plugin API so external plugins can interact.
+> </h3>
+>
+> Other plugins can interact with ChatTriggers, which means you're not limited to workflows.
+> ```py
+>from endstone_twitch_spawn import (
+>    get_chat_triggers_api, 
+>    TwitchFollowEvent, 
+>    streamlabs_event_handler, 
+>    ChatTriggersApi
+>)
+>from endstone.plugin import Plugin
+>
+>class ExamplePlugin(Plugin):
+>    def on_enable(self):
+>        # This will get the plugin, and then the 
+>        # plugin's API.
+>        api: ChatTriggersApi | None = get_chat_triggers_api(self.server.plugin_manager)
+>
+>        # Since we're doing everything right, there
+>        # is little-to-no reason that this should 
+>        # return None.
+>        assert api, "`get_chat_triggers_api` returned `None`"
+>        self.api: TwitchSpawnApi = api
+>        
+>        # Just like Endstone's register_events, you
+>        # can make a sperate listener class in a
+>        # different module to make >everything cleaner.
+>        self.api.register_events(self)
+>
+>    @streamlabs_event_handler
+>    def on_twitch_follow(self, event: TwitchFollowEvent):
+>        # Simple test log so you can see that the 
+>        # plugin's API is funcitonal.
+>        self.logger.info("Somebody followed!!")
+> ```

endstone_chat_triggers-1.0.1/docs/fonts/Xanh_Mono/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The XanhMono Project Authors (https://github.com/yellow-type-foundry/xanhmono).
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

endstone_chat_triggers-1.0.1/docs/index.md

@@ -0,0 +1,147 @@
+![chat triggers](assets/images/chattriggers.png)
+
+<div class="animated-header-wrap">
+  <h2>ChatTriggers is an <a href="https://endstone.dev/stable/" target="blank">Endstone</a> plugin that <span class="highlight">integrates with your live streams and has things trigger based off of different events</span>.</h4>
+</div>
+
+---
+
+!!! quote "[TwitchSpawn](https://www.curseforge.com/minecraft/mc-mods/twitchspawn)"
+    "A mod for twitch streamers. Handles live events with the rules handcrafted by the streamer!"
+
+## Features
+> <div class="animated-header-wrap">
+>   <h4>An <span class="highlight">easy way</span> to bind to events</h4>
+> </div>
+>
+>
+> Implements _workflows_, which are an easy way to have commands be ran upon an event.
+>
+> ```yaml
+> # Small example of a basic workflow.
+>
+> # The name of the workflow. It can be anything.
+> name: Give Chalupa7235 Diamonds on Follow
+>
+> # Events that trigger this workflow
+> event: 
+>   # You can have more workflows if you'd like, and 
+>   # they'd all trigger this workflow.
+>   - TwitchFollowEvent
+>
+> # Commands that run before the workflow. If one of
+> # these commands succeed or fail unexpectedly,
+> # then it skips over the main steps. Optional.
+> conditions:
+>   # You can add more, if you'd like. The format
+>   # is <command>: <succcess/fail>, wherein `false`
+>   # means you're expecting it to fail and `true`
+>   # means you're expecting it to succeed.
+>   - testfor Chalupa7235: true
+>
+> # If conditions succeed (or you don't have any),
+> # then these commands here run.
+> steps:
+>   - "give Chalupa7235 diamond 64"
+>   # ...you can add more if you'd like
+>
+> # If conditions fail, then the commands here run.
+> fail_steps:
+>   - "say Chalupa7235 isn't in the server!"
+>   # ...you can add more if you'd like
+> ```
+
+<!-- -->
+
+> <div class="animated-header-wrap">
+>   <h4>A <span class="highlight">lot</span> of events</h4>
+> </div>
+>
+> The plugin's able to respond to a wide variety of events! Donations, follows, subscriptions, resubs, bits...
+
+<!-- -->
+
+> <div class="animated-header-wrap">
+>   <h4>A plugin API <span class="highlight">so other plugins can interact</span></h4>
+> </div>
+>
+> Other plugins can interact with ChatTriggers, which means you're not limited to workflows.
+>
+> ```python
+> from endstone_twitch_spawn import (
+>     get_chat_triggers_api, 
+>     TwitchFollowEvent, 
+>     streamlabs_event_handler, 
+>     ChatTriggersApi
+> )
+> from endstone.plugin import Plugin
+>
+> class ExamplePlugin(Plugin):
+>     def on_enable(self):
+>         # This will get the plugin, and then the 
+>         # plugin's API.
+>         api: ChatTriggersApi | None = get_chat_triggers_api(self.server.plugin_manager)
+>
+>         # Since we're doing everything right, there
+>         # is little-to-no reason that this should 
+>         # return None.
+>         assert api, "`get_chat_triggers_api` returned `None`"
+>         self.api: TwitchSpawnApi = api
+>         
+>         # Just like Endstone's register_events, you
+>         # can make a sperate listener class in a
+>         # different module to make >everything cleaner.
+>         self.api.register_events(self)
+>
+>     @streamlabs_event_handler
+>     def on_twitch_follow(self, event: TwitchFollowEvent):
+>         # Simple test log so you can see that the 
+>         # plugin's API is funcitonal.
+>         self.logger.info("Somebody followed!!")
+> ```
+
+<!-- -->
+
+> <div class="animated-header-wrap">
+>   <h4><span class="highlight">Detailed</span> error logging</h4>
+> </div>
+>
+> Catch errors in your workflows _before_ they get the chance to mess anything up.
+>
+> ```log
+> [11:37:10 ERROR]: [ChatTriggers] error[E000]: invalid_workflow_file
+> [11:37:10 ERROR]: [ChatTriggers]  --> workflows/empty.yaml:1
+> [11:37:10 ERROR]: [ChatTriggers]   | ^ (source unavailable) — Workflow YAML file is empty
+> [11:37:10 ERROR]: [ChatTriggers] 
+> [11:37:10 ERROR]: [ChatTriggers] 1 error emitted
+> [11:37:10 ERROR]: [ChatTriggers] error[E001]: missing_workflow_name
+> [11:37:10 ERROR]: [ChatTriggers]  --> workflows/workflow_without_a_name.yaml:1
+> [11:37:10 ERROR]: [ChatTriggers] 1 | event: 
+> [11:37:10 ERROR]: [ChatTriggers]   | ^^^^^^ Add a 'name' field at the root of your YAML mapping.
+> [11:37:10 ERROR]: [ChatTriggers] 
+> [11:37:10 ERROR]: [ChatTriggers] 1 error emitted
+> [11:37:10 WARNING]: [ChatTriggers] warning[W012]: no_trigger_events
+> [11:37:10 WARNING]: [ChatTriggers]  --> workflows/no_events.yaml:1
+> [11:37:10 WARNING]: [ChatTriggers] 1 | name: Workflow With No Events
+> [11:37:10 WARNING]: [ChatTriggers]   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Without an 'event', this workflow will never be triggered.
+> [11:37:10 WARNING]: [ChatTriggers] 
+> [11:37:10 WARNING]: [ChatTriggers] 1 warning emitted
+> ```
+>
+> ![Minecraft screenshot depicting logs in-game](assets/images/screenshot-logging.png)
+
+<br />
+
+# Start
+<div class="grid cards" markdown>
+
+-   **Install ChatTriggers On Your Endstone Server**
+  
+    ---
+  
+    Follow the short guide to install and configure ChatTriggers on your Endstone server.
+  
+    [**:octicons-arrow-right-24: Getting Started**](getting-started/installation.md)
+  
+</div>
+