Skip to content

Commit 16067d6

Browse files
FTS427FTS427
authored
Initial commit
0 parents  commit 16067d6

10 files changed

+497
-0
lines changed

‎.github/workflows/build.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# This workflow will install Python dependencies and run tests with a variety of Python versions
2+
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
3+
4+
name: Build
5+
6+
on:
7+
push:
8+
branches: [ "main" ]
9+
pull_request:
10+
branches: [ "main" ]
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
python-version: [ "3.9", "3.10", "3.11", "3.12" ]
19+
20+
steps:
21+
- name: Checkout Code
22+
uses: actions/checkout@v4
23+
24+
- name: Set up Python ${{ matrix.python-version }}
25+
uses: actions/setup-python@v5
26+
with:
27+
python-version: ${{ matrix.python-version }}
28+
29+
- name: Install
30+
run: |
31+
python -m pip install --upgrade pip
32+
pip install .

‎.github/workflows/publish.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# This workflow will publish a Python Package to PyPI when a release is created
2+
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3+
4+
name: Publish
5+
6+
on:
7+
release:
8+
types: [ published ]
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
publish:
15+
if: github.repository == 'EndstoneMC/python-plugin-template'
16+
runs-on: ubuntu-latest
17+
environment: pypi
18+
permissions:
19+
id-token: write
20+
contents: write
21+
steps:
22+
- name: Checkout Code
23+
uses: actions/checkout@v4
24+
25+
- name: Build sdist
26+
run: pipx run build --sdist
27+
28+
- name: Publish to PyPI
29+
uses: pypa/gh-action-pypi-publish@release/v1

‎.gitignore

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
.idea/
161+
162+
# Wheels
163+
wheelhouse/

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Endstone
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Endstone Python Example Plugin
2+
3+
Welcome to the example Python plugin for Endstone servers.
4+
5+
## Prerequisites
6+
7+
- Python 3.9 or higher.
8+
- Endstone installed and set up in your Python environment.
9+
10+
## Structure Overview
11+
12+
```
13+
python-example-plugin/
14+
├── src/ # Main source directory
15+
│ └── endstone_example/ # Directory for the plugin package
16+
│ ├── __init__.py # Initializer for the package, importing ExamplePlugin class from example_plugin.py
17+
│ ├── example_plugin.py # Implementation of ExamplePlugin class
18+
│ └── python_command.py # Custom command executor for /python
19+
├── .gitignore # Git ignore rules
20+
├── LICENSE # License details
21+
├── README.md # This file
22+
└── pyproject.toml # Plugin configuration file which specifies the entrypoint
23+
```
24+
25+
## Getting Started
26+
27+
1. **Clone this Repository**
28+
29+
```bash
30+
git clone https://github.com/EndstoneMC/python-example-plugin.git
31+
```
32+
33+
2. **Navigate to the Cloned Directory**
34+
35+
```bash
36+
cd python-example-plugin
37+
```
38+
39+
3. **Install Your Plugin**
40+
41+
When developing the plugin, you may want to install an editable package to your Python environment, this allows you
42+
to update the codes without having to reinstall the package everytime:
43+
```bash
44+
pip install -e .
45+
```
46+
**NOTE: It is strongly recommended to create a virtual environment for your Endstone server and plugins. When
47+
installing your plugin using `pip install`, please ensure the virtual environment is activated.**
48+
49+
Ensure your plugin is loaded correctly by checking the server logs or console for the log messages.
50+
51+
4. **Package and Distribute Your Plugin**
52+
53+
When everything is good to go, you can package your plugin into a `.whl` (Wheel) file for easier distribution:
54+
55+
```bash
56+
pip install pipx
57+
pipx run build --wheel
58+
```
59+
60+
This command will produce a `.whl` file in the `dist` directory. Copy the `.whl` file to the `plugins` directory
61+
of your Endstone server. Start the Endstone server and check the logs to ensure your plugin loads and operates
62+
as expected.
63+
64+
To publish your plugin to a package index such as PyPI, please refer to:
65+
- [Using TestPyPI](https://packaging.python.org/en/latest/guides/using-testpypi/)
66+
- [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/)
67+
68+
## Documentation
69+
70+
For a deeper dive into the Endstone API and its functionalities, refer to the main
71+
Endstone [documentation](https://endstone.readthedocs.io) (WIP).
72+
73+
## License
74+
75+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

‎pyproject.toml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[build-system]
2+
requires = ["hatchling"]
3+
build-backend = "hatchling.build"
4+
5+
[project]
6+
name = "endstone-example"
7+
version = "0.4.0"
8+
dependencies = []
9+
authors = [
10+
{ name = "Endstone Developers", email = "[email protected]" },
11+
]
12+
description = "Python example plugin for Endstone servers"
13+
readme = "README.md"
14+
license = { file = "LICENSE" }
15+
keywords = ["endstone", "plugin"]
16+
17+
[project.urls]
18+
Homepage = "https://github.com/EndstoneMC/python-example-plugin"
19+
20+
[project.entry-points."endstone"]
21+
example = "endstone_example:ExamplePlugin"

‎src/endstone_example/__init__.py

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from endstone_example.example_plugin import ExamplePlugin
2+
3+
__all__ = ["ExamplePlugin"]

‎src/endstone_example/example_listener.py

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import datetime
2+
3+
from endstone import ColorFormat
4+
from endstone.event import event_handler, EventPriority, PlayerJoinEvent, PlayerQuitEvent, ServerListPingEvent
5+
from endstone.plugin import Plugin
6+
7+
8+
class ExampleListener:
9+
def __init__(self, plugin: Plugin):
10+
self._plugin = plugin
11+
12+
@event_handler(priority=EventPriority.HIGHEST)
13+
def on_server_list_ping(self, event: ServerListPingEvent):
14+
event.motd = ColorFormat.BOLD + ColorFormat.AQUA + datetime.datetime.now().strftime("%c")
15+
event.level_name = f"Your IP is {ColorFormat.YELLOW}{event.remote_host}:{event.remote_port}{ColorFormat.RESET}"
16+
17+
@event_handler
18+
def on_player_join(self, event: PlayerJoinEvent):
19+
player = event.player
20+
self._plugin.logger.info(
21+
ColorFormat.YELLOW + f"{player.name}[/{player.address}] joined the game with UUID {player.unique_id}"
22+
)
23+
24+
# example of explicitly removing one's permission of using /me command
25+
player.add_attachment(self._plugin, "minecraft.command.me", False)
26+
player.update_commands() # don't forget to resend the commands
27+
28+
@event_handler
29+
def on_player_quit(self, event: PlayerQuitEvent):
30+
player = event.player
31+
self._plugin.logger.info(ColorFormat.YELLOW + f"{player.name}[/{player.address}] left the game.")

0 commit comments

Comments
 (0)