SkyTemple/skytemple-eventserver
1
0
Fork 0
mirror of https://github.com/SkyTemple/skytemple-eventserver.git synced 2026-03-27 09:16:23 +00:00
Code Issues Projects Releases Packages Wiki Activity
Websocket server that emits SkyTemple UI events
21 commits 6 branches 3 tags 104 KiB
  • Python 100%
Find a file
Exact
dependabot[bot] 15393553be
 Bump actions/upload-artifact from 3 to 4 (#7) 
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-12-14 02:30:15 +01:00
.github Bump actions/upload-artifact from 3 to 4 (#7) 2024-12-14 02:30:15 +01:00
skytemple_eventserver Compatibility for logger 2023-09-17 12:26:44 +02:00
.gitignore SkyTemple Eventserver 2020-12-04 15:09:32 +01:00
LICENSE SkyTemple Eventserver 2020-12-04 15:09:32 +01:00
README.rst Small adjustments, Python 3.10 support 2022-02-14 12:40:04 +01:00
setup.py Compatibility with SkyTemple 1.6 2023-09-17 12:21:47 +02:00

README.rst 

|logo|

SkyTemple Eventserver
=====================

|build| |pypi-version| |pypi-downloads| |pypi-license| |pypi-pyversions| |discord|

.. |logo| image:: https://raw.githubusercontent.com/SkyTemple/skytemple/master/skytemple/data/icons/hicolor/256x256/apps/skytemple.png

.. |build| image:: https://img.shields.io/github/workflow/status/SkyTemple/skytemple-eventserver/Build,%20test%20and%20publish
    :target: https://pypi.org/project/skytemple-eventserver/
    :alt: Build Status

.. |pypi-version| image:: https://img.shields.io/pypi/v/skytemple-eventserver
    :target: https://pypi.org/project/skytemple-eventserver/
    :alt: Version

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/skytemple-eventserver
    :target: https://pypi.org/project/skytemple-eventserver/
    :alt: Downloads

.. |pypi-license| image:: https://img.shields.io/pypi/l/skytemple-eventserver
    :alt: License (GPLv3)

.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/skytemple-eventserver
    :alt: Supported Python versions

.. |discord| image:: https://img.shields.io/discord/710190644152369162?label=Discord
    :target: https://discord.gg/skytemple
    :alt: Discord

.. |kofi| image:: https://www.ko-fi.com/img/githubbutton_sm.svg
    :target: https://ko-fi.com/I2I81E5KH
    :alt: Ko-Fi

Websocket server that emits all of the events of SkyTemples event system via JSON to all connected clients.

Listens on port 45546.

All events are emitted using the following JSON object:

- ``event``: Name of the event
- ``args``: All positional arguments passed with the event (as an array).
- ``kwargs``: All keyword arguments passed with the event (as an object).

As of writing there is no documentation on which events exist yet, but if there is in the
future, you will find it in the main SkyTemple repository, most likely inside the "docs"
subdirectory.

|kofi|