Initial commit

.github/workflows/build.yml

@@ -0,0 +1,32 @@
+# This workflow will install Python dependencies and run tests with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Build
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install .

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+# This workflow will publish 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
+
+name: Publish
+
+on:
+  release:
+    types: [ published ]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    if: github.repository == 'EndstoneMC/python-plugin-template'
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -0,0 +1,163 @@
+# 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/
+
+# Wheels
+wheelhouse/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Endstone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

README.md

@@ -0,0 +1,75 @@
+# Endstone Python Example Plugin
+
+Welcome to the example Python plugin for Endstone servers.
+
+## Prerequisites
+
+- Python 3.9 or higher.
+- Endstone installed and set up in your Python environment.
+
+## Structure Overview
+
+```
+python-example-plugin/ 
+├── src/                         # Main source directory 
+│   └── endstone_example/        # Directory for the plugin package 
+│       ├── __init__.py          # Initializer for the package, importing ExamplePlugin class from example_plugin.py
+│       ├── example_plugin.py    # Implementation of ExamplePlugin class
+│       └── python_command.py    # Custom command executor for /python
+├── .gitignore                   # Git ignore rules
+├── LICENSE                      # License details
+├── README.md                    # This file
+└── pyproject.toml               # Plugin configuration file which specifies the entrypoint
+```
+
+## Getting Started
+
+1. **Clone this Repository**
+
+   ```bash
+   git clone https://github.com/EndstoneMC/python-example-plugin.git
+   ```
+
+2. **Navigate to the Cloned Directory**
+
+   ```bash
+   cd python-example-plugin
+   ```
+
+3. **Install Your Plugin**
+
+   When developing the plugin, you may want to install an editable package to your Python environment, this allows you
+   to update the codes without having to reinstall the package everytime:
+   ```bash
+   pip install -e .
+   ```
+   **NOTE: It is strongly recommended to create a virtual environment for your Endstone server and plugins. When
+   installing your plugin using `pip install`, please ensure the virtual environment is activated.**
+
+   Ensure your plugin is loaded correctly by checking the server logs or console for the log messages.
+
+4. **Package and Distribute Your Plugin**
+
+   When everything is good to go, you can package your plugin into a `.whl` (Wheel) file for easier distribution:
+
+   ```bash
+   pip install pipx
+   pipx run build --wheel
+   ```
+
+   This command will produce a `.whl` file in the `dist` directory. Copy the `.whl` file to the `plugins` directory
+   of your Endstone server. Start the Endstone server and check the logs to ensure your plugin loads and operates
+   as expected.
+
+   To publish your plugin to a package index such as PyPI, please refer to:
+    - [Using TestPyPI](https://packaging.python.org/en/latest/guides/using-testpypi/)
+    - [Publishing package distribution releases using GitHub Actions CI/CD workflows](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/)
+
+## Documentation
+
+For a deeper dive into the Endstone API and its functionalities, refer to the main
+Endstone [documentation](https://endstone.readthedocs.io) (WIP).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "endstone-example"
+version = "0.4.0"
+dependencies = []
+authors = [
+    { name = "Endstone Developers", email = "[email protected]" },
+]
+description = "Python example plugin for Endstone servers"
+readme = "README.md"
+license = { file = "LICENSE" }
+keywords = ["endstone", "plugin"]
+
+[project.urls]
+Homepage = "https://github.com/EndstoneMC/python-example-plugin"
+
+[project.entry-points."endstone"]
+example = "endstone_example:ExamplePlugin"

src/endstone_example/__init__.py

@@ -0,0 +1,3 @@
+from endstone_example.example_plugin import ExamplePlugin
+
+__all__ = ["ExamplePlugin"]

src/endstone_example/example_listener.py

@@ -0,0 +1,31 @@
+import datetime
+
+from endstone import ColorFormat
+from endstone.event import event_handler, EventPriority, PlayerJoinEvent, PlayerQuitEvent, ServerListPingEvent
+from endstone.plugin import Plugin
+
+
+class ExampleListener:
+    def __init__(self, plugin: Plugin):
+        self._plugin = plugin
+
+    @event_handler(priority=EventPriority.HIGHEST)
+    def on_server_list_ping(self, event: ServerListPingEvent):
+        event.motd = ColorFormat.BOLD + ColorFormat.AQUA + datetime.datetime.now().strftime("%c")
+        event.level_name = f"Your IP is {ColorFormat.YELLOW}{event.remote_host}:{event.remote_port}{ColorFormat.RESET}"
+
+    @event_handler
+    def on_player_join(self, event: PlayerJoinEvent):
+        player = event.player
+        self._plugin.logger.info(
+            ColorFormat.YELLOW + f"{player.name}[/{player.address}] joined the game with UUID {player.unique_id}"
+        )
+
+        # example of explicitly removing one's permission of using /me command
+        player.add_attachment(self._plugin, "minecraft.command.me", False)
+        player.update_commands()  # don't forget to resend the commands
+
+    @event_handler
+    def on_player_quit(self, event: PlayerQuitEvent):
+        player = event.player
+        self._plugin.logger.info(ColorFormat.YELLOW + f"{player.name}[/{player.address}] left the game.")