hexdoc-hexdebug 0.1.0.1.0.dev0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- gradle.properties +17 -0
- hexdoc_hexdebug/__gradle_version__.py +14 -0
- hexdoc_hexdebug/__init__.py +0 -0
- hexdoc_hexdebug/__version__.py +4 -0
- hexdoc_hexdebug/_export/.gitignore +2 -0
- hexdoc_hexdebug/_export/__init__.py +0 -0
- hexdoc_hexdebug/_export/generated/__init__.py +2 -0
- hexdoc_hexdebug/_export/generated/assets/hexcasting/lang/en_us.flatten.json5 +1 -0
- hexdoc_hexdebug/_export/generated/assets/hexcasting/patchouli_books/thehexbook/en_us/entries/items/debugging.json5 +14 -0
- hexdoc_hexdebug/_export/generated/assets/hexcasting/patchouli_books/thehexbook/en_us/entries/patterns/debugging.json5 +27 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/lang/en_us.flatten.json5 +1 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/continue/active.json +7 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/continue/inactive.json +6 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/continue/waiting_for_client.json +7 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/in/active.json +7 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/in/inactive.json +6 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/in/waiting_for_client.json +7 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/over/active.json +7 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/over/inactive.json +6 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/over/waiting_for_client.json +7 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger.json +88 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/state/active.png +0 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/state/waiting_for_client.png +0 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/continue.png +0 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/in.png +0 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/out.png +0 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/over.png +0 -0
- hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger.png +0 -0
- hexdoc_hexdebug/_export/generated/hexdebug.hexdoc.json +1 -0
- hexdoc_hexdebug/_export/generated/hexdebug.patterns.hexdoc.json +1 -0
- hexdoc_hexdebug/_hooks.py +57 -0
- hexdoc_hexdebug/_templates/__init__.py +0 -0
- hexdoc_hexdebug/py.typed +0 -0
- hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/METADATA +74 -0
- hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/RECORD +38 -0
- hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/WHEEL +4 -0
- hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/entry_points.txt +2 -0
- hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/licenses/LICENSE +21 -0
gradle.properties
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# non-minecraft values
|
|
2
|
+
org.gradle.jvmargs=-Xmx2048M
|
|
3
|
+
jetbrainsAnnotationsVersion=23.0.0
|
|
4
|
+
|
|
5
|
+
# gradle kotlin jvm plugin breaks without this
|
|
6
|
+
kotlin.stdlib.default.dependency=false
|
|
7
|
+
|
|
8
|
+
# mod info
|
|
9
|
+
modId=hexdebug
|
|
10
|
+
modVersion=0.1.0
|
|
11
|
+
mavenGroup=gay.object.hexdebug
|
|
12
|
+
|
|
13
|
+
# publishing
|
|
14
|
+
curseforgeId=
|
|
15
|
+
modrinthId=
|
|
16
|
+
|
|
17
|
+
enabledPlatforms=fabric,forge
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# This file is auto-generated by hatch-gradle-version. Do not edit.
|
|
2
|
+
|
|
3
|
+
GRADLE_VERSION = "0.1.0"
|
|
4
|
+
FULL_VERSION = "0.1.0.1.0.dev0"
|
|
5
|
+
|
|
6
|
+
CURSEFORGE_ID = ""
|
|
7
|
+
ENABLED_PLATFORMS = "fabric,forge"
|
|
8
|
+
JETBRAINS_ANNOTATIONS_VERSION = "23.0.0"
|
|
9
|
+
KOTLIN_STDLIB_DEFAULT_DEPENDENCY = "false"
|
|
10
|
+
MAVEN_GROUP = "gay.object.hexdebug"
|
|
11
|
+
MOD_ID = "hexdebug"
|
|
12
|
+
MOD_VERSION = "0.1.0"
|
|
13
|
+
MODRINTH_ID = ""
|
|
14
|
+
ORG_GRADLE_JVMARGS = "-Xmx2048M"
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"hexdoc.hexdebug.title": "HexDebug Book", "hexdoc.hexdebug.description": "The HexDebug Book, all in one place."}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
name: "hexdebug.category.items.entry.debugging",
|
|
3
|
+
category: "hexcasting:items",
|
|
4
|
+
icon: "hexdebug:debugger",
|
|
5
|
+
advancement: "hexcasting:root",
|
|
6
|
+
pages: [
|
|
7
|
+
{
|
|
8
|
+
type: "patchouli:spotlight",
|
|
9
|
+
item: "hexdebug:debugger",
|
|
10
|
+
anchor: "debugger",
|
|
11
|
+
text: "hexdebug.category.items.entry.debugging.page.1",
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
name: "hexdebug.category.patterns.entry.debugging",
|
|
3
|
+
category: "hexcasting:patterns",
|
|
4
|
+
icon: "hexdebug:debugger",
|
|
5
|
+
advancement: "hexcasting:root",
|
|
6
|
+
pages: [
|
|
7
|
+
{
|
|
8
|
+
type: "hexcasting:pattern",
|
|
9
|
+
op_id: "hexdebug:const/debugging",
|
|
10
|
+
anchor: "hexdebug:const/debugging",
|
|
11
|
+
output: "bool",
|
|
12
|
+
text: "hexdebug.category.patterns.entry.debugging.page.const/debugging",
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
type: "hexcasting:pattern",
|
|
16
|
+
op_id: "hexdebug:breakpoint/before",
|
|
17
|
+
anchor: "hexdebug:breakpoint/before",
|
|
18
|
+
text: "hexdebug.category.patterns.entry.debugging.page.breakpoint/before",
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
type: "hexcasting:pattern",
|
|
22
|
+
op_id: "hexdebug:breakpoint/after",
|
|
23
|
+
anchor: "hexdebug:breakpoint/after",
|
|
24
|
+
text: "hexdebug.category.patterns.entry.debugging.page.breakpoint/after",
|
|
25
|
+
},
|
|
26
|
+
],
|
|
27
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"item.hexdebug.debugger": "Debugger", "text.hexdebug.no_client": "Waiting for debug client to connect...", "text.hexdebug.connected": "Debug client connected!", "text.autoconfig.hexdebug.title": "HexDebug Config", "text.autoconfig.hexdebug.category.client": "Client", "text.autoconfig.hexdebug.option.client.debugPort": "Debug Port", "hexcasting.action.hexdebug:const/debugging": "Debugger's Reflection", "hexcasting.action.hexdebug:breakpoint/before": "Set Breakpoint Before", "hexcasting.action.hexdebug:breakpoint/after": "Set Breakpoint After", "hexdebug.category.items.entry.debugging": "Debugging", "hexdebug.category.items.entry.debugging.page.1": "TODO: actually write this", "hexdebug.category.patterns.entry.debugging": "Debugging", "hexdebug.category.patterns.entry.debugging.page.const/debugging": "Adds $(thing)True/$ to the top of the stack if executed by a $(l:items/debugging#debugger)$(item)debugger/$, or $(thing)False/$ otherwise.", "hexdebug.category.patterns.entry.debugging.page.breakpoint/before": "Pauses the $(l:items/debugging#debugger)$(item)debugger/$ before executing this pattern.", "hexdebug.category.patterns.entry.debugging.page.breakpoint/after": "Pauses the $(l:items/debugging#debugger)$(item)debugger/$ after executing this pattern (ie. before executing the next pattern)."}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
{
|
|
2
|
+
"parent": "minecraft:item/generated",
|
|
3
|
+
"overrides": [
|
|
4
|
+
{
|
|
5
|
+
"model": "hexdebug:item/debugger/in/inactive",
|
|
6
|
+
"predicate": {
|
|
7
|
+
"hexdebug:step_mode": 0.0
|
|
8
|
+
}
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"model": "hexdebug:item/debugger/in/waiting_for_client",
|
|
12
|
+
"predicate": {
|
|
13
|
+
"hexdebug:state": 0.5,
|
|
14
|
+
"hexdebug:step_mode": 0.0
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"model": "hexdebug:item/debugger/in/active",
|
|
19
|
+
"predicate": {
|
|
20
|
+
"hexdebug:state": 1.0,
|
|
21
|
+
"hexdebug:step_mode": 0.0
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"model": "hexdebug:item/debugger/out/inactive",
|
|
26
|
+
"predicate": {
|
|
27
|
+
"hexdebug:step_mode": 0.33333334
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"model": "hexdebug:item/debugger/out/waiting_for_client",
|
|
32
|
+
"predicate": {
|
|
33
|
+
"hexdebug:state": 0.5,
|
|
34
|
+
"hexdebug:step_mode": 0.33333334
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"model": "hexdebug:item/debugger/out/active",
|
|
39
|
+
"predicate": {
|
|
40
|
+
"hexdebug:state": 1.0,
|
|
41
|
+
"hexdebug:step_mode": 0.33333334
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"model": "hexdebug:item/debugger/over/inactive",
|
|
46
|
+
"predicate": {
|
|
47
|
+
"hexdebug:step_mode": 0.6666667
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"model": "hexdebug:item/debugger/over/waiting_for_client",
|
|
52
|
+
"predicate": {
|
|
53
|
+
"hexdebug:state": 0.5,
|
|
54
|
+
"hexdebug:step_mode": 0.6666667
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"model": "hexdebug:item/debugger/over/active",
|
|
59
|
+
"predicate": {
|
|
60
|
+
"hexdebug:state": 1.0,
|
|
61
|
+
"hexdebug:step_mode": 0.6666667
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"model": "hexdebug:item/debugger/continue/inactive",
|
|
66
|
+
"predicate": {
|
|
67
|
+
"hexdebug:step_mode": 1.0
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"model": "hexdebug:item/debugger/continue/waiting_for_client",
|
|
72
|
+
"predicate": {
|
|
73
|
+
"hexdebug:state": 0.5,
|
|
74
|
+
"hexdebug:step_mode": 1.0
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"model": "hexdebug:item/debugger/continue/active",
|
|
79
|
+
"predicate": {
|
|
80
|
+
"hexdebug:state": 1.0,
|
|
81
|
+
"hexdebug:step_mode": 1.0
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
],
|
|
85
|
+
"textures": {
|
|
86
|
+
"layer0": "hexdebug:item/debugger"
|
|
87
|
+
}
|
|
88
|
+
}
|
|
Binary file
|
|
Binary file
|
hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/continue.png
ADDED
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"book_url":"https://hexdebug.hexxy.media/v/0.1.0/1.0.dev0/en_us","asset_url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af","textures":{"PNGTexture":{"hexdebug:textures/item/debugger.png":{"url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af/Common/src/main/resources/assets/hexdebug/textures/item/debugger.png","pixelated":true},"hexdebug:textures/item/debugger/step_mode/continue.png":{"url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af/Common/src/main/resources/assets/hexdebug/textures/item/debugger/step_mode/continue.png","pixelated":true},"hexdebug:textures/item/debugger/step_mode/over.png":{"url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af/Common/src/main/resources/assets/hexdebug/textures/item/debugger/step_mode/over.png","pixelated":true},"hexdebug:textures/item/debugger/step_mode/out.png":{"url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af/Common/src/main/resources/assets/hexdebug/textures/item/debugger/step_mode/out.png","pixelated":true},"hexdebug:textures/item/debugger/step_mode/in.png":{"url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af/Common/src/main/resources/assets/hexdebug/textures/item/debugger/step_mode/in.png","pixelated":true},"hexdebug:textures/item/debugger/state/active.png":{"url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af/Common/src/main/resources/assets/hexdebug/textures/item/debugger/state/active.png","pixelated":true},"hexdebug:textures/item/debugger/state/waiting_for_client.png":{"url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af/Common/src/main/resources/assets/hexdebug/textures/item/debugger/state/waiting_for_client.png","pixelated":true}},"SingleItemTexture":{"hexdebug:debugger":{"inner":{"url":"https://raw.githubusercontent.com/object-Object/HexDebug/3d5dcaeb73676436c29b7c8a917fa232b2f918af/Common/src/main/resources/assets/hexdebug/textures/item/debugger.png","pixelated":true}},"hexdebug:debugger/in/waiting_for_client":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}},"hexdebug:debugger/over/waiting_for_client":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}},"hexdebug:debugger/continue/inactive":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}},"hexdebug:debugger/continue/waiting_for_client":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}},"hexdebug:debugger/over/inactive":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}},"hexdebug:debugger/in/active":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}},"hexdebug:debugger/continue/active":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}},"hexdebug:debugger/in/inactive":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}},"hexdebug:debugger/over/active":{"inner":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAACXBIWXMAAC4jAAAuIwF4pT92AAAAJElEQVQoz2NkwAF+MPzAKs7EQCIY1UAMYMQV3hwMHKOhRD8NAPogBA/DVsDEAAAAAElFTkSuQmCC","pixelated":true}}}}}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"patterns":[{"startdir":"EAST","signature":"qqqqqewaa","id":"hexdebug:const/debugging"},{"startdir":"SOUTH_WEST","signature":"awqdeew","id":"hexdebug:breakpoint/before"},{"startdir":"EAST","signature":"wqqaewd","id":"hexdebug:breakpoint/after"}]}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
from importlib.resources import Package
|
|
2
|
+
from typing_extensions import override
|
|
3
|
+
|
|
4
|
+
from hexdoc.plugin import (
|
|
5
|
+
HookReturn,
|
|
6
|
+
ModPlugin,
|
|
7
|
+
ModPluginImpl,
|
|
8
|
+
ModPluginWithBook,
|
|
9
|
+
hookimpl,
|
|
10
|
+
)
|
|
11
|
+
|
|
12
|
+
import hexdoc_hexdebug
|
|
13
|
+
|
|
14
|
+
from .__gradle_version__ import FULL_VERSION, GRADLE_VERSION
|
|
15
|
+
from .__version__ import PY_VERSION
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class HexDebugPlugin(ModPluginImpl):
|
|
19
|
+
@staticmethod
|
|
20
|
+
@hookimpl
|
|
21
|
+
def hexdoc_mod_plugin(branch: str) -> ModPlugin:
|
|
22
|
+
return HexDebugModPlugin(branch=branch)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
class HexDebugModPlugin(ModPluginWithBook):
|
|
26
|
+
@property
|
|
27
|
+
@override
|
|
28
|
+
def modid(self) -> str:
|
|
29
|
+
return "hexdebug"
|
|
30
|
+
|
|
31
|
+
@property
|
|
32
|
+
@override
|
|
33
|
+
def full_version(self) -> str:
|
|
34
|
+
return FULL_VERSION
|
|
35
|
+
|
|
36
|
+
@property
|
|
37
|
+
@override
|
|
38
|
+
def mod_version(self) -> str:
|
|
39
|
+
return GRADLE_VERSION
|
|
40
|
+
|
|
41
|
+
@property
|
|
42
|
+
@override
|
|
43
|
+
def plugin_version(self) -> str:
|
|
44
|
+
return PY_VERSION
|
|
45
|
+
|
|
46
|
+
@override
|
|
47
|
+
def resource_dirs(self) -> HookReturn[Package]:
|
|
48
|
+
# lazy import because generated may not exist when this file is loaded
|
|
49
|
+
# eg. when generating the contents of generated
|
|
50
|
+
# so we only want to import it if we actually need it
|
|
51
|
+
from ._export import generated
|
|
52
|
+
|
|
53
|
+
return generated
|
|
54
|
+
|
|
55
|
+
@override
|
|
56
|
+
def jinja_template_root(self) -> tuple[Package, str]:
|
|
57
|
+
return hexdoc_hexdebug, "_templates"
|
|
File without changes
|
hexdoc_hexdebug/py.typed
ADDED
|
File without changes
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: hexdoc-hexdebug
|
|
3
|
+
Version: 0.1.0.1.0.dev0
|
|
4
|
+
Summary: Python web book docgen and hexdoc plugin for HexDebug.
|
|
5
|
+
Project-URL: Homepage, https://hexdebug.hexxy.media
|
|
6
|
+
Project-URL: Source, https://github.com/object-Object/HexDebug
|
|
7
|
+
Author: object-Object
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Keywords: hexdoc
|
|
10
|
+
Requires-Python: >=3.11
|
|
11
|
+
Requires-Dist: hexdoc-hexcasting~=0.11.1.1.0rc7
|
|
12
|
+
Requires-Dist: hexdoc>=1!0.1.0a13
|
|
13
|
+
Provides-Extra: dev
|
|
14
|
+
Requires-Dist: ruff~=0.3.7; extra == 'dev'
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
|
|
17
|
+
# hexdoc-hexdebug
|
|
18
|
+
|
|
19
|
+
Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for HexDebug.
|
|
20
|
+
|
|
21
|
+
## Version scheme
|
|
22
|
+
|
|
23
|
+
We use [hatch-gradle-version](https://pypi.org/project/hatch-gradle-version) to generate the version number based on whichever mod version the docgen was built with.
|
|
24
|
+
|
|
25
|
+
The version is in this format: `mod-version.python-version.mod-pre.python-dev.python-post`
|
|
26
|
+
|
|
27
|
+
For example:
|
|
28
|
+
* Mod version: `0.11.1-7`
|
|
29
|
+
* Python package version: `1.0.dev0`
|
|
30
|
+
* Full version: `0.11.1.1.0rc7.dev0`
|
|
31
|
+
|
|
32
|
+
## Setup
|
|
33
|
+
|
|
34
|
+
Install Python 3.11 and Node 18 (20+ is **not** currently supported).
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
python3.11 -m venv venv
|
|
38
|
+
|
|
39
|
+
.\venv\Scripts\activate # Windows
|
|
40
|
+
. venv/bin/activate.fish # fish
|
|
41
|
+
source venv/bin/activate # everything else
|
|
42
|
+
|
|
43
|
+
# run from the repo root, not doc/
|
|
44
|
+
pip install -e .[dev]
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Usage
|
|
48
|
+
|
|
49
|
+
For local testing, create a file called `.env` in the repo root following this template:
|
|
50
|
+
```sh
|
|
51
|
+
GITHUB_REPOSITORY=object-Object/HexDebug
|
|
52
|
+
GITHUB_SHA=main
|
|
53
|
+
GITHUB_PAGES_URL=https://hexdebug.hexxy.media
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Useful commands:
|
|
57
|
+
```sh
|
|
58
|
+
# show help
|
|
59
|
+
hexdoc -h
|
|
60
|
+
|
|
61
|
+
# render and serve the web book in watch mode
|
|
62
|
+
nodemon --config doc/nodemon.json
|
|
63
|
+
|
|
64
|
+
# render and serve the web book
|
|
65
|
+
hexdoc serve
|
|
66
|
+
|
|
67
|
+
# export, render, and merge the web book
|
|
68
|
+
hexdoc export
|
|
69
|
+
hexdoc render
|
|
70
|
+
hexdoc merge
|
|
71
|
+
|
|
72
|
+
# start the Python interpreter with some extra local variables
|
|
73
|
+
hexdoc repl
|
|
74
|
+
```
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
gradle.properties,sha256=nKAdevR9SzR8nECgvI9qnxOFKhgbUCd2Aqj1lxLJu4E,320
|
|
2
|
+
hexdoc_hexdebug/__gradle_version__.py,sha256=kpCfWyH57UX-fLg92ah-JVumvD2aGD1MgvqdDJSNjEo,393
|
|
3
|
+
hexdoc_hexdebug/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
|
+
hexdoc_hexdebug/__version__.py,sha256=wasuvG55ol3028QsM6sqkvlBdjNm_WHVJ54YL1qfPAU,150
|
|
5
|
+
hexdoc_hexdebug/_hooks.py,sha256=azuRlkUejIxg9wvtv4tC9iXtDkXaGnKQRAAbElbbABw,1347
|
|
6
|
+
hexdoc_hexdebug/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
7
|
+
hexdoc_hexdebug/_export/.gitignore,sha256=EkaFytoqJPxYwmrwU3sw39xW6zhTgR-l3uqf775JjlY,35
|
|
8
|
+
hexdoc_hexdebug/_export/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
9
|
+
hexdoc_hexdebug/_export/generated/__init__.py,sha256=eZ1gpxa9SvbEGk7WWduqO5_rDc6Re8VPZ_KIE0kdz9U,83
|
|
10
|
+
hexdoc_hexdebug/_export/generated/hexdebug.hexdoc.json,sha256=8_bOrtiIlGfLKWyvKhNNLFxUXUl9l3qb9LIOTVv6nlw,4518
|
|
11
|
+
hexdoc_hexdebug/_export/generated/hexdebug.patterns.hexdoc.json,sha256=eeT-bgpsnkvBI3ZejlnXCbgFToECb8ig7FVucM3pyrM,247
|
|
12
|
+
hexdoc_hexdebug/_export/generated/assets/hexcasting/lang/en_us.flatten.json5,sha256=8-D3kFkvL5RHiDiSA7en3Cudowq8haaipF1xBm-dTlA,113
|
|
13
|
+
hexdoc_hexdebug/_export/generated/assets/hexcasting/patchouli_books/thehexbook/en_us/entries/items/debugging.json5,sha256=m7_0kmsfoJLJhF3P_yTYsG9xDn4ellsSKi9KcOsyzgw,334
|
|
14
|
+
hexdoc_hexdebug/_export/generated/assets/hexcasting/patchouli_books/thehexbook/en_us/entries/patterns/debugging.json5,sha256=r4M1-UxprKt9wM1V0AicxVXNZz4EuMXZV3OjIISKXq8,830
|
|
15
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/lang/en_us.flatten.json5,sha256=VP00BeYPEtUZ0BX9IlA8bgkkMR5X5uZ7OFg4oCyvfvE,1312
|
|
16
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger.json,sha256=9i9sCsf6tyg_XsIIlgHJLq504hVoDHYBa5CH51o-etE,2017
|
|
17
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/continue/active.json,sha256=2On_Az1Vq9VvgZGWfS6n5V7wdHm_IUGuCnZt53dqE6A,172
|
|
18
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/continue/inactive.json,sha256=Nehu0STIbB5XFS3lBKG3XT5ETd4oGq0C5t_v7zd0n8Q,119
|
|
19
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/continue/waiting_for_client.json,sha256=DdvCTy2MJ48NlpCMwmHtz85jLAd7y1XiaCRrUv02Vzw,184
|
|
20
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/in/active.json,sha256=I7hX_AygXNzzikHMpQXjF-LJwZCqKa7iph6gZ5JWG8k,166
|
|
21
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/in/inactive.json,sha256=geBR45YWOB14lpX7TWfZuTzrkIWT6YejV3gfvpDPrPs,113
|
|
22
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/in/waiting_for_client.json,sha256=uwT2vplhmgvIMDIuM_zl1YeN--j-ZG22Ldm9uLFJigw,178
|
|
23
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/over/active.json,sha256=JJzewVjRU3ee8CyBcSi9_T8N-62Sk6wGKT8bgIxKL2o,168
|
|
24
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/over/inactive.json,sha256=RxcYbLzE7KpCBDr_UgIW52Sxn2MTKcsphU0iYpi40q4,115
|
|
25
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/models/item/debugger/over/waiting_for_client.json,sha256=mG0TKlL6HqTBjJpE7QcqMTDZRiMG2_jdlAcS1Moi_cU,180
|
|
26
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger.png,sha256=hsJE1HOxEqFJQno_qDvzhlEoyJQP2k65xW1H7lrsiFc,418
|
|
27
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/state/active.png,sha256=q31LgkS_io7st6bMUnv0lxa-jnR00bteG3DJiZMLv6A,4495
|
|
28
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/state/waiting_for_client.png,sha256=ozYnaJB3VXgBupuY9ib2uhhiztFoeXuSGyABQVc-z5Y,4489
|
|
29
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/continue.png,sha256=7AT1uIUUlHiLH8N6vN_G0CxgVmus3E-NzNWrPg-4-Rk,4234
|
|
30
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/in.png,sha256=8DzVbfl9Q99siwP20uJ1CErJhaxm6M27mn23gS2IGGU,4228
|
|
31
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/out.png,sha256=dixMU90OMbfAmbqkzB5jAiIadfnhu7isIdJAvEblb9I,4228
|
|
32
|
+
hexdoc_hexdebug/_export/generated/assets/hexdebug/textures/item/debugger/step_mode/over.png,sha256=dbvGItGqGf2SG_NJx2lNgmTco_fCkxKF-RjQK5YinzU,4230
|
|
33
|
+
hexdoc_hexdebug/_templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
34
|
+
hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/METADATA,sha256=C_D0KOgjhG3TTqUyLxmlKpWfSAVf0ymgzLiD8j-TPfc,1856
|
|
35
|
+
hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
|
|
36
|
+
hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/entry_points.txt,sha256=YVQVEDcs5YElo38rRQa82zVfrwEzAyW5UIxR30nDHis,58
|
|
37
|
+
hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/licenses/LICENSE,sha256=FmKi-jgvNFRJO3ipSxqbCNobs9gBaq0pPK7JR0F_reQ,1072
|
|
38
|
+
hexdoc_hexdebug-0.1.0.1.0.dev0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 [object Object]
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|