From b6c52810c14048fe55f38032e7440a7b8c44dbce Mon Sep 17 00:00:00 2001
From: sirjonasxx <36828922+sirjonasxx@users.noreply.github.com>
Date: Tue, 20 Oct 2020 12:45:41 +0200
Subject: [PATCH] Created G-Python qtConsole (markdown)

---
 G-Python-qtConsole.md | 56 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 G-Python-qtConsole.md

diff --git a/G-Python-qtConsole.md b/G-Python-qtConsole.md
new file mode 100644
index 0000000..a8bca6e
--- /dev/null
+++ b/G-Python-qtConsole.md
@@ -0,0 +1,56 @@
+## Requirements
+* Understand the G-Python extension interface (https://github.com/sirjonasxx/G-Python)
+* Make sure your python version (`python --version` on commandline) is >= 3.2
+* Execute the following line on commandline: `python -m pip install qtconsole pyqt5 jupyter-console g-python` to install the required packages
+
+## Usage
+1. Go to the "Extra" tab on G-Earth and check the "Enable G-Python Scripting" checkbox
+2. Go to the "Extensions" tab and open a G-Python shell
+
+The shell will automatically do the following things for you:
+* Import all G-Python classes & modules (`Extension`, `Direction`, `HMessage`, `HPacket`, `hparsers`, `htools`)
+* Import the `sleep()` function from the `time` module
+* Initialize a G-Python extension (named `ext`) and connect it to G-Earth
+* Create an interface for all methods of the Extension object (for example: `ext.send_to_server(packet)` can also be executed with just `send_to_server(packet)`)
+
+![G-Python shell extension](https://i.imgur.com/ekOPLYu.png)
+
+### QtConsole shortcuts
+
+Shortcuts:
+* TAB -> Autocomplete
+* SHIFT+TAB -> Show function arguments + docs
+* ENTER -> Execute the entered python script or continue it on the next line, depending on context
+* CTRL+ENTER -> Same as "ENTER", but always continue the current script
+* SHIFT+ENTER -> Same as "ENTER", but always execute
+
+Commands:
+* %quickref -> list of all qtConsole commands
+* %clear -> clears the window
+* %save -> saves specific lines to a file (example: `%save test 4-7`, saves lines 4 to 7 to `test.py`)
+* %load -> loads script from a file (example: `load test`, loads `test.py`)
+
+## Example
+#### Example 1: send all user signs
+
+![example 1](https://i.imgur.com/4kjnPlo.png)
+
+_(hint: to save this script: `%save all_signs 23-24`)_
+
+#### Example 2: wave when typing "wave"
+
+![example 2](https://i.imgur.com/xo6GhOi.png)
+
+_(hint: if you're going to `sleep()` during an `intercept()` callback, create a new thread first, or all incoming/outgoing packet flow will be paused)_
+
+_(hint: in the method signature `def on_speech(message: HMessage)`, `: HMessage` isn't required but makes auto-completion easier)_
+
+#### Example 3: get all room furniture
+
+![example 3](https://i.imgur.com/CJCErDh.png)
+
+#### Example 4: get all room users
+
+![example 4](https://i.imgur.com/b2czJUw.png)
+
+_(prints the list of all HEntities in the room, in which all of them are mapped to their corresponding string representation)_
\ No newline at end of file