{"id":18860103,"url":"https://github.com/endstonemc/python-example-plugin","last_synced_at":"2025-09-06T05:34:19.112Z","repository":{"id":190015501,"uuid":"681211360","full_name":"EndstoneMC/python-example-plugin","owner":"EndstoneMC","description":"Python example plugin for Endstone servers","archived":false,"fork":false,"pushed_at":"2025-02-28T09:24:37.000Z","size":59,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T12:52:32.916Z","etag":null,"topics":["bedrock","bedrock-dedicated-server","minecraft","plugin","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EndstoneMC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-08-21T14:09:12.000Z","updated_at":"2025-02-28T09:24:41.000Z","dependencies_parsed_at":"2024-01-19T03:26:21.168Z","dependency_job_id":"4b2290d0-188a-4a21-b463-af6e29335985","html_url":"https://github.com/EndstoneMC/python-example-plugin","commit_stats":null,"previous_names":["endstonemc/python-plugin-template","endstonemc/python-example-plugin"],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/EndstoneMC/python-example-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EndstoneMC%2Fpython-example-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EndstoneMC%2Fpython-example-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EndstoneMC%2Fpython-example-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EndstoneMC%2Fpython-example-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EndstoneMC","download_url":"https://codeload.github.com/EndstoneMC/python-example-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EndstoneMC%2Fpython-example-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273859038,"owners_count":25180817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bedrock","bedrock-dedicated-server","minecraft","plugin","python"],"created_at":"2024-11-08T04:21:39.109Z","updated_at":"2025-09-06T05:34:19.033Z","avatar_url":"https://github.com/EndstoneMC.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Endstone Python Example Plugin\n\nWelcome to the example Python plugin for Endstone servers.\n\n## Prerequisites\n\n- Python 3.9 or higher.\n- Endstone installed and set up in your Python environment.\n\n## Structure Overview\n\n```\npython-example-plugin/ \n├── src/                         # Main source directory \n│   └── endstone_example/        # Directory for the plugin package \n│       ├── __init__.py          # Initializer for the package, importing ExamplePlugin class from example_plugin.py\n│       ├── example_plugin.py    # Implementation of ExamplePlugin class\n│       └── python_command.py    # Custom command executor for /python\n├── .gitignore                   # Git ignore rules\n├── LICENSE                      # License details\n├── README.md                    # This file\n└── pyproject.toml               # Plugin configuration file which specifies the entrypoint\n```\n\n## Getting Started\n\n1. **Clone this Repository**\n\n   ```bash\n   git clone https://github.com/EndstoneMC/python-example-plugin.git\n   ```\n\n2. **Navigate to the Cloned Directory**\n\n   ```bash\n   cd python-example-plugin\n   ```\n\n3. **Install Your Plugin**\n\n   When developing the plugin, you may want to install an editable package to your Python environment, this allows you\n   to update the codes without having to reinstall the package everytime:\n   ```bash\n   pip install -e .\n   ```\n   **NOTE: It is strongly recommended to create a virtual environment for your Endstone server and plugins. When\n   installing your plugin using `pip install`, please ensure the virtual environment is activated.**\n\n   Ensure your plugin is loaded correctly by checking the server logs or console for the log messages.\n\n4. **Package and Distribute Your Plugin**\n\n   When everything is good to go, you can package your plugin into a `.whl` (Wheel) file for easier distribution:\n\n   ```bash\n   pip install pipx\n   pipx run build --wheel\n   ```\n\n   This command will produce a `.whl` file in the `dist` directory. Copy the `.whl` file to the `plugins` directory\n   of your Endstone server. Start the Endstone server and check the logs to ensure your plugin loads and operates\n   as expected.\n\n   To publish your plugin to a package index such as PyPI, please refer to:\n    - [Using TestPyPI](https://packaging.python.org/en/latest/guides/using-testpypi/)\n    - [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/)\n\n## Documentation\n\nFor a deeper dive into the Endstone API and its functionalities, refer to the main\nEndstone [documentation](https://endstone.readthedocs.io) (WIP).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fendstonemc%2Fpython-example-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fendstonemc%2Fpython-example-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fendstonemc%2Fpython-example-plugin/lists"}