Describe Bug

when stopping the server, multiple unexpected outcome could occur. these do not seem desirable and are therefore a bug.

To Reproduce

1

1. start the server
2. type stop

$ ./startserver.sh
./startserver.sh: line 6: pypy: command not found
python version ok (3.9.0+)
[02/28/21 15:32:35 INFO]: Query server started on 127.0.1.1:25565.
[02/28/21 15:32:35 INFO]: Loading default worlds for level world...
[02/28/21 15:32:35 INFO]: Loaded default worlds: world, world_nether, world_the_end.
[02/28/21 15:32:35 INFO]: PyMine 0.1 started on 127.0.1.1:25565!
> stop
[02/28/21 15:32:39 INFO]: Closing server...
[02/28/21 15:32:39 INFO]: Server closed.
Exception ignored in: <function DatagramStream.__del__ at 0x7fd4ba6cbd30>
Traceback (most recent call last):
  File "/home/the456gamer/Projects/PyMine/PyMine-server/venv/lib/python3.9/site-packages/asyncio_dgram/aio.py", line 42, in __del__
  File "/usr/lib/python3.9/asyncio/selector_events.py", line 700, in close
  File "/usr/lib/python3.9/asyncio/base_events.py", line 746, in call_soon
  File "/usr/lib/python3.9/asyncio/base_events.py", line 510, in _check_closed
RuntimeError: Event loop is closed
Unhandled error in exception handler
context: {'message': 'Task was destroyed but it is pending!', 'task': <Task pending name='Task-3' coro=<QueryServer.handle() running at /home/the456gamer/Projects/PyMine/PyMine-server/pymine/logic/query.py:141> wait_for=<Future pending cb=[<TaskWakeupMethWrapper object at 0x7fd4b92a8760>()]>>}
Traceback (most recent call last):
  File "/usr/lib/python3.9/asyncio/base_events.py", line 1775, in call_exception_handler
    self._exception_handler(self, context)
  File "/home/the456gamer/Projects/PyMine/PyMine-server/pymine/api/console.py", line 70, in task_exception_handler
    if ctx["exception"]:
KeyError: 'exception'
[02/28/21 15:32:39 ERROR]: Error occurred while handling query packets: 
Traceback (most recent call last):
  File "/usr/lib/python3.9/asyncio/queues.py", line 166, in get
    await getter
GeneratorExit

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/the456gamer/Projects/PyMine/PyMine-server/pymine/logic/query.py", line 141, in handle
    data, remote = await self._server.recv()
  File "/home/the456gamer/Projects/PyMine/PyMine-server/venv/lib/python3.9/site-packages/asyncio_dgram/aio.py", line 106, in recv
    data, addr = await self._recvq.get()
  File "/usr/lib/python3.9/asyncio/queues.py", line 168, in get
    getter.cancel()  # Just in case getter is not done yet.
  File "/usr/lib/python3.9/asyncio/base_events.py", line 746, in call_soon
    self._check_closed()
  File "/usr/lib/python3.9/asyncio/base_events.py", line 510, in _check_closed
    raise RuntimeError('Event loop is closed')
RuntimeError: Event loop is closed

2

1. start the server
2. press ctrl+c
3. observe how server doesnt stop
4. observe how any input is now ignored
5. press ctrl + c again
6. observe how server now stops

$ ./startserver.sh
./startserver.sh: line 6: pypy: command not found
python version ok (3.9.0+)
[02/28/21 15:41:11 INFO]: Query server started on 127.0.1.1:25565.
[02/28/21 15:41:11 INFO]: Loading default worlds for level world...
[02/28/21 15:41:11 INFO]: Loaded default worlds: world, world_nether, world_the_end.
[02/28/21 15:41:11 INFO]: PyMine 0.1 started on 127.0.1.1:25565!
>                                                                                                                                                                                                                                             
exit
stop
stop


aqnjdnijec
fernjvenjov
^C[02/28/21 15:41:36 INFO]: Closing server...
[02/28/21 15:41:36 INFO]: Server closed.

Expected Behavior

For the server to safely stop without errors

Additional Context

$ python3.9 --version
Python 3.9.0+

