Skip to content

Commit 44dd3ec

Browse files
committed
docs: update README.md
1 parent 5fdfed5 commit 44dd3ec

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,15 @@ python-example-plugin/
5353
When everything is good to go, you can package your plugin into a `.whl` (Wheel) file for easier distribution:
5454

5555
```bash
56-
pip install wheel
57-
python -m pip wheel . --no-deps --wheel-dir=wheelhouse
56+
pip install pipx
57+
pipx run build --wheel
5858
```
5959

60-
This command will produce a `.whl` file in the `wheelhouse` directory which can be installed. To publish your plugin
61-
to a package index such as PyPI, please refer to:
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:
6265
- [Using TestPyPI](https://packaging.python.org/en/latest/guides/using-testpypi/)
6366
- [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/)
6467

src/endstone_example/example_plugin.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ def on_disable(self) -> None:
8282

8383
def on_command(self, sender: CommandSender, command: Command, args: list[str]) -> bool:
8484
# You can also handle commands here instead of setting an executor in on_enable if you prefer
85-
8685
match command.name:
8786
case "test":
8887
if len(args) > 0:

0 commit comments

Comments
 (0)