Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wu-vincent committed May 14, 2024
1 parent 5fdfed5 commit 44dd3ec
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,15 @@ python-example-plugin/
When everything is good to go, you can package your plugin into a `.whl` (Wheel) file for easier distribution:

```bash
pip install wheel
python -m pip wheel . --no-deps --wheel-dir=wheelhouse
pip install pipx
pipx run build --wheel
```

This command will produce a `.whl` file in the `wheelhouse` directory which can be installed. To publish your plugin
to a package index such as PyPI, please refer to:
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/)

Expand Down
1 change: 0 additions & 1 deletion src/endstone_example/example_plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ def on_disable(self) -> None:

def on_command(self, sender: CommandSender, command: Command, args: list[str]) -> bool:
# You can also handle commands here instead of setting an executor in on_enable if you prefer

match command.name:
case "test":
if len(args) > 0:
Expand Down

0 comments on commit 44dd3ec

Please sign in to comment.