$ cat /etc/*-release 
       │ File: /etc/lsb-release
   1   │ DISTRIB_ID=Ubuntu
   2   │ DISTRIB_RELEASE=20.04
   3   │ DISTRIB_CODENAME=focal
   4   │ DISTRIB_DESCRIPTION="Ubuntu 20.04.2 LTS"
---
       │ File: /etc/os-release
   1   │ NAME="Ubuntu"
   2   │ VERSION="20.04.2 LTS (Focal Fossa)"
   3   │ ID=ubuntu
   4   │ ID_LIKE=debian
   5   │ PRETTY_NAME="Ubuntu 20.04.2 LTS"
   6   │ VERSION_ID="20.04"
   7   │ HOME_URL="https://www.ubuntu.com/"
   8   │ SUPPORT_URL="https://help.ubuntu.com/"
   9   │ BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
  10   │ PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
  11   │ VERSION_CODENAME=focal
  12   │ UBUNTU_CODENAME=focal

Console should have like two sections, horizontally split. The bottom-most one should be just one row/line and should contain a > and whatever the user is typing. The above section should contain output/logging information. If a user is typing, what they've typed should not be overwritten by any logging/output.

You can see any modern console, such as paper/bukkit/vanilla for how this looks/feels

Due to a bitshift effect, the old implentation of the varint functions leads to very high positive numbers for wanted negative ones. The error occurs in the following line num += 1 + 1 << 32, here you must not add with 1, because otherwise an offset in the negative numbers arises which has a discontinuity point. Besides this problem, the value of the upper limit was also shifted by an offset of +1.

To prove the errors, an extended unittest was implemented which does not find any errors after the fix.

Since testing with pytest without poetry is more convenient, a setup.py was created. Note that the dependencies for runtime are now entered in the setup.py. In the requirenments.txt are now only the dependencies for the developer environment.

The server can be started with python -m pymine. Tests can be performed with python and venv with the command python -m pytest tests.

In general i can recommend to reduce the dependency on poetry and to rework the implentation of varint. Especially I don't think it is useful to calculate min and max all the time, rather implement a function for varint and varlong here.

Greetings jpotyka

Is your feature request related to a problem? Please describe. Need me some hot docstrings.

Describe the solution you'd like Add sphinx-styled descriptive docstrings to all classes/major functions.

Describe alternatives you've considered no❤️ Additional info: https://atom.io/packages/docblock-python

Add a dynamic key: value storage database for plugins to use. This wouldn't be for user configuration, but more plugins sitting persistent info

There should be support for multiple backends, including external And ideally convert between them

Once base packet class is done, start creating all the packets. These packets should go under src/types/packets and should be subclasses of src.types.packet.Packet. For a list of all the packets, look here: https://wiki.vg/Protocol (Important: this link displays the most recent versions protocol, to view a specific version go here)

Packet Making Guide v2

Naming

• Packets are named by their state and name on wiki.vg Examples: class PlayUpdateLight or class HandshakeHandshake or class PlayPlayerPosition

Creation

• Packets should have two class object attributes (id and to), a docstring describing them, an __init__, and the decode or encode method (or both)
• Packets should also subclass a Packet object, and initialize it. Example:

class TestExample(Packet):
  """This is an example packet, not used at all. (Client -> Server AND Server -> Client)

  :param str dummy_payload: The payload of the packet.
  :attr int id: Unique packet ID.
  :attr int to: Packet direction.
  :attr dummy_payload:
  """

  id = 0x00  # ID of the packet, found on wiki.vg in the section where there's info on the packet
  to = 2  # 0=serverbound, 1=clientbound, 2=both be careful when using 2 as many packets are both, but have different IDs

  def __init__(self, dummy_payload: str) -> None:
    super().__init__()

    self.dummy_payload = dummy_payload

  def encode(self) -> bytes:
    return Buffer.pack_string(self.dummy_payload)

  @classmethod
  def decode(cls, buf: Buffer) -> TestExample:
    return cls(buf.unpack_string())

Additional Info:

• Packet docstrings should be generated via the atom plugin docblock-python or another plugin for another editor. They should be in the sphinx format.
• Docstrings, on the first line, should contain the short summary, any additional links/info, and in parentheses the direction(s) of the packet.
• Remember to add the name of the packet to the file's __all__ (located near the top of the file, after imports)
• If you can't find the right file to place your packet, you can create a new one. Remember to import annotations from __future__ to allow for proper typehints, and to add an __all__.

Progress Checklist (By States)

• [x] handshake packets
• [x] status packets
• [x] login packets
• [ ] play packets

Feature

What the title said, there should be something(Maybe a right prompt or bottom toolbar?) displaying current editing mode when vi_mode is enabled. No need for it to have the entire name, I for insert, N for normal, etc.

Reason

It's nice to know which mode you're in so you don't accidentally mess up your command.

Examples

These are screenshots of my fish prompt that could serve as inspiration.

this includes link brackets line breaks to fit to 100chars and adding a .markdownlintrc file

i also commented out the ghprofile view counter, which seemed to have broken

Add two new methodes to registery to be used by plugins.

@on_login_success is equivalent to @on_packet("login", 0x02) and both will get trigger after a successful login with the following args: the associated stream and packet.

@on_join is equivalent to @on_packet("play", 0x24) and both will get trigger after a player fully load into the world with the following args: the associated stream and packet.

Describe Bug

A clear and concise description of what the bug is.

To Reproduce

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected Behavior

A clear and concise description of what you expected to happen.

Screenshots / Proof

If applicable, add screenshots to help explain your problem.

Additional Context

Add any other context about the problem here, including OS, Python version, and other important contextual information.

Feature

• A way to add custom resource pack(s) for the server.
• The resource pack(s) can be optional or required for the player to accept.

Reason

• So that it's convenient for new players to use the resource pack that the server owner wants them to use.

Display argument names and their annotations (if any) for each command.

== help menu ==
test: Documentation missing.
 Arguments:
 - b: Bool
 - f: Float
 - d: Double
 - i: Integer
 - s: str
 - s2: String
 - s3: String

Checkbox in #266

Add a heal and a feed command, for manipulating health and hunger.

Heal

Sets a player's health to any value using the PlayUpdateHealth packet.

Syntax

heal <username> <new_health>

new_health - integer value between 0 - 20

Feed

Sets a player's hunger to any value using the PlayUpdateHealth packet.

Syntax

feed <username> <new_food>

new_food - integer value between 0 - 20

Feature

• Config should be sorted by category(rcon, query, world, etc)->alphabetically, with comments describing each section. Comment can be achieved with ruamel.yaml

Reason

• The config should be mainly self-explanatory to new users. This also stops noob devs like me from spamming petus for help quite as often.

• PyMine should have built-in support for multiple worlds (aside from the default overworld, nether, and end)
• Perhaps there would be a set of commands allowing for the easy management of the worlds.

Reason

• Multi-world plugins tend to be jank or hard to use, PyMine having built in multi-world support would be an excellent addition.